huang
5a179ba16b
All checks were successful
构建并部署到测试环境（无 SSH） / build-and-deploy (push) Successful in 4m48s
247 lines
8.3 KiB
Markdown
247 lines
8.3 KiB
Markdown
|
||
---
|
||
|
||
# junhong_cmp_fiber 项目开发规范
|
||
|
||
**重要**: 本文件包含核心规范。详细规范已提取为 Skills，在特定任务时按需加载。
|
||
|
||
## 专项规范 Skills（按需加载）
|
||
|
||
以下规范在相关任务时**自动触发**，无需手动加载：
|
||
|
||
| 任务类型 | 触发 Skill | 说明 |
|
||
|---------|-----------|------|
|
||
| 创建/修改 DTO 文件 | `dto-standards` | description 标签、枚举字段、验证标签规范 |
|
||
| 创建/修改 Model 模型 | `model-standards` | GORM 模型结构、字段标签、TableName 规范 |
|
||
| 注册 API 路由 / **新增 Handler** | `api-routing` | Register() 函数、RouteSpec、**文档生成器更新** |
|
||
| 测试接口/验证数据 | `db-validation` | PostgreSQL MCP 使用方法和验证示例 |
|
||
| 数据库迁移 | `db-migration` | 迁移命令、文件规范、执行流程、失败处理 |
|
||
| 维护规范文档 | `doc-management` | 规范文档流程和维护规则 |
|
||
|
||
### ⚠️ 新增 Handler 时必须同步更新文档生成器
|
||
|
||
新增 Handler 后，接口不会自动出现在 OpenAPI 文档中。**必须手动更新以下两个文件**：
|
||
|
||
```go
|
||
// cmd/api/docs.go 和 cmd/gendocs/main.go
|
||
handlers := &bootstrap.Handlers{
|
||
// ... 添加新 Handler
|
||
NewHandler: admin.NewXxxHandler(nil),
|
||
}
|
||
```
|
||
|
||
**完整检查清单**: 参见 [`docs/api-documentation-guide.md`](docs/api-documentation-guide.md#新增-handler-检查清单)
|
||
|
||
---
|
||
|
||
## 语言要求
|
||
|
||
**必须遵守:**
|
||
- 永远用中文交互
|
||
- 注释必须使用中文
|
||
- 文档必须使用中文
|
||
- 日志消息必须使用中文
|
||
- 用户可见的错误消息必须使用中文
|
||
- 变量名、函数名、类型名必须使用英文（遵循 Go 命名规范）
|
||
- GIT提交的commit必须使用中文
|
||
|
||
## 技术栈
|
||
|
||
**必须严格遵守，禁止替代方案:**
|
||
|
||
| 类型 | 技术 |
|
||
|------|------|
|
||
| HTTP 框架 | Fiber v2.x |
|
||
| ORM | GORM v1.25.x |
|
||
| 配置管理 | Viper |
|
||
| 日志 | Zap + Lumberjack.v2 |
|
||
| JSON 序列化 | sonic（优先），encoding/json（必要时） |
|
||
| 验证 | Validator |
|
||
| 任务队列 | Asynq v0.24.x |
|
||
| 数据库 | PostgreSQL 14+ |
|
||
| 缓存 | Redis 6.0+ |
|
||
|
||
**禁止:**
|
||
- 直接使用 `database/sql`（必须通过 GORM）
|
||
- 使用 `net/http` 替代 Fiber
|
||
- 使用 `encoding/json` 替代 sonic（除非必要）
|
||
|
||
## 架构分层
|
||
|
||
必须遵循以下分层架构：
|
||
|
||
```
|
||
Handler → Service → Store → Model
|
||
```
|
||
|
||
- **Handler**: 只处理 HTTP 请求/响应，不包含业务逻辑
|
||
- **Service**: 包含所有业务逻辑，支持跨模块调用
|
||
- **Store**: 统一管理所有数据访问，支持事务处理
|
||
- **Model**: 定义数据结构和 DTO
|
||
|
||
## 核心原则
|
||
|
||
### 错误处理
|
||
- 所有错误必须在 `pkg/errors/` 中定义
|
||
- 使用统一错误码系统
|
||
- Handler 层通过返回 `error` 传递给全局 ErrorHandler
|
||
|
||
### 响应格式
|
||
- 所有 API 响应使用 `pkg/response/` 的统一格式
|
||
- 格式: `{code, message, data, timestamp}`
|
||
|
||
### 常量管理
|
||
- 所有常量定义在 `pkg/constants/`
|
||
- Redis key 使用函数生成: `Redis{Module}{Purpose}Key(params...)`
|
||
- 禁止硬编码字符串和 magic numbers
|
||
- **必须为所有常量添加中文注释**
|
||
|
||
### Go 代码风格
|
||
- 使用 `gofmt` 格式化
|
||
- 遵循 [Effective Go](https://go.dev/doc/effective_go)
|
||
- 包名: 简短、小写、单数、无下划线
|
||
- 接口命名: 使用 `-er` 后缀（Reader、Writer、Logger）
|
||
|
||
## 数据库设计
|
||
|
||
**核心规则:**
|
||
- ❌ 禁止建立外键约束
|
||
- ❌ 禁止使用 GORM 关联关系标签（foreignKey、hasMany、belongsTo）
|
||
- ✅ 关联通过存储 ID 字段手动维护
|
||
- ✅ 关联数据在代码层面显式查询
|
||
|
||
## Go 惯用法 vs Java 风格
|
||
|
||
### ✅ Go 风格（推荐）
|
||
- 扁平化包结构（最多 2-3 层）
|
||
- 小而专注的接口（1-3 个方法）
|
||
- 直接访问导出字段（不用 getter/setter）
|
||
- 组合优于继承
|
||
- 显式错误返回和检查
|
||
|
||
### ❌ Java 风格（禁止）
|
||
- 过度抽象（不必要的接口、工厂）
|
||
- Getter/Setter 方法
|
||
- 深层继承层次
|
||
- 异常处理（panic/recover）
|
||
- 类型前缀（IService、AbstractBase、ServiceImpl）
|
||
|
||
## 测试要求
|
||
|
||
- 核心业务逻辑（Service 层）测试覆盖率 ≥ 90%
|
||
- 所有 API 端点必须有集成测试
|
||
- 使用 table-driven tests
|
||
- 单元测试 < 100ms，集成测试 < 1s
|
||
|
||
### ⚠️ 测试真实性原则（严格遵守）
|
||
|
||
**测试必须真正验证功能，禁止绕过核心逻辑：**
|
||
|
||
| 规则 | 说明 |
|
||
|------|------|
|
||
| ❌ 禁止传递 nil 绕过依赖 | 如果功能依赖外部服务（如对象存储、第三方 API），测试必须验证该依赖的调用 |
|
||
| ❌ 禁止只测试部分流程 | 如果功能包含 A → B → C 三步，不能只测试 B 而跳过 A 和 C |
|
||
| ❌ 禁止声称"测试通过"但未验证核心逻辑 | 测试通过必须意味着功能真正可用 |
|
||
| ❌ 禁止擅自使用 Mock | 尽量使用真实服务进行集成测试，如需使用 Mock 必须先询问用户并获得同意 |
|
||
| ✅ 必须验证端到端流程 | 新增功能必须有完整的集成测试覆盖整个调用链 |
|
||
| ✅ 缺少配置时必须询问 | 如果测试需要的配置（如 API Key、环境变量）缺失，必须询问用户而非跳过测试 |
|
||
|
||
**反面案例**：
|
||
```go
|
||
// ❌ 错误：传递 nil 绕过 storageService，只测试了 processImport
|
||
handler := NewIotCardImportHandler(db, redis, store1, store2, nil, logger)
|
||
result := handler.processImport(ctx, task) // 跳过了 downloadAndParseCSV
|
||
|
||
// ✅ 正确：使用真实服务测试完整流程
|
||
handler := NewIotCardImportHandler(db, redis, store1, store2, realStorageService, logger)
|
||
handler.HandleIotCardImport(ctx, asynqTask) // 测试完整流程，验证真实上传/下载
|
||
```
|
||
|
||
**测试超时 = 生产超时**：
|
||
- 集成测试超时意味着生产环境也可能超时
|
||
- 发现超时必须排查原因，不能简单跳过或增加超时时间
|
||
|
||
### 测试连接管理（必读）
|
||
|
||
**详细规范**: [docs/testing/test-connection-guide.md](docs/testing/test-connection-guide.md)
|
||
|
||
**标准模板**:
|
||
```go
|
||
func TestXxx(t *testing.T) {
|
||
tx := testutils.NewTestTransaction(t)
|
||
rdb := testutils.GetTestRedis(t)
|
||
testutils.CleanTestRedisKeys(t, rdb)
|
||
|
||
store := postgres.NewXxxStore(tx, rdb)
|
||
// 测试代码...
|
||
}
|
||
```
|
||
|
||
**核心函数**:
|
||
- `NewTestTransaction(t)`: 创建测试事务，自动回滚
|
||
- `GetTestRedis(t)`: 获取全局 Redis 连接
|
||
- `CleanTestRedisKeys(t, rdb)`: 自动清理测试 Redis 键
|
||
|
||
**禁止使用（已移除）**:
|
||
- ❌ `SetupTestDB` / `TeardownTestDB` / `SetupTestDBWithStore`
|
||
|
||
## 性能要求
|
||
|
||
- API P95 响应时间 < 200ms
|
||
- API P99 响应时间 < 500ms
|
||
- 数据库查询 < 50ms
|
||
- 列表查询必须分页（默认 20，最大 100）
|
||
- 避免 N+1 查询，使用批量操作
|
||
|
||
## 文档要求
|
||
|
||
- 每个功能在 `docs/{feature-id}/` 创建总结文档
|
||
- 文档文件名和内容使用中文
|
||
- 同步更新 README.md
|
||
- 为导出的函数、类型编写文档注释
|
||
|
||
## 函数复杂度
|
||
|
||
- 函数长度 ≤ 100 行（核心逻辑建议 ≤ 50 行）
|
||
- `main()` 函数只做编排，不含具体实现
|
||
- 遵循单一职责原则
|
||
|
||
## 访问日志
|
||
|
||
- 所有 HTTP 请求记录到 `access.log`
|
||
- 记录完整的请求/响应（限制 50KB）
|
||
- 包含: method, path, query, status, duration, request_id, ip, user_agent, user_id, bodies
|
||
- 使用 JSON 格式，配置自动轮转
|
||
|
||
## OpenSpec 工作流
|
||
|
||
创建提案前的检查清单：
|
||
|
||
1. ✅ 技术栈合规
|
||
2. ✅ 架构分层正确
|
||
3. ✅ 使用统一错误处理
|
||
4. ✅ 常量定义在 pkg/constants/
|
||
5. ✅ Go 惯用法（非 Java 风格）
|
||
6. ✅ 包含测试计划
|
||
7. ✅ 性能考虑
|
||
8. ✅ 文档更新计划
|
||
9. ✅ 中文优先
|
||
|
||
### ⚠️ 任务执行规范（必须遵守）
|
||
|
||
**提案中的 tasks.md 是契约，不可擅自变更：**
|
||
|
||
| 规则 | 说明 |
|
||
|------|------|
|
||
| ❌ 禁止跳过任务 | 每个任务都是经过规划的，不能因为"简单"或"显而易见"而跳过 |
|
||
| ❌ 禁止简化任务 | 不能将多个任务合并或简化执行，除非获得明确许可 |
|
||
| ❌ 禁止自作主张优化 | 发现可以优化的地方，必须先询问是否可以调整 |
|
||
| ✅ 必须逐项完成 | 按照 tasks.md 中的顺序逐一执行并标记完成 |
|
||
| ✅ 必须询问后变更 | 如需调整任务（简化/跳过/合并/优化），先询问用户确认 |
|
||
|
||
**询问示例**：
|
||
> "我注意到任务 2.1 和 2.2 可以合并为一步完成，是否可以这样优化？"
|
||
> "任务 3.1 在当前实现中可能不需要，是否可以跳过？"
|
||
|
||
**详细规范和 OpenSpec 工作流请查看**: `@/openspec/AGENTS.md`
|