1. 安装指南
环境要求
Java 8 或更高版本
Maven 3.x
安装步骤
克隆项目仓库到本地：git clone https://github.com/banq/jdonframework.git
进入项目目录：cd jdonframework
使用 Maven 构建项目：mvn clean install
构建完成后，生成的 JAR 文件将位于 target 目录下。
2. 项目的使用说明
项目概述
JdonFramework 是一个支持发布-订阅异步编程模型的领域事件框架。它允许你直接命令领域模型执行某些操作，并从领域模型中监听任何领域事件，而无需使用类似 Apache Kafka 或 RabbitMQ 的消息中间件。
主要特性
领域驱动设计 (DDD)：支持 DDD 的核心概念，如实体、值对象、聚合根和限界上下文。
CQRS 和事件溯源：通过领域事件实现 CQRS 和事件溯源。
反应式和事件驱动：将反应式和事件驱动引入领域模型，支持异步和非阻塞的事件发送和接收。
单写原则：通过单写原则保护聚合根的内部状态，确保状态更新在非阻塞的单线程方式下进行。
项目架构
JdonFramework 采用生产者/消费者模式，生产者通过 LMAX Disruptor 的 RingBuffer 异步和非阻塞地向消费者发送消息。消费者分为两种类型：
@Send --> @OnCommand：一对一队列
@Send --> @OnEvent：一对多主题
3. 项目API使用文档
核心API
@Model：标注领域模型类，表示该类是一个聚合根。
@OnCommand：标注方法，表示该方法处理命令。
@OnEvent：标注方法，表示该方法处理事件。
@Send：标注方法，表示该方法发送命令或事件。
示例代码
@Model
public class AggregateRootA {
private int state = 100;
@OnCommand("CommandtoEventA")
public Object save(ParameterVO parameterVO) {
// 更新聚合根的状态
this.state = parameterVO.getValue() + state;
return null;
}
}
事件处理
@Send("CommandtoEventA")
public void sendCommand() {
// 发送命令
}
@OnCommand("CommandtoEventA")
public void handleCommand(ParameterVO parameterVO) {
// 处理命令
}
@OnEvent("EventA")
public void handleEvent(Event event) {
// 处理事件
}
4. 项目安装方式
Maven 依赖
在项目的 pom.xml 文件中添加以下依赖：
配置文件
在 src/main/resources 目录下创建 jdonframework.properties 文件，配置相关参数：
jdon.framework.config.file=jdonframework.xml
jdon.framework.event.queue.size=1024
启动项目
通过 Maven 启动项目：
mvn spring-boot:run
总结
JdonFramework 是一个强大的领域事件框架，支持 DDD、CQRS 和事件溯源，帮助开发者实现清晰的六边形架构。通过本技术文档，用户可以快速了解并使用 JdonFramework 进行项目开发。