Skip to main content

Introduction

Albanoi is an open-source library designed to assist Spring developers in implementing the Command-Query Responsibility Segregation (CQRS) pattern in their applications. The CQRS pattern is an architectural pattern that separates the responsibilities of handling command and query operations, allowing for more flexibility and scalability in an application's architecture.

The library provides a set of annotations and utility classes that help to simplify the implementation of CQRS in Spring applications. It allows developers to easily define command and query handlers.

Getting started​

If you're using spring boot, Albanoi includes a spring boot starter that can only be used by including the library on the classpath.

<dependency>
    <groupId>com.defrimhsn</groupId>
    <artifactId>albanoi-spring-boot-starter</artifactId>
    <version>0.0.2</version>
</dependency>

Once the library is in your classpath, albanoi will register its AlbanoiGateway using Spring Boot's autoconfiguration.

0.0.2 is the latest published version. The refreshed repository is preparing 0.0.3-SNAPSHOT, using Java 17+ and Spring Boot 3.5.16. To try it before publication, run ./mvnw clean install at the repository root and use 0.0.3-SNAPSHOT in your dependency.

Register each command or query handler as a Spring bean (for example, with @Component). Exactly one handler must match both the message type and the requested result type. The development starter also allows you to replace the default gateway by providing your own AlbanoiGateway bean.