docs: 新增路由架构设计(模块自包含 + 主路由汇总)
- system-architecture.md: 3.2.1 路由架构(目录结构、调用关系、命名规范) - system-architecture.md: 5.1 更新微服务预留规则(模块自包含路由) - phase1 实施计划: Task 5 更新文件清单和步骤说明 Made-with: Cursor
This commit is contained in:
@@ -511,10 +511,13 @@ git commit -m "feat(auth): 认证服务层(注册、登录、JWT、密码加
|
||||
**Files:**
|
||||
- Create: `backend/go-service/app/auth/controller/auth_controller.go`
|
||||
- Create: `backend/go-service/app/auth/controller/admin_auth_controller.go`
|
||||
- Create: `backend/go-service/app/auth/router.go`
|
||||
- Modify: `backend/go-service/cmd/server/main.go` — 注册 auth 路由
|
||||
- Create: `backend/go-service/app/auth/router.go` — auth 模块路由定义(模块自包含)
|
||||
- Create: `backend/go-service/router/router.go` — 主路由汇总入口
|
||||
- Modify: `backend/go-service/cmd/server/main.go` — 调用 router.Setup() 注册路由
|
||||
- Modify: `backend/go-service/app/auth/provider.go` — 添加 Controller Provider
|
||||
|
||||
> **路由架构:** 采用"模块自包含 + 主路由汇总"模式。每个模块在自己目录内的 `router.go` 定义具体路由,`router/router.go` 主路由文件仅做汇总注册,不含具体路由定义。利于后期微服务拆分——整个模块目录搬走即可。
|
||||
|
||||
**Step 1: 创建前台认证 Controller**
|
||||
|
||||
创建 `app/auth/controller/auth_controller.go`:
|
||||
@@ -565,9 +568,15 @@ func RegisterRoutes(r *gin.Engine, ctrl *AuthController, adminCtrl *AdminAuthCon
|
||||
}
|
||||
```
|
||||
|
||||
**Step 4: 在 main.go 中注册路由**
|
||||
**Step 4: 创建主路由汇总文件**
|
||||
|
||||
修改 `cmd/server/main.go`,初始化 auth 模块的 DAO → Service → Controller 链,调用 RegisterRoutes。
|
||||
创建 `router/router.go`:
|
||||
- `Setup(engine, app)` 函数,负责注册健康检查和调用各模块的 RegisterRoutes
|
||||
- 不含任何具体路由定义,仅做汇总调度
|
||||
|
||||
**Step 5: 在 main.go 中调用 router.Setup()**
|
||||
|
||||
修改 `cmd/server/main.go`,将路由注册逻辑移到 `router.Setup()` 调用,main.go 不再直接定义路由。
|
||||
|
||||
**Step 5: 运行验证**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user