Golang终端HTTP请求美化调试插件库httpretty使用指南

httpretty是一个用于美化和调试HTTP请求的Golang库，它可以帮助开发者在终端中更直观地查看HTTP请求和响应的详细信息。

安装httpretty

go get github.com/henvic/httpretty

基本使用方法

1. 简单示例

package main

import (
	"fmt"
	"log"
	"net/http"
	
	"github.com/henvic/httpretty"
)

func main() {
	// 创建httpretty logger
	logger := &httpretty.Logger{
		Time:           true,
		RequestHeader:  true,
		RequestBody:    true,
		ResponseHeader: true,
		ResponseBody:   true,
		Colors:         true, // 启用颜色
		Formatters:     []httpretty.Formatter{&httpretty.JSONFormatter{}},
	}

	// 创建HTTP客户端并设置logger
	client := &http.Client{
		Transport: logger.RoundTripper(http.DefaultTransport),
	}

	// 发送请求
	resp, err := client.Get("https://jsonplaceholder.typicode.com/posts/1")
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()

	fmt.Println("Status:", resp.Status)
}

2. 自定义配置

logger := &httpretty.Logger{
	// 显示时间戳
	Time: true,
	// 显示请求头
	RequestHeader: true,
	// 显示请求体
	RequestBody: true,
	// 显示响应头
	ResponseHeader: true,
	// 显示响应体
	ResponseBody: true,
	// 启用颜色输出
	Colors: true,
	// 最大显示内容长度(字节)
	MaxResponseBody: 1000,
	// 格式化JSON响应
	Formatters: []httpretty.Formatter{&httpretty.JSONFormatter{}},
	// 跳过SSL验证(仅用于调试)
	SkipSanitize: true,
}

3. 过滤敏感信息

logger := &httpretty.Logger{
	RequestHeader:  true,
	RequestBody:    true,
	ResponseHeader: true,
	ResponseBody:   true,
	Colors:        true,
	// 添加过滤器来隐藏敏感信息
	Filters: []httpretty.Filter{
		// 隐藏Authorization头
		httpretty.HideHeader("Authorization"),
		// 自定义过滤器函数
		func(content []byte) []byte {
			// 替换密码字段
			return bytes.Replace(content, []byte(`"password":`), []byte(`"password":"***"`), -1)
		},
	},
}

4. 仅记录特定请求

logger := &httpretty.Logger{
	// 设置条件函数，只记录特定URL的请求
	Cond: func(req *http.Request) bool {
		return strings.Contains(req.URL.Host, "api.example.com")
	},
	RequestHeader:  true,
	RequestBody:    true,
	ResponseHeader: true,
	ResponseBody:   true,
}

高级用法

1. 与标准库集成

// 包装现有的Transport
transport := &http.Transport{
	// 你的Transport配置
}
logger := &httpretty.Logger{
	RequestHeader: true,
	ResponseHeader: true,
}
client := &http.Client{
	Transport: logger.RoundTripper(transport),
}

// 使用client发送请求

2. 自定义输出目标

// 创建自定义输出writer
var buf bytes.Buffer

logger := &httpretty.Logger{
	RequestHeader: true,
	ResponseHeader: true,
	// 设置自定义输出
	Writer: &buf,
}

// 使用后可以获取输出内容
output := buf.String()
fmt.Println(output)

3. 性能考虑

在生产环境中，建议禁用RequestBody和ResponseBody以减少性能开销：

logger := &httpretty.Logger{
	RequestHeader:  true,
	RequestBody:    false, // 生产环境禁用
	ResponseHeader: true,
	ResponseBody:   false, // 生产环境禁用
}

实际应用场景

1. 调试REST API客户端

func createAPIClient() *http.Client {
	logger := &httpretty.Logger{
		Time:           true,
		RequestHeader:  true,
		RequestBody:    true,
		ResponseHeader: true,
		ResponseBody:   true,
		Colors:         true,
		Formatters:     []httpretty.Formatter{&httpretty.JSONFormatter{}},
	}
	
	return &http.Client{
		Transport: logger.RoundTripper(http.DefaultTransport),
		Timeout:   30 * time.Second,
	}
}

2. 单元测试中的HTTP请求记录

func TestAPIRequest(t *testing.T) {
	var buf bytes.Buffer
	
	logger := &httpretty.Logger{
		RequestHeader:  true,
		ResponseHeader: true,
		Writer:         &buf,
	}
	
	client := &http.Client{
		Transport: logger.RoundTripper(http.DefaultTransport),
	}
	
	// 执行测试请求
	resp, err := client.Get("http://example.com/api")
	
	// 断言和验证
	t.Logf("Request log:\n%s", buf.String())
}

总结

httpretty是一个功能强大且灵活的HTTP请求调试工具，特别适合：

1. 开发阶段调试API调用
2. 记录HTTP交互用于文档或测试
3. 分析第三方服务的请求/响应模式
4. 教学和演示HTTP协议交互

通过合理配置，可以在开发环境中获得详细的HTTP交互信息，而在生产环境中保持简洁和高效。