Go语言中基于运行时条件动态控制JSON字段序列化教程

package main

import (
    "encoding/json"
    "fmt"
)

// UserRole 定义用户角色
type UserRole string

const (
    RoleGuest UserRole = "guest"
    RoleAdmin UserRole = "admin"
)

// UserData 包含用户信息的结构体
type UserData struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
    // Role 字段只有在非零值时才会被序列化
    Role UserRole `json:"role,omitempty"`
}

// GetUserJSON 根据用户角色生成JSON响应
func GetUserJSON(data UserData, currentUserRole UserRole) ([]byte, error) {
    // 如果当前用户是访客，则清除Role字段，使其不被序列化
    if currentUserRole == RoleGuest {
        data.Role = "" // 将Role字段设置为零值
    }
    return json.MarshalIndent(data, "", "  ")
}

func main() {
    // 示例数据
    adminData := UserData{ID: 1, Name: "Admin John", Role: RoleAdmin}
    guestData := UserData{ID: 2, Name: "Guest Jane", Role: RoleGuest}

    // 为管理员用户生成JSON
    adminJSON, err := GetUserJSON(adminData, RoleAdmin)
    if err != nil {
        fmt.Println("Error marshaling admin data:", err)
        return
    }
    fmt.Println("Admin JSON Output:")
    fmt.Println(string(adminJSON))
    // 预期输出：包含 id, name, role

    fmt.Println("\n--------------------\n")

    // 为访客用户生成JSON
    guestJSON, err := GetUserJSON(guestData, RoleGuest)
    if err != nil {
        fmt.Println("Error marshaling guest data:", err)
        return
    }
    fmt.Println("Guest JSON Output:")
    fmt.Println(string(guestJSON))
    // 预期输出：只包含 id, name，role 字段被省略
}

package main

import (
    "encoding/json"
    "fmt"
    "reflect"
    "strings"
)

// UserRole 定义用户角色
type UserRole string

const (
    RoleGuest UserRole = "guest"
    RoleAdmin UserRole = "admin"
)

// UserData 包含用户信息的结构体
type UserData struct {
    // CurrentRole 字段用于内部判断，不会被序列化 (json:"-")
    CurrentRole UserRole `json:"-"`
    ID          int      `json:"id"`
    Name        string   `json:"name"`
    // Role 字段只有当 CurrentRole 是 RoleAdmin 时才会被序列化
    Role UserRole `json:"role,omitempty" role_tag:"admin"`
    // SecretInfo 字段只有当 CurrentRole 是 RoleAdmin 时才会被序列化
    SecretInfo string   `json:"secret_info,omitempty" role_tag:"admin"`
}

// MarshalJSON 实现了 encoding/json.Marshaler 接口
func (ud *UserData) MarshalJSON() ([]byte, error) {
    tempMap := make(map[string]interface{})
    v := reflect.ValueOf(*ud)
    t := v.Type()

    for i := 0; i < t.NumField(); i++ {
        field := t.Field(i)
        fieldValue := v.Field(i)

        // 忽略 CurrentRole 字段，因为它只用于内部逻辑
        if field.Name == "CurrentRole" {
            continue
        }

        // 获取 JSON 标签名
        jsonTag := field.Tag.Get("json")
        if jsonTag == "-" { // 如果 json 标签是 "-"，则跳过此字段
            continue
        }
        jsonFieldName := jsonTag
        if commaIdx := strings.Index(jsonTag, ","); commaIdx != -1 {
            jsonFieldName = jsonTag[:commaIdx]
        }
        if jsonFieldName == "" { // 如果没有 json 标签，默认使用字段名
            jsonFieldName = field.Name
        }

        // 检查自定义的 role_tag
        roleTag := field.Tag.Get("role_tag")
        if roleTag != "" {
            // 如果 role_tag 存在，检查当前用户角色是否匹配
            requiredRoles := strings.Split(roleTag, ",") // 支持一个字段对应多个角色
            roleMatch := false
            for _, r := range requiredRoles {
                if UserRole(r) == ud.CurrentRole {
                    roleMatch = true
                    break
                }
            }
            if !roleMatch {
                continue // 如果角色不匹配，跳过此字段
            }
        }

        // 处理 omitempty：如果字段有 omitempty 标签且值为零值，则跳过
        if strings.Contains(jsonTag, "omitempty") && reflect.DeepEqual(fieldValue.Interface(), reflect.Zero(field.Type).Interface()) {
            continue
        }

        // 将字段添加到临时 map 中
        tempMap[jsonFieldName] = fieldValue.Interface()
    }

    return json.MarshalIndent(tempMap, "", "  ")
}

func main() {
    // 示例数据
    adminUser := UserData{
        CurrentRole: RoleAdmin,
        ID:          1,
        Name:        "Admin John",
        Role:        RoleAdmin,
        SecretInfo:  "This is a secret for admins.",
    }
    guestUser := UserData{
        CurrentRole: RoleGuest,
        ID:          2,
        Name:        "Guest Jane",
        Role:        RoleGuest, // 即使有值，role_tag也会控制其是否显示
        SecretInfo:  "Guest secret info",
    }

    // 为管理员用户生成JSON
    adminJSON, err := json.Marshal(adminUser)
    if err != nil {
        fmt.Println("Error marshaling admin user:", err)
        return
    }
    fmt.Println("Admin JSON Output:")
    fmt.Println(string(adminJSON))
    // 预期输出：包含 id, name, role, secret_info

    fmt.Println("\n--------------------\n")

    // 为访客用户生成JSON
    guestJSON, err := json.Marshal(guestUser)
    if err != nil {
        fmt.Println("Error marshaling guest user:", err)
        return
    }
    fmt.Println("Guest JSON Output:")
    fmt.Println(string(guestJSON))
    // 预期输出：只包含 id, name，role 和 secret_info 字段被省略
}