基于 Wow 框架的 DDD 项目模版

用于快速构建基于 Wow 框架 的 DDD 项目模板。

模块介绍

模块	说明
api	API 层，定义聚合命令（Command）、领域事件（Domain Event）以及查询视图模型（Query View Model）。充当各个模块之间通信的“发布语言”，同时提供详细的 API 文档，助力开发者理解和使用接口。
domain	领域层，包含聚合根和业务约束的实现。聚合根充当领域模型的入口点，负责协调领域对象的操作，确保业务规则的正确执行。业务约束包括领域对象的验证规则、领域事件的处理等。模块内附有详细的领域模型文档，助力团队深入了解业务逻辑。
server	宿主服务，应用程序的启动点。负责整合其他模块，并提供应用程序的入口。涉及配置依赖项、连接数据库、启动 API 服务等任务。此外，server 模块提供了容器化部署的支持，包括 Docker 构建镜像和 Kubernetes 部署文件，简化了部署过程。
client	客户端库，使用 fetcher-generator 自动生成的 TypeScript 客户端库，提供类型安全的 API 调用接口，方便前端或其他服务与后端交互。支持自动生成命令客户端和查询客户端，包含完整的类型定义和错误处理。
code-coverage-report	测试覆盖率，用于生成详细的测试覆盖率报告，以及验证覆盖率是否符合要求。帮助开发团队了解项目测试的全面性和质量。
dependencies	依赖项管理，这个模块负责管理项目的依赖关系，确保各个模块能够正确地引用和使用所需的外部库和工具。
bom	项目的 BOM（Bill of Materials）
libs.versions.toml	依赖版本配置文件，明确了项目中各个库的版本，方便团队协作和保持版本的一致性。
deploy	Kubernetes 部署文件，提供了在 Kubernetes 上部署应用程序所需的配置文件，简化了部署过程。
Dockerfile	server Docker 构建镜像，通过 Dockerfile 文件定义了应用程序的容器化构建步骤，方便部署和扩展。
document	项目文档，包括 UML 图和上下文映射图，为团队成员提供了对整个项目结构和业务逻辑的清晰理解。

创建项目

点击上方按钮，基于 Wow 项目模板 创建新仓库，然后克隆到本地即可开始编写领域模型。

• 修改 settings.gradle.kts 文件，将 rootProject.name 修改为项目名称
• 修改 api/{package}/DemoService
• 修改 domain/{package}/DemoBoundedContext

Git

git init
git remote add origin <your-repo-url>
# 如果远端仓库有内容，需要先拉取
git pull origin master
# gradlew 脚本被注释，需要重新从模板项目中Copy过来
chmod +x gradlew
# 清理构建目录
gradle clean
git add .
git commit -m "Initial commit"
# 推送到远端仓库
git push -u origin master

启动服务

访问：http://localhost:8080/swagger-ui.html

使用客户端

客户端库提供类型安全的 API 调用接口，支持命令和查询操作。

1. 生成客户端代码：

   cd client
   pnpm install
   pnpm generate

2. 构建客户端库：

   pnpm build

3. 在项目中使用：

   import { DemoCommandClient, demoQueryClientFactory } from '@ahoo-wang/wow-client';
   const demoCommandClient = new DemoCommandClient()
   // 发送命令
   await demoCommandClient.createDemo({ /* 参数 */ });
   
   const demoQueryClient = demoQueryClientFactory.createSnapshotQueryClient()
   // 查询数据

   详细使用说明请参考 client/README.md。

验证测试覆盖率

./gradlew domain:jacocoTestCoverageVerification

查看测试覆盖率报告：domain/build/reports/jacoco/test/html/index.html

CI/CD 流水线

测试阶段

代码风格检查(Check CodeStyle)

./gradlew detekt

领域模型单元测试 (Check Domain)

./gradlew domain:check

测试覆盖率验证(Check CodeCoverage)

./gradlew domain:jacocoTestCoverageVerification

构建阶段

生成部署包 (Build Server)

./gradlew server:installDist

发布 Docker 镜像 (Push Image)

Dockerfile

docker login --username=<username> --password=<******> <registry>
docker build -t <registry>/<image>:<tag> server
docker push <registry>/<image>:<tag>

部署阶段

部署到 Kubernetes (Deploy Kubernetes)

deploy

kubectl apply -f deploy

流水线配置（阿里云效）

sources:
  repo:
    type: codeup
    name: Wow 项目模板代码源
    endpoint: <your-project-repo>
    branch: main
    certificate:
      type: serviceConnection
      serviceConnection: <your-service-connection-id>
stages:
  test:
    name: "测试"
    jobs:
      code_style:
        name: "Check CodeStyle"
        runsOn: public/cn-hongkong
        steps:
          code_style:
            name: "代码风格检查"
            step: "JavaBuild"
            runsOn: public/
            with:
              jdkVersion: "17"
              run: ./gradlew detekt

      test:
        name: "Check Domain"
        runsOn: public/cn-hongkong
        steps:
          test:
            name: "Check Domain"
            step: "GradleUnitTest"
            with:
              jdkVersion: "17"
              run: ./gradlew domain:check
              reportDir: "domain/build/reports/tests/test"
              reportIndex: "index.html"
          coverage:
            name: "Check CodeCoverage"
            step: "JaCoCo"
            with:
              jdkVersion: "17"
              run: ./gradlew domain:jacocoTestCoverageVerification
              reportDir: "domain/build/reports/jacoco/test/html"
  build:
    name: "构建"
    jobs:
      build:
        name: "Build Server And Push Image"
        runsOn: public/cn-hongkong
        steps:
          build:
            name: "Build Server"
            step: "JavaBuild"
            with:
              jdkVersion: "17"
              run: ./gradlew server:installDist
          publish_image:
            name: "Push Image"
            step: "ACRDockerBuild"
            with:
              artifact: "image"
              dockerfilePath: "server/Dockerfile"
              dockerRegistry: "<your-docker-registry—url>"
              dockerTag: ${DATETIME}
              region: "cn-hangzhou"
              serviceConnection: "<your-service-connection-id>"
  deploy:
    name: "部署"
    jobs:
      deploy:
        name: "Deploy"
        runsOn: public/cn-hongkong
        steps:
          deploy:
            name: "Deploy"
            step: "KubectlApply"
            with:
              skipTlsVerify: false
              kubernetesCluster: "<your-kubernetes-id>"
              useReplace: false
              namespace: "dev"
              kubectlVersion: "1.22.9"
              yamlPath: "deploy"
              skipVariableVerify: false
              variables:
                - key: IMAGE
                  value: $[stages.build.build.publish_image.artifacts.image]
                - key: REPLICAS
                  value: 2
                - key: SERVICE_NAME
                  value: "<service-name>"

设计文档

用例图