用途:这是一个提示模板,用于在项目启动阶段固定架构、模块边界、契约规则和自动检查,防止 AI 代理在后续开发中逐步破坏项目结构。使用时需填写其占位符,整体交给新的执行代理,不要改写原意。
架构模型:采用模块化 DDD + 垂直切片 + 端口/适配器。项目划分为有界上下文模块;每个用例为一个垂直切片,自带编排逻辑、测试和公共入口;应用层仅作薄组合根,无业务逻辑;平台层只含配置、数据库、认证原语、HTTP 基线、队列、存储、可观测性、测试等横切能力。模块之间不得直接导入彼此内部,只能通过显式发布的契约通信。
契约规则:每个有界上下文只有一条公共契约边界,可导出 DTO/读模型、命令/查询输入类型、服务边界接口、领域事件封装、公共枚举/值对象、纯策略函数;禁止导出仓储实现、SQL/查询构建器、HTTP 处理器、UI 组件、worker/作业实现、私有辅助函数,以及无明确确认需求的兼容别名。特性之间同样只能通过公共边界导入。
依赖流向:允许 apps 指向适配器/模块公共边界/平台;适配器指向特性公共边界/契约/infra/平台;特性指向领域/契约/平台/自身 infra/其他特性公共边界;领域指向领域原语;平台指向平台/外部包。禁止模块间内部互导、特性间内部互导、领域依赖适配器/特性、特性依赖适配器、平台依赖产品模块/应用、应用间互导及运行时循环。
三层检查:快速规则 linter 检查本地导入禁令;导入图检查运行时循环与仅通过契约/公共边界跨模块访问;文件系统校验器检查模块形状(必备 contract/domain/features/infra/adapters 区域、每个特性有公共边界、测试与特性并列、禁止通用 helpers/utils/common/misc、禁止本地文档作为假事实源)。
技术栈配置:TypeScript/JavaScript 用 ESLint flat config、typescript-eslint、no-restricted-imports、dependency-cruiser 及独立文件系统校验脚本;Java/Kotlin 用 ArchUnit + Checkstyle/Detekt/Ktlint;Python 用 Ruff + import-linter + pytest;Go 用 golangci-lint + depguard + 自定义图检查;C# 用 Roslyn analyzers + NetArchTest;Rust 用 cargo-deny/cargo-machete + 自定义 crate 图检查。
统一命令:lint(常规 lint + 架构检查)、lint:architecture(导入图 + 文件系统校验)、typecheck、test、verify:release(密钥/产物/运行时检查 + lint + 架构 + typecheck + 测试 + 构建)、db:verify(若有数据库)。CI 必须运行相同命令,lint:architecture 失败则禁止合并/发布。
代理规则要点:遵循模块化 DDD + 垂直切片;跨模块仅经公共契约,跨特性仅经公共边界;不得临时导入内部文件;领域不依赖适配器/UI/HTTP/worker/特性编排;平台不导入产品模块/应用且无业务逻辑;应用保持薄组合根;不创建通用 helpers/utils;新增跨模块行为先更新契约和消费者测试;任务完成以相关 lint/typecheck/测试/架构检查通过为准。
限制:本资料为提示模板,未提供具体收费、价格、平台或效果数据;实际落地需结合所选技术栈配置等价工具。