GitHub - open-cqrs/opencqrs: Java CQRS/ES Framework for the EventSourcingDB

OpenCQRS is a lightweight open source Java framework for building applications based on the CQRS (Command Query Responsibility Segregation) and Event Sourcing patterns. It includes built-in support for testing and offers optional Spring Boot integration to simplify configuration and production deployment. OpenCQRS is based on EventSourcingDB, a third-party event store, and provides a Java client SDK for it.

Installation

OpenCQRS is available directly from Maven Central. A running instance of the EventSourcingDB is required as event store. Spring Boot developers must add the following dependencies to their project in order to start developing and testing OpenCQRS applications:

Maven (pom.xml)

<dependencies>
    <dependency>
        <groupId>com.opencqrs</groupId>
        <artifactId>framework-spring-boot-starter</artifactId>
        <version>{{version}}</version>
    </dependency>
    <dependency>
        <groupId>com.opencqrs</groupId>
        <artifactId>framework-test</artifactId>
        <version>{{version}}</version>
        <scope>test</scope>
    </dependency>
</dependencies>

Gradle (build.gradle.kts)

dependencies {
    implementation("com.opencqrs:framework-spring-boot-starter:{{version}}")
    testImplementation("com.opencqrs:framework-test:{{version}}")
}

Make sure to configure a proper Spring Boot application name and the connection settings for the event store, i.e. within your src/main/resources/application.yml:

spring.application.name: sample-app

esdb:
  server:
    uri: http://localhost:3000
    api-token: <secret>

Usage

OpenCQRS provides the following core capabilities to support the development of robust CQRS/ES-based systems:

Command Handling

Define annotation based command handlers for implementing business logic and publishing new events:

public record PurchaseBookCommand(String isbn, String author, String title, long numPages) implements Command {

    @Override
    default String getSubject() {
        return "/book/" + isbn();
    }
}

public record BookPurchasedEvent(String isbn, String author, String title, long numPages) {}

@CommandHandlerConfiguration
public class BookHandling {

    @CommandHandling
    public String purchase(PurchaseBookCommand command, CommandEventPublisher<Book> publisher) {
        publisher.publish(
                new BookPurchasedEvent(command.isbn(), command.author(), command.title(), command.numPages()));

        return command.isbn();
    }
}

State Rebuilding

Define annotation based state rebuilding handlers for reconstructing command model state:

public record Book(String isbn, long numPages) {}

@CommandHandlerConfiguration
public class BookHandling {

    @StateRebuilding
    public Book on(BookPurchasedEvent event) {
        return new Book(event.isbn(), event.numPages());
    }
}

Testing Command Logic

Test command handling logic using the built-in test fixture support:

@CommandHandlingTest
public class BookHandlingTest {

    @Test
    public void canBePurchased(@Autowired CommandHandlingTestFixture<PurchaseBookCommand> fixture) {
        fixture.given()
                .nothing()
                .when(new PurchaseBookCommand("4711", "JRR Tolkien", "LOTR", 435))
                .succeeds()
                .allEvents()
                .exactly(new BookPurchasedEvent("4711", "JRR Tolkien", "LOTR", 435));
    }
}

Event Handling

Handle events asynchronously to decouple side effects:

@Component
public class BookCatalogProjector {

    @EventHandling("catalog")
    public void on(BookPurchasedEvent event) {
        // ...
    }
}

Looking for runnable examples?

Check out our OpenCQRS Sample Applications repository. It provides working example projects that demonstrate how to build applications using OpenCQRS.

Project Contents

This is a multi-module project. It contains the following modules:

module	description
esdb-client	Client SDK for the EventSourcingDB
esdb-client-spring-boot-autoconfigure	Spring Boot auto configurations for the ESDB client SDK
esdb-client-spring-boot-starter	Spring Boot starter for the ESDB client SDK
framework	CQRS/ES core framework (depends on esdb-client)
framework-spring-boot-autoconfigure	Spring Boot auto configurations for the CQRS/ES framework
framework-spring-boot-starter	Spring Boot starter for the CQRS/ES framework
framework-test	CQRS/ES framework test support with optional Spring support
example-application	A complete library domain example application based on OpenCQRS and Spring Boot

License

This project is licensed under Apache 2.0 – see the LICENSE file for details.

Copyright

Contributions

We welcome contributions to OpenCQRS! To ensure a smooth process and consistency with the project's direction, please contact us before starting work on a feature or submitting a pull request. This helps avoid duplicate efforts and ensures alignment.

Feel free to open issues or reach out via email – we’re happy to collaborate.

Contact

For questions or feedback, please contact the development team at opencqrs@digitalfrontiers.de.