Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,910 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cap4k

CI Maven Central GitHub Release GitHub license Ask DeepWiki

使用官方模板

点击上方按钮,基于 cap4k 官方模板创建你自己的项目仓库。创建完成后,将新仓库克隆到本地,就可以开始设计领域模型。

cap4k 是面向后端业务系统的 DDD 战术框架与生成器协作工具,用 Clean Architecture、明确的生成/手写边界和可审阅证据帮助团队把业务模型落成代码。

它解决什么问题

很多后端项目知道自己需要 DDD、分层架构和可维护边界,但真正落地时容易退回到“一个 service 包办写入、读取、外部调用和事务”的结构。cap4k 解决的是这个落差:让聚合、命令、查询、事件、仓储、Unit of Work、Mediator、外部能力防腐层等战术概念在项目结构、生成结果和审阅证据中保持可见。

cap4k 的生成器不替代业务判断。它把已建模的业务意图、设计输入和类型清单投影成稳定代码槽位,并通过 plan.json、生成输出和分析证据帮助团队审阅“哪些由生成器管理,哪些必须由人写”。

核心亮点

  • DDD 战术建模:围绕 Aggregate、Entity、Value Object、Command、Query、Capability、Domain Event、Integration Event 等概念组织业务代码。
  • Clean Architecture 分层:把 domain、application、adapter、start 的责任和依赖方向拆清楚。
  • 生成器支撑作者流程:用 design.jsontypes.valueObjectManifesttypes.enumManifest、Gradle DSL 和源代码分析输入生成可审阅骨架。
  • 明确所有权边界:通过 cap4kAgentSnapshotcap4kPlan 和生成计划先审阅输出类型、目标 root、冲突策略、模板与 author-owned surface,再执行生成。
  • 分析证据:通过 cap4kAnalysisPlancap4kAnalysisGenerate 输出流程、依赖和 drawing-board 证据,辅助实现后的复盘。
  • 参考项目锚点:cap4k-reference-content-studio 提供四层多模块项目、发布流程、Value Object 类型输入和外部能力边界示例。

两条最短路径

Learning cap4k:

mental model -> docs/public/index.md -> concepts -> architecture -> cap4k-reference-content-studio

先用本页建立心智模型,再进入 Public Documentation,按 conceptsarchitecture 建立词汇与分层理解,最后用 cap4k-reference-content-studio 对照真实项目。

Creating new project:

official GitHub Template -> architecture -> authoring -> generator inputs/plan/generation

先通过页面顶部的官方 GitHub Template 创建四层项目,再确认 architecture 的分层边界,随后进入 authoring,按 generator inputs、plan review、generation 的顺序推进。团队也可以按同一架构合同手工建立项目;项目初始化由官方 GitHub Template 或手工结构负责,pipeline plugin 只提供已声明的 pipeline 任务。

文档地图

  • docs/public/index.md:按读者目标进入文档。
  • concepts:DDD 战术概念和执行所有权。
  • architecture:Clean Architecture 分层、依赖规则和按层测试。
  • examples:以 cap4k-reference-content-studio 为主的阅读与运行锚点。
  • authoring:从业务意图、技术设计、生成输入到实现和验证的作者循环。
  • generator:项目检查、输入来源、计划审阅、生成任务和分析证据。
  • reference:Gradle 插件、DSL、JSON 输入、计划、输出、分析和运行时 SQL 的精确查表。

什么时候适合

  • 你在做后端业务系统,且需要把业务规则、事务边界、读写分离和外部能力边界写清楚。
  • 你希望生成器先产出可审阅骨架和计划,再由人补全关键业务逻辑。
  • 你愿意把 Command、Query、Capability、Domain Event、Integration Event 等概念作为代码结构的一部分。
  • 你需要把实现结果和分析证据交给团队或 AI 助手复查。

什么时候不适合

  • 你只需要一次性产物,而不需要长期维护的领域边界、ownership evidence 和手写业务逻辑。
  • 你需要的主要能力不在后端业务建模、分层实现和生成证据范围内。
  • 你希望工具自动决定业务边界、业务规则、补偿策略或跨系统语义。
  • 你的项目不准备采用 DDD 战术概念或 Clean Architecture 分层。

当前 Gradle 入口

Gradle plugin id:

plugins {
    id("io.github.ldmoxeii.cap4k.pipeline")
}

常用任务:

  • cap4kAgentSnapshot:生成 build/cap4k/agent/ 下的只读、分区化项目快照,供 agent 按需检查能力、输入、所有权、运行时、分析和诊断。
  • cap4kPlan:根据当前输入生成 build/cap4k/plan.json,用于审阅生成输出和所有权。
  • cap4kGenerate:按计划生成 checked-in source 或 output artifact。
  • cap4kGenerateSources:生成参与源码集的 generated source。
  • cap4kAnalysisPlan:生成 build/cap4k/analysis-plan.json
  • cap4kAnalysisGenerate:生成代码分析、流程和 drawing-board 等证据。

精确字段、输出路径和任务关系见 Gradle plugin reference

License / links

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages