go-httpheader 库使用指南

go-httpheader 是一个用于将 Go 结构体编码为 HTTP Header 的库，它提供了一种简单的方式来将结构体字段映射到 HTTP 头部字段。

基本用法

首先安装库：

go get github.com/denisbrodbeck/go-httpheader

简单示例

package main

import (
	"fmt"
	"net/http"
	
	"github.com/denisbrodbeck/go-httpheader"
)

type Headers struct {
	ContentType   string `header:"Content-Type"`
	Authorization string
	CustomHeader  string `header:"X-Custom-Header"`
}

func main() {
	h := Headers{
		ContentType:   "application/json",
		Authorization: "Bearer abc123",
		CustomHeader:  "custom-value",
	}

	header := http.Header{}
	err := httpheader.Encode(&h, &header)
	if err != nil {
		panic(err)
	}

	fmt.Println("Content-Type:", header.Get("Content-Type"))
	fmt.Println("Authorization:", header.Get("Authorization"))
	fmt.Println("X-Custom-Header:", header.Get("X-Custom-Header"))
}

特性说明

1. 自动命名转换：未指定 header tag 的字段会自动转换为连字符格式（如 UserAgent → User-Agent）
2. 支持多种类型：字符串、切片、指针、嵌套结构体等
3. 忽略字段：使用 header:"-" 忽略字段

嵌套结构体示例

type Auth struct {
	Token string `header:"Authorization"`
}

type RequestHeaders struct {
	ContentType string `header:"Content-Type"`
	Auth                 // 嵌套结构体
	CacheControl string
}

func main() {
	h := RequestHeaders{
		ContentType: "text/html",
		Auth: Auth{
			Token: "Bearer xyz789",
		},
		CacheControl: "no-cache",
	}

	header := http.Header{}
	err := httpheader.Encode(&h, &header)
	if err != nil {
		panic(err)
	}

	fmt.Println("Content-Type:", header.Get("Content-Type"))
	fmt.Println("Authorization:", header.Get("Authorization"))
	fmt.Println("Cache-Control:", header.Get("Cache-Control"))
}

切片和指针示例

type Headers struct {
	Accept      []string
	XForwarded  *string  `header:"X-Forwarded-For"`
	IgnoreField string   `header:"-"`
}

func main() {
	forwarded := "192.168.1.1"
	h := Headers{
		Accept:     []string{"text/html", "application/xml"},
		XForwarded: &forwarded,
	}

	header := http.Header{}
	err := httpheader.Encode(&h, &header)
	if err != nil {
		panic(err)
	}

	fmt.Println("Accept:", header["Accept"])
	fmt.Println("X-Forwarded-For:", header.Get("X-Forwarded-For"))
}

实际应用场景

创建 HTTP 请求

func createRequest() (*http.Request, error) {
	type RequestHeaders struct {
		UserAgent    string `header:"User-Agent"`
		ContentType  string `header:"Content-Type"`
		Accept       []string
	}

	headers := RequestHeaders{
		UserAgent:   "MyApp/1.0",
		ContentType: "application/json",
		Accept:      []string{"application/json", "text/xml"},
	}

	req, err := http.NewRequest("GET", "https://api.example.com", nil)
	if err != nil {
		return nil, err
	}

	if err := httpheader.Encode(&headers, &req.Header); err != nil {
		return nil, err
	}

	return req, nil
}

注意事项

1. 结构体字段必须是可导出的（首字母大写）
2. 默认情况下字段名会转换为连字符格式，除非指定了 header tag
3. 支持的类型包括：string、[]string、bool、int、float 等基本类型及其指针
4. 嵌套结构体会被展开，字段名会合并

go-httpheader 提供了一种声明式的方式来处理 HTTP 头部，使代码更加清晰和易于维护。