禁用 Go HTTP 服务器响应的 Chunked 编码

本文档旨在指导开发者如何在 Go 语言的 net/http 包中禁用 HTTP 服务器响应的 Chunked 编码。net/http 默认采用 Chunked 编码以支持持久连接，但在某些特殊场景下，开发者可能需要禁用该特性。本文将深入分析 net/http 包的源码，揭示 Chunked 编码的启用机制，并提供一种通过显式设置 Content-Length 来避免 Chunked 编码的实用方法，从而满足开发者对于响应编码方式的特定需求。

在 Go 语言中使用 net/http 包构建 HTTP 服务器时，默认情况下，对于 HTTP/1.1 及以上版本的请求，服务器会采用 Chunked 编码来发送响应。Chunked 编码允许服务器在不知道响应内容总长度的情况下开始发送数据，这对于动态生成内容或流式传输非常有用。然而，在某些特定的应用场景中，开发者可能需要禁用 Chunked 编码，强制服务器使用 identity 传输编码（即不使用 Chunked 编码），例如为了兼容某些老旧的客户端或满足特定的协议要求。

net/http 包的 server.go 文件中，WriteHeader(code int) 函数负责设置响应头。该函数内部的逻辑决定了是否启用 Chunked 编码。以下是相关代码片段的简化版本：

func (w *response) WriteHeader(code int) {
if w.headerSent {
return
}
w.headerSent = true
if hasCL := len(w.header["Content-Length"]) > 0; hasCL {
w.contentLength = parseContentLength(w.header["Content-Length"][0])
w.header.Del("Transfer-Encoding")
} else if w.req.ProtoAtLeast(1, 1) {
// HTTP/1.1 or greater: use chunked transfer encoding
w.chunking = true
w.header.Set("Transfer-Encoding", "chunked")
}
// ... 实际写入 header 的逻辑
}

从上面的代码可以看出，如果响应头中已经设置了 Content-Length，那么 Transfer-Encoding 头部会被删除，从而禁用 Chunked 编码。否则，如果请求是 HTTP/1.1 或更高版本，Transfer-Encoding 会被设置为 chunked，启用 Chunked 编码。

禁用 Chunked 编码的方法

要禁用 Chunked 编码，最直接的方法是在发送响应之前显式设置 Content-Length 头部。这样，net/http 包就会认为已经知道响应内容的长度，从而不会启用 Chunked 编码。

以下是一个示例代码：

package main
import (
"fmt"
"net/http"
)
func handler(w http.ResponseWriter, r *http.Request) {
body := "Hello, world!"
w.Header().Set("Content-Length", fmt.Sprintf("%d", len(body)))
w.WriteHeader(http.StatusOK)
fmt.Fprint(w, body)
}
func main() {
http.HandleFunc("/", handler)
fmt.Println("Server listening on port 8080")
http.ListenAndServe(":8080", nil)
}

在这个例子中，handler 函数首先计算响应内容的长度，然后使用 w.Header().Set(“Content-Length”, …) 设置 Content-Length 头部。之后，调用 w.WriteHeader(http.StatusOK) 发送响应头，最后使用 fmt.Fprint(w, body) 发送响应内容。由于 Content-Length 头部已经设置，服务器不会使用 Chunked 编码。

注意事项

• 必须在调用 w.WriteHeader() 之前设置 Content-Length 头部。如果在 WriteHeader 之后设置，将不会生效。
• 设置的 Content-Length 必须与实际发送的响应内容的长度一致。如果长度不一致，可能会导致客户端出现错误。
• 对于动态生成内容或流式传输，如果无法提前知道内容的长度，则无法禁用 Chunked 编码。

总结

通过显式设置 Content-Length 头部，可以有效地禁用 Go HTTP 服务器响应的 Chunked 编码。开发者应根据实际需求选择合适的编码方式，并注意确保 Content-Length 的准确性，以避免潜在的问题。虽然 net/http 包本身没有提供直接禁用 Chunked 编码的选项，但通过这种方式可以满足大部分禁用 Chunked 编码的需求。