docs(proxy): 为反向代理模块添加标准化 godoc 注释

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
xfy 2026-04-20 11:23:03 +08:00
parent 10f3da0954
commit 42a4c8d311
4 changed files with 26 additions and 21 deletions

View File

@ -7,6 +7,7 @@
// - X-Forwarded-Proto: 原始请求协议http/https // - X-Forwarded-Proto: 原始请求协议http/https
// //
// 主要用途: // 主要用途:
//
// 用于在代理转发时保留客户端原始请求信息,使后端服务能够获取 // 用于在代理转发时保留客户端原始请求信息,使后端服务能够获取
// 客户端的真实 IP、Host 和协议。 // 客户端的真实 IP、Host 和协议。
// //

View File

@ -17,6 +17,7 @@
// - 临时文件:大响应自动写入临时文件,避免内存溢出 // - 临时文件:大响应自动写入临时文件,避免内存溢出
// //
// 主要用途: // 主要用途:
//
// 用于将客户端 HTTP 请求代理转发到后端服务器集群,实现负载均衡、缓存加速、 // 用于将客户端 HTTP 请求代理转发到后端服务器集群,实现负载均衡、缓存加速、
// 协议转换等功能,适用于 API 网关、反向代理服务器等场景。 // 协议转换等功能,适用于 API 网关、反向代理服务器等场景。
// //

View File

@ -11,6 +11,7 @@
// - 跳过证书验证:仅测试环境使用 // - 跳过证书验证:仅测试环境使用
// //
// 主要用途: // 主要用途:
//
// 用于代理与上游服务器之间的 TLS 连接配置,支持自签名证书、 // 用于代理与上游服务器之间的 TLS 连接配置,支持自签名证书、
// 内部 CA 签发证书以及双向认证场景。 // 内部 CA 签发证书以及双向认证场景。
// //

View File

@ -12,6 +12,7 @@
// - 变量展开:自定义规则中支持 Lolly 变量 // - 变量展开:自定义规则中支持 Lolly 变量
// //
// 主要用途: // 主要用途:
//
// 用于处理上游服务器返回的 3xx 重定向响应,确保客户端 // 用于处理上游服务器返回的 3xx 重定向响应,确保客户端
// 收到的是代理地址而非内部上游地址。 // 收到的是代理地址而非内部上游地址。
// //
@ -271,6 +272,7 @@ func (r *RedirectRewriter) rewriteDefault(headerValue string, ctx *fasthttp.Requ
// 规则按定义顺序匹配,第一个成功的规则生效: // 规则按定义顺序匹配,第一个成功的规则生效:
// - 正则匹配(~ 或 ~* 前缀):支持大小写不敏感 // - 正则匹配(~ 或 ~* 前缀):支持大小写不敏感
// - 前缀匹配(无特殊前缀):使用 HasPrefix 精确前缀匹配 // - 前缀匹配(无特殊前缀):使用 HasPrefix 精确前缀匹配
//
// 替换模板支持 Lolly 变量展开。 // 替换模板支持 Lolly 变量展开。
// //
// 参数: // 参数: