Dedsiddd Dotnet Coding

DTO

• MEDIUM: dto-conventions.md
• MEDIUM: dto-xml-comments.md

数据库

• HIGH: dbcontext-configuration.md
• HIGH: ef-core-mapping.md
• HIGH: no-direct-sql-data-operations.md
• HIGH: sql-server-table-script.md

仓储

• HIGH: repository-patterns.md

CQRS

• HIGH: command-handlers.md
• HIGH: query-handlers.md
• HIGH: pagination-queries.md

Controller

• HIGH: controller-patterns.md
• HIGH: permission-code-consts.md

通用

• HIGH: cancellation-token.md
• MEDIUM: enum-conventions.md
• MEDIUM: file-organization.md
• HIGH: frontend-integration-spec.md
• MEDIUM: naming-conventions.md
• HIGH: project-structure.md

质量规则

• HIGH: common-pitfalls.md

交互协议

冲突优先级

本 SKILL 约定 > 现有仓库约定 > 一般 DDD/CQRS 习惯

Controller 路由强约束

• 必须继承项目基类 Controller。
• 父类统一路由：api/*/[controller]/[action]。
• 方法级模板只允许纯参数段："{id}"、"{id:guid}"。
• 禁止字面量段："options"、"export"、"delete"、"enable"、"disable"。
• 参数绑定通过 [FromRoute]、[FromBody]、[FromQuery] 完成。

澄清问题清单

生成代码前先确认：

1. 模块边界：模块、命名空间、目录
2. 路由风格：默认 action route；模板仅允许参数段
3. 对象类型：创建聚合根还是实体；单复数、主键类型
4. 字段清单：类型、必填、长度、默认值、枚举、值对象
5. Repository 策略：按聚合根还是实体模式生成
6. 关系与集合：一对多/多对多、唯一性、更新策略
7. 数据库映射：表名、Schema、索引、软删、SQL 文件名
8. 权限设计：是否需要定义 *PermissionCodeConsts、读写动作如何命名、是否要同步落权限数据脚本
9. API 契约：Get/Paged/Create/Update/Delete/Export
10. 返回结构：是否有统一包装

如果用户没有明确说明对象类型，必须先确认“创建聚合根还是实体”，不能自行假设。

缺省策略

• 主键：默认 string，Ulid.NewUlid().ToString()
• 分页：DedsiPagedRequestDto
• 更新集合：默认 Clear + Add
• SQL：默认生成到 sqlFiles/Create[Entities].sql
• 项目落点：默认按 modules/[Project]/[Project].Domain、modules/[Project]/[Project].UseCase、modules/[Project]/[Project].Infrastructure、modules/[Project]/[Project].HttpApi 组织
• 导出：仅仓库已存在 MiniExcel 时生成

交付标准

• 明确的文件清单与落点（Domain/Infrastructure/UseCase/HttpApi/sqlFiles）
• 每个文件的代码模板或最小变更补丁
• 创建前已明确对象类型：聚合根或实体
• Repository 已按对象类型生成：聚合根走聚合根规则，实体走实体规则
• 聚合根主表对应的 SQL Server 建表脚本必须落在 sqlFiles 目录，并可参考现有 CreateUsers.sql、CreateRoles.sql、CreatePermissions.sql 风格
• 每个聚合根主表必须在字段末尾按固定顺序追加 5 个字段：CreatorName、CreatorId、CreationTime、ExtraProperties、ConcurrencyStamp
• 如果领域对象包含子对象或子集合，必须同步更新 modules/[Project]/[Project].Infrastructure/[Project]InfrastructureModule.cs 中的 Configure<AbpEntityOptions>，为默认详情查询补齐 DefaultWithDetailsFunc 与 .Include(...)
• InfrastructureModule 中不要手工注册 IRepository -> Repository
• 所有公开入口包含 CancellationToken 并透传到 EF Core/仓储
• 禁止在运行时代码中直接写 SQL 对业务数据执行查询、修改、删除、新增；默认必须优先使用 Repository、EF Core LINQ、ExecuteUpdateAsync、ExecuteDeleteAsync 等既有能力
• 分页查询顺序：筛选 → Count → 排序 →（非导出则分页）→ 投影 → ToList
• 所有 PagedQuery 中的条件筛选必须优先使用 WhereIf(...) 链式写法完成，避免继续使用多段 if (...) { query = query.Where(...); } 的分散写法
• Controller 能编译并能调用 Query/Mediator；Command/Query 返回类型与 Controller 对齐
• 每个业务目录默认需要定义“领域名 + PermissionCodeConsts.cs”，并至少补齐 *.list、*.read、*.create、*.update、*.delete 等常用权限编码；当前仓库生成值必须统一以 Auth-PermissionCode: 开头，并优先复用公共 AuthorizationPolicyConsts.PermissionPrefix；特殊动作按业务再补充
• 生成 Controller 时，业务接口默认需要补齐 [Authorize(...PermissionCodeConsts...)]，禁止继续输出硬编码权限字符串
• Controller 方法不得添加字面量 route 片段；如需模板，仅允许 "{id}"、"{id:guid}" 这类参数段
• 关键代码位置上方需要添加简洁、准确的中文注释，说明业务目的或实现意图；禁止添加无信息量的注释
• 方法、类型、属性、参数、局部变量命名必须符合 C# 编程规范，优先使用清晰完整的英文语义命名，避免随意缩写和单字母命名
• 按既有工作流完成后，必须额外输出一份“前端对接说明单”，供前端 AI Agent 使用
• 前端对接说明单至少包含：内容标题、API 地址、请求方式、入参、出参
• 前端对接说明单中的入参与出参必须逐字段列出，并为每个字段补充简洁中文注释；如存在嵌套对象或数组项，也必须展开说明字段结构
• 前端对接说明单生成完成后，必须保存到项目根目录的 frontendIntegrationDocs 文件夹中
• 前端对接说明单在 frontendIntegrationDocs 下必须按领域划分子文件夹进行存放；领域文件夹不存在时必须先创建
• 最终回复中必须给出前端对接说明单的完整物理路径，确保用户和前端 AI Agent 可以直接复制使用
• 最终回复中在给出前端对接说明单完整物理路径后，必须额外输出一段可直接复制的话术，供用户直接发送给前端 AI Agent；话术必须包含 3 行固定结构：第 1 行为 /dedsi-vue3-coding，第 2 行为 前端对接说明单地址：{完整物理路径}，第 3 行为 请基于该前端对接说明单，使用相关技能完成“{功能名称}”功能对接。

注释与命名补充要求

• 公共类型和公共方法默认补齐 XML 注释
• 私有方法、内部类型、关键分支、关键转换逻辑上方应补充中文说明注释
• 注释重点说明“为什么这样做”或“这段代码解决什么问题”，不要只复述代码字面含义
• 类型名、方法名、属性名使用 PascalCase
• 方法参数、局部变量、私有字段使用 camelCase
• 布尔变量和布尔参数优先使用可读性好的语义命名，如 isEnabled、hasChildren、canDelete

模块化目录约束

• 默认采用模块化目录：modules/[Project]/
• 单个业务模块内部固定拆分为 [Project].Domain、[Project].UseCase、[Project].Infrastructure、[Project].HttpApi
• host、aspires、sqlFiles、frontendIntegrationDocs 属于模块外公共目录，不放进模块内部
• 生成文件时，必须优先复用现有模块目录，不再回退到 src/ 结构

占位符规则

生成代码时必须替换：

• [Project] - 项目名称
• [Domain] - 领域实体名称
• [Entities] - 实体复数形式
• [DbContext] - DbContext 名称
• [Child] - 子实体名称

推荐工作流

1. 澄清边界与不变式
2. 确认创建聚合根还是实体
3. 领域模型
4. 定义权限编码
5. SQL 脚本
6. DTO
7. DbContext + EntityConfiguration
8. InfrastructureModule 的 AbpEntityOptions
9. Repository
10. Commands
11. Queries
12. Controller
13. 一致性检查
14. 输出前端对接说明单

参考

• dedsi-framework - Dedsi Framework 接入指南