b8d2a93c9f
- STACK.md - 技术栈和依赖 - INTEGRATIONS.md - 外部集成 - ARCHITECTURE.md - 架构设计 - STRUCTURE.md - 代码库结构 - CONVENTIONS.md - 编码规范 - TESTING.md - 测试模式 - CONCERNS.md - 技术债务和问题
97 lines
2.9 KiB
Markdown
97 lines
2.9 KiB
Markdown
# 代码库结构
|
||
|
||
**分析日期：** 2026-02-28
|
||
|
||
## 目录布局
|
||
|
||
```
|
||
fengling-console/
|
||
├── global.json # .NET SDK 版本配置
|
||
├── Directory.Build.props # 项目共享属性
|
||
├── src/
|
||
│ ├── Fengling.Console.csproj # 主项目文件
|
||
│ ├── Program.cs # 应用入口
|
||
│ ├── Dockerfile # Docker 构建文件
|
||
│ ├── appsettings.json # 应用配置
|
||
│ ├── appsettings.Development.json # 开发环境配置
|
||
│ ├── Properties/
|
||
│ │ └── launchSettings.json # 启动配置
|
||
│ ├── Controllers/ # API 控制器
|
||
│ ├── Services/ # 业务服务层
|
||
│ ├── Models/
|
||
│ │ └── Dtos/ # 数据传输对象
|
||
│ └── bin/Debug/ # 编译输出
|
||
├── .gitea/workflows/ # CI/CD 流水线
|
||
```
|
||
|
||
## 目录用途
|
||
|
||
**src/Controllers/：**
|
||
- 用途：API 端点定义
|
||
- 包含文件：
|
||
- `UsersController.cs` - 用户管理 API
|
||
- `RolesController.cs` - 角色管理 API
|
||
- `TenantsController.cs` - 租户管理 API
|
||
- `OAuthClientsController.cs` - OAuth 客户端 API
|
||
- `GatewayController.cs` - 网关配置 API
|
||
- `GlobalUsing.cs` - 全局 using 指令
|
||
|
||
**src/Services/：**
|
||
- 用途：业务逻辑实现
|
||
- 包含文件：
|
||
- `UserService.cs` - 用户业务逻辑
|
||
- `RoleService.cs` - 角色业务逻辑
|
||
- `TenantService.cs` - 租户业务逻辑
|
||
- `OAuthClientService.cs` - OAuth 客户端逻辑
|
||
- `GatewayService.cs` - 网关配置逻辑
|
||
- `H5LinkService.cs` - H5 链接服务
|
||
|
||
**src/Models/Dtos/：**
|
||
- 用途：API 数据传输对象
|
||
- 包含文件：
|
||
- CreateXxxDto.cs (CreateUserDto, CreateRoleDto, CreateTenantDto, CreateClientDto)
|
||
- UpdateXxxDto.cs (UpdateUserDto, UpdateRoleDto, UpdateTenantDto, UpdateClientDto)
|
||
- XxxDto.cs (UserDto, RoleDto, TenantDto, OAuthClientDto, GatewayDto)
|
||
- XxxQueryDto.cs (UserQueryDto, RoleQueryDto, TenantQueryDto, OAuthClientQueryDto)
|
||
- `PaginationDto.cs` - 分页结果
|
||
- `ResetPasswordDto.cs` - 密码重置
|
||
- `TenantSettingsDto.cs` - 租户设置
|
||
|
||
## 关键文件位置
|
||
|
||
**入口点：**
|
||
- `src/Program.cs` - 应用启动配置和服务注册
|
||
|
||
**配置：**
|
||
- `src/appsettings.json` - 应用配置
|
||
- `src/appsettings.Development.json` - 开发环境配置
|
||
|
||
**核心逻辑：**
|
||
- `src/Services/UserService.cs` - 用户服务实现
|
||
- `src/Controllers/UsersController.cs` - 用户 API
|
||
|
||
## 命名约定
|
||
|
||
**文件：**
|
||
- PascalCase：`UserService.cs`、`UsersController.cs`
|
||
|
||
**目录：**
|
||
- PascalCase：`Controllers/`、`Services/`、`Models/Dtos/`
|
||
|
||
**类/接口：**
|
||
- PascalCase：`UserService`、`IUserService`
|
||
|
||
## 新增代码位置
|
||
|
||
**新增功能：**
|
||
- API 端点：`src/Controllers/`
|
||
- 业务逻辑：`src/Services/`
|
||
- DTO：`src/Models/Dtos/`
|
||
|
||
**新增测试：**
|
||
- 建议位置：单独的测试项目（如 `tests/` 目录）
|
||
|
||
---
|
||
|
||
*结构分析：2026-02-28*
|