API调用结构体类型优化：替代双Params结构体的方案探讨

我正在对接一个类Feed的API，发送POST请求时有特殊规则：

• 初始请求必须携带timestamp字段，绝对不能包含Id参数
• 后续请求必须仅携带从初始响应获取的Id字段，绝对不能包含timestamp

目前我用两个不同的Params结构体分别适配两种请求，但想找更简洁的方案——用单结构体时，空字段会被序列化为零值发送，完全不符合API要求。

现有实现代码示例 #

初始请求的结构体定义：

type Query struct {
    ApiKey string `json:"apiKey"`
    Params Params `json:"params"`
}

type Params struct {
    Timestamp string `json:"timestamp"` // 初始请求必填
}

后续请求的结构体定义：

type Query struct {
    ApiKey string `json:"apiKey"`
    Params Params `json:"params"`
}

type Params struct {
    Id string `json:"id"` // 用初始响应数据填充
}

尝试的单结构体实现（存在空字段序列化问题）：

package main

import (
    "encoding/json"
    "net/http"
    "time"
    "bytes"
)

type Query struct {
    ApiKey string
    Params Params `json:"params"`
}

type Params struct {
    Timestamp string // 初始请求需要
    Id        string // 用初始响应数据填充
}

func main() {
    client := &http.Client{
        Timeout: time.Second * 30,
    }

    // 构造初始请求
    qry := Query{
        ApiKey: a,
        Params: Params{
            Timestamp: ts,
        },
    }
    data, _ := json.Marshal(qry)
    req, _ := http.NewRequest(http.MethodPost, url, bytes.NewBuffer(data))
    resp, _ := client.Do(req)

    // 构造后续请求
    qry = Query{
        ApiKey: a,
        Params: Params{
            Id: id,
        },
    }
    data, _ := json.Marshal(qry)
    req, _ := http.NewRequest(http.MethodPost, url, bytes.NewBuffer(data))
    resp, _ := client.Do(req)
}

三种优化方案 #

方案1：使用指针类型+omitempty标签

把Params的字段改成指针，结合omitempty标签，未赋值的指针会被序列化为null并自动忽略：

type Params struct {
    Timestamp *string `json:"timestamp,omitempty"`
    Id        *string `json:"id,omitempty"`
}

使用示例：

// 初始请求
tsStr := "2024-05-20T12:00:00Z"
qry := Query{
    ApiKey: "your-api-key",
    Params: Params{
        Timestamp: &tsStr,
    },
}

// 后续请求
idStr := "from-initial-response"
qry = Query{
    ApiKey: "your-api-key",
    Params: Params{
        Id: &idStr,
    },
}

序列化后初始请求仅含timestamp，后续请求仅含id，完全符合API要求。

方案2：自定义JSON序列化逻辑

实现json.Marshaler接口，手动控制序列化时包含的字段：

type Params struct {
    Timestamp string
    Id        string
}

func (p Params) MarshalJSON() ([]byte, error) {
    data := make(map[string]string)
    if p.Timestamp != "" {
        data["timestamp"] = p.Timestamp
    }
    if p.Id != "" {
        data["id"] = p.Id
    }
    return json.Marshal(data)
}

这种方式无需修改字段类型，通过逻辑判断确保只有非空字段被序列化。

方案3：用匿名结构体临时构造请求体

如果请求结构体无需复用，直接用匿名结构体构造请求体，代码更直观：

// 初始请求
initialReq := struct {
    ApiKey string `json:"apiKey"`
    Params struct {
        Timestamp string `json:"timestamp"`
    } `json:"params"`
}{
    ApiKey: "your-api-key",
    Params: struct{ Timestamp string `json:"timestamp"` }{Timestamp: ts},
}
data, _ := json.Marshal(initialReq)

// 后续请求
nextReq := struct {
    ApiKey string `json:"apiKey"`
    Params struct {
        Id string `json:"id"`
    } `json:"params"`
}{
    ApiKey: "your-api-key",
    Params: struct{ Id string `json:"id"` }{Id: id},
}
data, _ := json.Marshal(nextReq)

内容的提问来源于stack exchange，提问作者Coldchain9