Documentation
¶
Overview ¶
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Package middleware 提供了 HTTP 中间件功能。 包括速率限制、压缩、请求体限制、指标收集等中间件。
Index ¶
- func AuthMiddleware(apiKey string) func(http.Handler) http.Handler
- func BodyLimitMiddleware(next http.Handler) http.Handler
- func CompressMiddleware(next http.Handler) http.Handler
- func ErrorHandlerMiddleware(appMode string) func(http.Handler) http.Handler
- func IPWhitelistMiddleware(whitelist string) func(http.Handler) http.Handler
- func MetricsMiddleware(next http.Handler) http.Handler
- func OptionalAuthMiddleware(apiKey string) func(http.Handler) http.Handler
- func RateLimitMiddlewareWithLimiter(limiter *RateLimiter) func(http.Handler) http.Handler
- func SafeError(w http.ResponseWriter, r *http.Request, statusCode int, err error, ...)
- func SecurityHeadersMiddleware(next http.Handler) http.Handler
- type ErrorResponse
- type RateLimiter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AuthMiddleware ¶
AuthMiddleware 创建 API Key 认证中间件
该中间件通过检查请求头中的 X-API-Key 来验证请求是否被授权。 如果 API Key 为空,则所有请求都会被拒绝(生产环境应该设置 API Key)。 如果 API Key 不为空,则只有提供正确 API Key 的请求才能通过。
参数:
- apiKey: API Key 值,如果为空则禁用认证(不推荐在生产环境使用)
返回:
- func(http.Handler) http.Handler: HTTP 中间件函数
使用示例:
authMiddleware := AuthMiddleware("your-api-key-here")
handler := authMiddleware(protectedHandler)
func BodyLimitMiddleware ¶
BodyLimitMiddleware 创建请求体大小限制中间件 限制请求体大小,防止恶意请求 注意:http.MaxBytesReader 会在读取时自动检查大小,超过限制会返回错误
func CompressMiddleware ¶
CompressMiddleware 创建 gzip 压缩中间件 自动检测客户端是否支持 gzip,如果支持则压缩响应
func ErrorHandlerMiddleware ¶
ErrorHandlerMiddleware 创建错误处理中间件
该中间件在生产环境隐藏详细的错误信息,只返回通用错误消息。 详细错误信息仅记录在日志中,不返回给客户端。
参数:
- appMode: 应用模式("production" 或 "prod" 表示生产环境)
返回:
- func(http.Handler) http.Handler: HTTP 中间件函数
func IPWhitelistMiddleware ¶
IPWhitelistMiddleware 创建 IP 白名单中间件
该中间件只允许白名单中的 IP 地址访问受保护的端点。 白名单通过环境变量 IP_WHITELIST 配置,支持逗号分隔的多个 IP 或 CIDR 网段。
参数:
- whitelist: IP 白名单(逗号分隔的 IP 地址或 CIDR 网段)
返回:
- func(http.Handler) http.Handler: HTTP 中间件函数
func MetricsMiddleware ¶
MetricsMiddleware 创建 Prometheus 指标收集中间件
func OptionalAuthMiddleware ¶
OptionalAuthMiddleware 创建可选的 API Key 认证中间件
与 AuthMiddleware 不同,如果 API Key 为空,该中间件不会拒绝请求。 这适用于某些端点需要可选认证的场景。
参数:
- apiKey: API Key 值,如果为空则不进行认证
返回:
- func(http.Handler) http.Handler: HTTP 中间件函数
func RateLimitMiddlewareWithLimiter ¶
func RateLimitMiddlewareWithLimiter(limiter *RateLimiter) func(http.Handler) http.Handler
RateLimitMiddlewareWithLimiter 创建速率限制中间件(使用指定的 RateLimiter 实例) 推荐使用此方法,避免全局变量
func SafeError ¶
func SafeError(w http.ResponseWriter, r *http.Request, statusCode int, err error, detailMessage string)
SafeError 安全地返回错误响应(根据环境决定是否隐藏详细信息)
func SecurityHeadersMiddleware ¶
SecurityHeadersMiddleware 创建安全响应头中间件
该中间件添加安全相关的 HTTP 响应头,提高应用的安全性。 包括: - X-Content-Type-Options: 防止 MIME 类型嗅探 - X-Frame-Options: 防止点击劫持 - X-XSS-Protection: 启用浏览器 XSS 过滤器 - Referrer-Policy: 控制 referrer 信息 - Content-Security-Policy: 内容安全策略(可选)
返回:
- func(http.Handler) http.Handler: HTTP 中间件函数
Types ¶
type ErrorResponse ¶
type ErrorResponse struct {
Error string `json:"error"`
Message string `json:"message,omitempty"`
Code string `json:"code,omitempty"`
}
ErrorResponse 错误响应结构
type RateLimiter ¶
type RateLimiter struct {
// contains filtered or unexported fields
}
RateLimiter 实现简单的内存速率限制
func NewRateLimiter ¶
func NewRateLimiter(rate int, window time.Duration) *RateLimiter
NewRateLimiter 创建新的速率限制器 rate: 允许的请求数 window: 时间窗口(例如 1 * time.Minute)
func (*RateLimiter) AddToWhitelist ¶
func (rl *RateLimiter) AddToWhitelist(ip string) bool
AddToWhitelist 将 IP 添加到白名单
func (*RateLimiter) IsWhitelisted ¶
func (rl *RateLimiter) IsWhitelisted(ip string) bool
IsWhitelisted 检查 IP 是否在白名单中
func (*RateLimiter) RemoveFromWhitelist ¶
func (rl *RateLimiter) RemoveFromWhitelist(ip string)
RemoveFromWhitelist 从白名单中移除 IP
func (*RateLimiter) Stop ¶
func (rl *RateLimiter) Stop()
Stop 停止速率限制器 使用 sync.Once 确保只执行一次,避免重复关闭 channel 导致 panic