Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahoo-wang/wow-project-template

用于快速构建基于 Wow 框架的 DDD 项目模板。
https://github.com/ahoo-wang/wow-project-template

cqrs ddd-architecture eventsourcing eventstore kafka mongodb r2dbc reactive-programming spring-boot wow

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/ahoo-wang/wow-project-template
Owner: Ahoo-Wang
License: apache-2.0
Created: 2023-12-01T10:02:16.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-05-21T10:43:54.000Z (6 months ago)
Last Synced: 2024-05-21T12:15:03.215Z (6 months ago)
Topics: cqrs, ddd-architecture, eventsourcing, eventstore, kafka, mongodb, r2dbc, reactive-programming, spring-boot, wow
Language: Kotlin
Homepage:
Size: 718 KB
Stars: 8
Watchers: 2
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 基于 Wow 框架的 DDD 项目模版

[![codecov](https://codecov.io/gh/Ahoo-Wang/wow-project-template/graph/badge.svg?token=lvvGMBqmMh)](https://codecov.io/gh/Ahoo-Wang/wow-project-template)

用于快速构建基于 [Wow 框架](https://github.com/Ahoo-Wang/Wow) 的 DDD 项目模板。

## 模块介绍

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

## 安装模板

[IDEA 项目模板](https://www.jetbrains.com/help/idea/saving-project-as-template.html)

[IDEA 配置目录](https://www.jetbrains.com/help/idea/directories-used-by-the-ide-to-store-settings-caches-plugins-and-logs.html#config-directory)

- IDEA 项目模板目录：`/projectTemplates`
- Windows: `C:\Users\\AppData\Roaming\JetBrains\\projectTemplates\`
- Mac OS:`~/Library/Application\ Support/JetBrains//projectTemplates/`
- 将模板压缩包放到 IDEA 项目模板目录下
- 模板压缩包: https://gitee.com/AhooWang/wow-project-template/releases/download/v3.5.0/wow-project-template.zip

## 创建项目

> [使用模板创建项目](https://www.jetbrains.com/help/idea/saving-project-as-template.html#create-project-from-template)

![创建项目](./document/assets/new-project.png)

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

## 启动服务

启动服务

> 访问：[http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html)

Swagger-UI

## 验证测试覆盖率

```shell
./gradlew domain:jacocoTestCoverageVerification
```

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

Wow-CI-Flow

## CI/CD 流水线

Wow-CI-Flow

### 测试阶段

> 代码风格检查(Check CodeStyle)

```shell
./gradlew detekt
```
> 领域模型单元测试 (Check Domain)

```shell
./gradlew domain:check
```
> 测试覆盖率验证(Check CodeCoverage)

```shell
./gradlew domain:jacocoTestCoverageVerification
```
### 构建阶段

> 生成部署包 (Build Server)

```shell
./gradlew server:installDist
```

> 发布 Docker 镜像 (Push Image)

[Dockerfile](server/Dockerfile)

```shell
docker login --username= --password=<******>
docker build -t /: server
docker push /:
```

### 部署阶段

> 部署到 Kubernetes (Deploy Kubernetes)

[deploy](./deploy)

```shell [部署到 Kubernetes (Deploy Kubernetes)]
kubectl apply -f deploy
```

### 流水线配置（阿里云效）

```yaml
sources:
repo:
type: codeup
name: Wow 项目模板代码源
endpoint:
branch: main
certificate:
type: serviceConnection
serviceConnection:
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: ""
dockerTag: ${DATETIME}
region: "cn-hangzhou"
serviceConnection: ""
deploy:
name: "部署"
jobs:
deploy:
name: "Deploy"
runsOn: public/cn-hongkong
steps:
deploy:
name: "Deploy"
step: "KubectlApply"
with:
skipTlsVerify: false
kubernetesCluster: ""
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: ""
```

## 设计文档

### 用例图

Wow-UseCase