xfy
2688ed6a9c
- 根目录新增 scripts/ 和 .github/ 目录说明 - internal 新增 benchmark/ 和 netutil/ 目录说明 - middleware 新增 bodylimit/ 和 errorintercept/ 目录说明 - 更新日期为 2026-04-07 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
<!-- Parent: ../AGENTS.md -->
|
||
<!-- Generated: 2026-04-02 | Updated: 2026-04-07 -->
|
||
|
||
# middleware
|
||
|
||
## Purpose
|
||
中间件框架，定义统一的中间件接口和链式组合机制，包含多个具体中间件实现。
|
||
|
||
## Key Files
|
||
|
||
| File | Description |
|
||
|------|-------------|
|
||
| `middleware.go` | 中间件接口和链：Middleware 接口、Chain 结构体、Apply 方法 |
|
||
|
||
## Subdirectories
|
||
|
||
| Directory | Purpose |
|
||
|-----------|---------|
|
||
| `accesslog/` | 访问日志中间件（请求记录、响应统计） |
|
||
| `bodylimit/` | 请求体大小限制中间件（超限返回 413） |
|
||
| `compression/` | 响应压缩中间件（Gzip、Deflate） |
|
||
| `errorintercept/` | 错误拦截中间件（自定义错误页面） |
|
||
| `rewrite/` | URL 重写中间件（正则替换、路径转换） |
|
||
| `security/` | 安全中间件（访问控制、认证、限流、安全头部） |
|
||
|
||
## For AI Agents
|
||
|
||
### Working In This Directory
|
||
- `Middleware` 接口定义：`Name() string` 和 `Process(next) RequestHandler`
|
||
- `Chain` 用于组合多个中间件，按注册顺序逆序包装
|
||
- `Apply()` 从最后一个中间件开始包装，确保执行顺序正确
|
||
- 后续阶段将添加具体中间件实现（安全、压缩、重写等）
|
||
|
||
### Testing Requirements
|
||
- 运行测试：`go test ./internal/middleware/...`
|
||
- 测试链式组合和执行顺序
|
||
|
||
### Common Patterns
|
||
- 中间件使用 `fasthttp.RequestHandler` 函数签名
|
||
- 包装模式：`func(ctx) { preProcess(); next(ctx); postProcess() }`
|
||
- 空 Chain 的 `Apply()` 直接返回原始 handler
|
||
|
||
## Dependencies
|
||
|
||
### External
|
||
- `github.com/valyala/fasthttp` - HTTP 框架
|
||
|
||
<!-- MANUAL: --> |