Go语言中结构体字段的字符串格式化与序列化技巧

type Item struct {
    Limit  int
    Skip   int
    Fields string
}

item := Item{
    Limit:  3,
    Skip:   5,
    Fields: "Value",
}

package main

import (
    "fmt"
    "reflect"
    "strings"
)

// StructToQueryString 将任意结构体转换为URL查询参数风格的字符串
// 例如：Item{Limit: 3, Skip: 5} -> "Limit=3&Skip=5"
func StructToQueryString(data interface{}) (string, error) {
    // 获取data的反射值和类型
    val := reflect.ValueOf(data)
    typ := reflect.TypeOf(data)

    // 确保传入的是结构体类型
    if val.Kind() == reflect.Ptr {
        val = val.Elem() // 如果是指针，获取其指向的元素
        typ = typ.Elem()
    }
    if val.Kind() != reflect.Struct {
        return "", fmt.Errorf("input must be a struct or a pointer to a struct, got %s", val.Kind())
    }

    var parts []string
    // 遍历结构体的所有字段
    for i := 0; i < val.NumField(); i++ {
        field := typ.Field(i)      // 获取字段的Type信息 (包含名称)
        fieldValue := val.Field(i) // 获取字段的Value信息 (包含值)

        // 检查字段是否可导出 (首字母大写)
        if !field.IsExported() {
            continue // 跳过不可导出字段
        }

        // 获取字段名
        fieldName := field.Name
        // 获取字段值并使用 %v 格式化
        fieldValueStr := fmt.Sprintf("%v", fieldValue.Interface())

        // 将键值对添加到parts切片中
        parts = append(parts, fmt.Sprintf("%s=%s", fieldName, fieldValueStr))
    }

    // 使用 & 连接所有键值对
    return strings.Join(parts, "&"), nil
}

func main() {
    item := Item{
        Limit:  3,
        Skip:   5,
        Fields: "Value",
    }

    queryString, err := StructToQueryString(item)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Formatted string:", queryString) // Output: Formatted string: Limit=3&Skip=5&Fields=Value

    // 尝试一个包含指针和自定义String()方法的结构体
    type User struct {
        ID   int
        Name string
        Age  *int // 指针字段
    }

    ageVal := 30
    user := User{
        ID:   1,
        Name: "Alice",
        Age:  &ageVal,
    }

    userQueryString, err := StructToQueryString(user)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Formatted user string:", userQueryString) // Output: Formatted user string: ID=1&Name=Alice&Age=30

    // 尝试一个自定义String()方法的类型
    type MyInt int
    func (m MyInt) String() string {
        return fmt.Sprintf("CustomInt(%d)", m)
    }

    type Config struct {
        Version MyInt
        Active bool
    }
    cfg := Config{
        Version: 101,
        Active: true,
    }
    cfgQueryString, err := StructToQueryString(cfg)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Formatted config string:", cfgQueryString) // Output: Formatted config string: Version=CustomInt(101)&Active=true
}