本项目使用 COLA 架构构建,COLA 架构是一个整洁的,面向对象的,分层的,可扩展的应用架构,可以帮助降低复杂应用场景的系统熵值,提升系统开发和运维效率。不管是传统的分层架构、六边形架构、还是洋葱架构,都提倡以业务为核心,解耦外部依赖,分离业务复杂度和技术复杂度等,COLA 架构在此基础上融合了 CQRS、DDD、SOLID 等设计思想,形成一套可落地的应用架构。
参考文档请查看 WIKI 。
- eden-demo-cola-adapter:适配层,六边形架构中的入站适配器
- eden-demo-cola-app:应用层,负责 CQRS 的处理工作,接收更新指令并调用领域层,对于查询视图操作直接绕过领域层调用基础设施层
- eden-demo-cola-client:API层,对外以 jar 包的形式提供接口
- eden-demo-cola-domain:领域层,业务核心实现,不同于传统的分层架构,提供防腐层接口,不依赖基础设施层的技术实现
- eden-demo-cola-infrastructure:基础设施层,六边形架构中的出站适配器,封装技术细节,使用依赖倒置实现 Domain 暴露的防腐层接口
- eden-demo-cola-start:程序启动入口
由于 Spring Boot 2.4.x
和 Spring Boot 3.0.x
在架构层面有很大的变更,因此我们采取跟 Spring Boot 版本号一致的分支:
- 2.4.x 分支适用于
Spring Boot 2.4.x
,最低支持 JDK 1.8。 - 2.7.x 分支适用于
Spring Boot 2.7.x
,最低支持 JDK 11。 - 3.0.x 分支适用于
Spring Boot 3.0.x
,最低支持 JDK 17。
本项目默认使用 Maven 来构建,最快的使用方式是 git clone
到本地。为了简化不必要的技术细节,本项目依赖 eden-architect,本项目涉及的依赖项暂时没有发布到 Maven 中央仓库。请按下列步骤完成构建。
- 克隆 eden-architect 到本地,执行
./mvnw install
安装到本地 Maven 仓库,确保接下来的构建不会出现依赖错误。 - 构建本项目,执行
./mvnw install
即可。 - 我们提供了一些 CI/CD 平台的构建模板,例如 CODING,您可以在
.coding
找到相关示例。
假定您使用的运行环境
spring.profiles.active
为 local。
- 修改 Nacos 客户端配置,您可以查阅 Nacos Quick Start 快速搭建,请根据您的 Nacos 地址修改配置文件:bootstrap-local.yml
- 修改数据库的配置,本项目默认使用 H2 内存数据库启动,基于 Liquibase 在项目启动时自动初始化 SQL 脚本。如果您使用的是外部的 MySQL 数据库,可以从此处调整下数据库的连接信息:application-local.yml
- 本项目罗列了
Redis
缓存、RocketMQ
消息队列、Dynamic Source
动态数据源、ShardingSphere
分库分表等常用组件的使用方案,默认通过xxx.enabled
关闭自动配置。您可以根据实际情况开启配置,直接完成组件的集成。
- 在项目目录下运行
mvn install
(如果不想运行测试,可以加上-DskipTests
参数)。 - 进入
eden-demo-cola-start
目录,执行mvn spring-boot:run
或者启动Application
类。运行成功的话,可以看到Spring Boot
启动成功的界面。 - 本应用中已经实现了一个简单的
RestController
接口,可以点击 演示接口 进行测试。
项目的版本号格式为 x.y.z
的形式,其中 x 的数值类型为数字,从 0 开始取值,且不限于 0~9 这个范围。项目处于孵化器阶段时,第一位版本号固定使用 0,即版本号为 0.x.x
的格式。
- 孵化版本:0.0.1-SNAPSHOT
- 不稳定版本:1.0.0-SNAPSHOT
- 稳定版本:1.0.0