配置说明
Hertz 配置说明。
Server
Server 侧的配置项均在初始化 Server 时采用 server.xxx 的方式，如
package main
import "github.com/cloudwego/hertz/pkg/app/server"
func main() {
h := server.New(server.WithXXXX())
...
}
| 配置名称 | 类型 | 说明 |
|---|---|---|
| WithTransport | network.NewTransporter | 更换底层 transport。默认值受平台与环境变量影响：在 linux/darwin && amd64/arm64 平台且未设置 HERTZ_NO_NETPOLL=true 时默认为 netpoll；TLS 场景会回退至 standard；其他情况为 standard。 |
| WithHostPorts | string | 指定监听的地址和端口。默认值：:8888 |
| WithKeepAliveTimeout | time.Duration | tcp 长连接保活时间，一般情况下不用修改，更应该关注 idleTimeout。默认值：1min |
| WithReadTimeout | time.Duration | 底层读取数据超时时间。默认值：3min |
| WithIdleTimeout | time.Duration | 长连接请求链接空闲超时时间。默认值：3min |
| WithMaxRequestBodySize | int | 配置最大的请求体大小，默认 4M（4M 对应的填的值是 4*1024*1024） |
| WithRedirectTrailingSlash | bool | 自动根据末尾的 / 转发，例如：如果 router 只有 /foo/，那么 /foo 会重定向到 /foo/ ；如果只有 /foo，那么 /foo/ 会重定向到 /foo。默认开启 |
| WithRemoveExtraSlash | bool | RemoveExtraSlash 当有额外的 / 时也可以当作参数。如：user/:name，如果开启该选项 user//xiaoming 也可匹配上参数。默认关闭 |
| WithUnescapePathValues | bool | 如果开启，请求路径会被自动转义（eg. ‘%2F’ -> ‘/’）。如果 UseRawPath 为 false（默认情况），则 UnescapePathValues 实际上为 true，因为 .URI().Path() 将被使用，它已经是转义后的。设置该参数为 false，需要配合 WithUseRawPath(true)。默认开启 (true) |
| WithUseRawPath | bool | 如果开启，会使用原始 path 进行路由匹配。默认关闭 |
| WithHandleMethodNotAllowed | bool | 如果开启，当当前路径不能被匹配上时，server 会去检查其他方法是否注册了当前路径的路由，如果存在则会响应"Method Not Allowed"，并返回状态码 405; 如果没有，则会用 NotFound 的 handler 进行处理。默认关闭 |
| WithDisablePreParseMultipartForm | bool | 如果开启，则不会预处理 multipart form。可以通过 ctx.Request.Body() 获取到 body 后由用户处理。默认关闭 |
| WithStreamBody | bool | 如果开启，则会使用流式处理 body。默认关闭 |
| WithNetwork | string | 设置网络协议，可选：tcp，udp，unix（unix domain socket），默认为 tcp |
| ContinueHandler | func(header *RequestHeader) bool | 在接收到 Expect 100 Continue 头之后调用 ContinueHandler。使用 ContinueHandler，服务器可以决定是否根据标头读取可能很大的请求正文 |
| PanicHandler | HandlerFunc | 处理 panic，用来生成错误页面并返回 500 |
| NotFound | HandlerFunc | 当路由匹配不上时被调用的 handler |
| WithExitWaitTime | time.Duration | 设置优雅退出时间。Server 会停止建立新的连接，并对关闭后的每一个请求设置 Connection: Close 的 header，当到达设定的时间关闭 Server。当所有连接已经关闭时，Server 可以提前关闭。默认 5s |
| WithTLS | tls.Config | 配置 server tls 能力 |
| WithListenConfig | net.ListenConfig | 设置监听器配置，可用于设置是否允许 reuse port 等 |
| WithALPN | bool | 是否开启 ALPN。默认关闭 |
| WithTracer | tracer.Tracer | 注入 tracer 实现，如不注入 Tracer 实现，默认关闭 |
| WithTraceLevel | stats.Level | 设置 trace level，默认 LevelDetailed |
| WithWriteTimeout | time.Duration | 写入数据超时时间，默认 0（不限制）。仅当值 >0 时才会在 netpoll transport 中启用超时机制 |
| WithRedirectFixedPath | bool | 如果开启，当当前请求路径不能匹配上时，server 会尝试修复请求路径并重新进行匹配，如果成功匹配并且为 GET 请求则会返回状态码 301 进行重定向，其他请求方式返回 308 进行重定向。默认关闭 |
| WithBasePath | string | 设置基本路径，前缀和后缀必须为 /。默认为 / |
| WithMaxKeepBodySize | int | 设置回收时保留的请求体和响应体的最大大小。单位：字节。默认值：4 * 1024 * 1024 (4MB) |
| WithGetOnly | bool | 如果开启则只接受 GET 请求。默认关闭 |
| WithKeepAlive | bool | 如果开启则使用 HTTP 长连接。默认开启 |
| WithAltTransport | network.NewTransporter | 设置备用 transport。默认值：nil。该配置仅作为扩展点，如需使用请显式设置。 |
| WithH2C | bool | 设置是否开启 H2C。默认关闭 |
| WithReadBufferSize | int | 设置读缓冲区大小。默认值：4 * 1024 |
| WithMaxHeaderBytes | int | 设置 HTTP 请求 header 的最大字节数，默认 1MB（1 « 20），超限返回 431 Request Header Fields Too Large |
| WithRegistry | registry.Registry, *registry.Info | 设置注册中心配置，服务注册信息。默认值：registry.NoopRegistry, nil |
| WithAutoReloadRender | bool, time.Duration | 设置自动重载渲染配置。默认值：false, 0 |
| WithDisablePrintRoute | bool | 设置是否禁用 debugPrintRoute。默认不禁用 |
| WithOnAccept | func(conn net.Conn) context.Context | 设置在 netpoll 中当一个连接被接受但不能接收数据时的回调函数，在 go net 中在转换 TLS 连接之前被调用。默认值：nil |
| WithOnConnect | func(ctx context.Context, conn network.Conn) context.Context | 设置 onConnect 函数。它可以接收来自 netpoll 连接的数据。在 go net 中，它将在转换 TLS 连接后被调用。默认值：nil |
| WithDisableHeaderNamesNormalizing | bool | 设置是否禁用 Request 和 Response Header 名字的规范化 (首字母和破折号后第一个字母大写) |
Client
Client 侧的配置项均在初始化 Client 时采用 client.xxx 的方式
package main
import "github.com/cloudwego/hertz/pkg/app/client"
func main() {
c, err := client.NewClient(client.WithXxx())
...
}
| 配置名称 | 类型 | 说明 |
|---|---|---|
| WithDialTimeout | time.Duration | 连接建立超时时间，默认 1s |
| WithMaxConnsPerHost | int | 设置为每个 host 建立的最大连接数，默认 0（<=0 表示不限制）。 |
| WithMaxIdleConnDuration | time.Duration | 设置空闲连接超时时间，当超时后会关闭该连接，默认 10s |
| WithMaxConnDuration | time.Duration | 设置连接存活的最大时长，超过这个时间的连接在完成当前请求后会被关闭，默认 0（不限制） |
| WithMaxConnWaitTimeout | time.Duration | 设置等待空闲连接的最大时间，默认不等待 |
| WithKeepAlive | bool | 是否使用长连接，默认开启 |
| WithRetryConfig | …retry.Option | 设置 client 的 retry config。Hertz 版本需 >= v0.4.0。默认不启用 retry；调用 WithRetryConfig() 后默认 MaxAttemptTimes=1（即不重试），如需重试请显式设置，如：client.WithRetryConfig(retry.WithMaxAttemptTimes(3)) |
| int | 设置最大调用次数，调用失败则会重试。默认 1 次即不重试。v0.4.0 版本废止，该版本之前可用，建议升级 Hertz 版本 >= v0.4.0 并使用 WithRetryConfig 替代 | |
| WithClientReadTimeout | time.Duration | 设置读取 response 的最长时间，默认 0（不限制）。生产环境建议显式设置合理的超时时间 |
| WithTLSConfig | *tls.Config | 双向 TLS 认证时，设置 client 的 TLS config |
| WithDialer | network.Dialer | 设置 client 使用的网络库。默认值受平台与环境变量影响：在 linux/darwin && amd64/arm64 平台且未设置 HERTZ_NO_NETPOLL=true 时默认为 netpoll；TLS 场景会回退至 standard；其他情况为 standard。 |
| WithResponseBodyStream | bool | 设置是否使用流式处理，默认关闭 |
| WithDialFunc | client.DialFunc | 设置 Dial Function |
| WithWriteTimeout | time.Duration | 写入数据超时时间，默认 0（不限制）。 |
| WithHostClientConfigHook | func(hc interface{}) error | 设置 hook 函数来重新配置 host client，传入的 func 需要将参数 hc 断言为需要的结构体，比如 http1.HostClient，再进行具体处理 |