imicola ID 问题
ID 问题

ID 问题

776 字 · 约 2 分钟

r.PathValue() 返回字符串。如果资源 ID 使用整数表示,就需要进行转换,并将转换失败视为客户端请求错误:

id, err := strconv.Atoi(r.PathValue("id"))
if err != nil {
	http.Error(w, "invalid id", http.StatusBadRequest)
	return
}
go

PathValue 读取的是 ServeMux 已匹配路径通配符的值。例如路由 pattern 为 "GET /targets/{id}" 时,请求 /targets/12 得到的 id 是字符串 "12"。如果请求没有经过包含该通配符的路由匹配,结果会是空字符串。

生成 ID 时不能简单使用 len(targets) + 1,因为删除中间元素后,新 ID 可能与仍然存在的 ID 冲突。当前练习可以维护独立的递增计数器;并发处理请求时,计数器和 map 必须放在同一套同步策略下保护。

如何返回 JSON

可以使用标准库中的 json.NewEncoder(w).Encode(value) 构造 JSON 响应,并通过结构体标签控制字段名称:

type Target struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
	Addr string `json:"address"`
}
go

写入正文前需要设置响应头和状态码:

w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
if err := json.NewEncoder(w).Encode(value); err != nil {
	// 记录错误;响应提交后不能再修改状态码。
}
go

第一次调用 WriteHeader,或者第一次写入响应体时,HTTP 状态码就会提交。状态码提交后再调用 http.Error,不能把已经发送的 200 改成 500。如果必须保证“编码失败时返回 500”,可以先用 json.Marshal 在内存中完成编码,成功后再写响应头和正文。

当需要返回多个资源时,可以先构造切片,再编码成 JSON 数组:

list := make([]Target, 0, len(targets))
for _, target := range targets {
	list = append(list, target)
}

if err := json.NewEncoder(w).Encode(list); err != nil {
	// 记录错误
}
go

如何解析 JSON

请求体可以通过 Decoder 解析到结构体中:

var req TargetRequest

if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
	http.Error(w, "invalid json", http.StatusBadRequest)
	return
}
go

这里需要传入 &req,因为 Decoder 必须修改调用方持有的变量,才能把解析结果写入结构体字段。解析和校验通过后,再构造资源并写入服务器的存储:

target := Target{
	ID:   nextID,
	Name: req.Name,
	Addr: req.Addr,
}

targets[nextID] = target
go

拒绝未知字段与业务校验

如果希望拒绝目标结构体中不存在的 JSON 字段,可以使用:

var req TargetRequest
decoder := json.NewDecoder(r.Body)
decoder.DisallowUnknownFields()

if err := decoder.Decode(&req); err != nil {
	http.Error(w, "invalid json", http.StatusBadRequest)
	return
}
go

DisallowUnknownFields 只负责拒绝未知字段,不会判断缺失字段、空字符串或地址是否合法;这些业务规则仍需单独校验。Decode 本身会报告 JSON 语法错误和类型不匹配。

if req.Name == "" || req.Addr == "" {
	http.Error(w, "name and address are required", http.StatusBadRequest)
	return
}
go

只调用一次 Decode 还可能接受正文末尾的第二个 JSON 值。需要严格限制请求正文时,可以在第一次解析成功后再次解析并确认得到 io.EOF,同时根据服务边界考虑限制请求体大小。

map 中的结构体是值副本

当 targets 的类型是 map[int]Target 时,下面读取出的 target 是结构体副本:

target, ok := targets[id]
go

修改副本后必须显式写回:

target.Name = req.Name
target.Addr = req.Addr
targets[id] = target
go

否则 PUT 响应可能返回新值,但后续 GET 仍然读到旧值。

Handler 中不要调用 log.Fatal

非法 ID、非法 JSON 和资源不存在都只是一次请求的失败,不应终止整个服务器。log.Fatal 记录日志后会调用 os.Exit(1),因此 Handler 应返回合适的 4xx;服务器内部错误一般记录日志并返回 500。