이번 포스팅부터 Query App 구현을 다루겠습니다. Query App은 Event를 수신받아 Read Model에 반영하는 Projection 작업과 Read Model을 읽는 Query 2가지로 기능이 나뉩니다. 기능별로 실제 구현 코드량은 얼마되지 않지만 알아야 하는 개념이 많으므로 먼저 Event 처리 기능 관련하여 다루고 향후에 Query 기능을 다루겠습니다.
이번 내용은 EventHandler 구현 실습전 내부 처리 과정을 살펴보겠습니다.
2. Event 처리 과정
Token Store
이전 포스팅에서 확인 하였듯이 EventStore에는 EventStream의 내용을 순차적으로 적재합니다. 따라서 수신부에서 지금까지 수신된 Event는 어디까지이며, EvenStore에서 어디서부터 Event를 수신 받아야할지에 대한 정보를 가지고 있어야합니다. 해당 정보를 Token이라고 하며, Token은 Query App과 연관된 DB 내부에 저장하여 영구적으로 관리합니다.(Token Store)
위 예시는 TokenStore에 저장된 내용입니다.Token 컬럼에는 지금까지 Tracking된 Event의 Global Sequence 값이 들어있으며, 예시를 통해 13번이 마지막으로 수신된 Event임을 알 수 있습니다.
Tracking Event Processor
TokenStore를 통해서 마지막 수신 Event 정보를 알 수 있다면, 해당 정보를 토대로 Event 수신 요청 및 처리를 담당하는 중계 역할이 필요합니다. Axon에서 제공하는 Event 처리기는 Subscribing Event Processor(SEP), Tracking Event Processor(TEP) 2가지가 있습니다. 두 Event 처리기 차이점은 이벤트 발행 쓰레드에서 Event 처리여부입니다. SEP는 Event 발행 쓰레드에서 Event 또한 처리하며, TEP는 별도 쓰레드에서 처리합니다. TEP를 이해하는 것이 중요하므로 이를 중점적으로 다루겠습니다.
3. Tracking Event Processor
위 그림은 Query App이 기동될 때 EventProcessor 생성 및 처리 과정 흐름을 간략하게 표현했습니다.
Spring DefaultLifecycleProcessor가 Start 명령을 내립니다.
Axon의 기본 설정을 담당하는 DefaultConfigurer 클래스 Start 메소드가 호출됩니다. 이후 등록된 Handler에게 수행 명령을 내립니다. 기본으로 등록된 Handler는 2개입니다.(EventProcessingModule, EventProcessorInfoConfiguration)
내부 로직을 거쳐 ProcessorInfoSource와 EventProcessorControlService를 구동합니다. ProcessorInfoSource는 AxonServer에게 EventProcessor의 현재 상태를 주기적(Default 500ms)으로 보내는 역할을 담당합니다. EventProcessorContolService는 AxonServer에서 요청시 EventProcessor를 제어하는 서비스 역할을 담당합니다. EventPRocessorControlService의 실제 로직 수행은 AxonServerConnectionManager 및 EventProcessorController가 담당합니다.
EventProcessingModule을 구동합니다. 이 과정에서 EventProcessor 생성을 요청합니다.
TrackingEventProcessor를 생성합니다. 사용자가 별도 속성 정의를 하지 않았으면, DefaultEventProcessor가 생성됩니다. (※ Thread 수 : 1개, 배치 사이즈 : 1, 최대 Thread 수 : Segment 개수, tokenClaim 주기 : 5000ms)
생성된 TrackingEventProcessor에게 구동을 요청합니다. 내부적으로 AxonThreadFactory에게 WorkerLauncher 인스턴스에 대한 Thread 생성을 요청합니다.
TrackingEventProcessor가 구동중이면 내부로직이 반복 수행될 수도록 무한 루프로 구성되어 있습니다. 만약 EventStore Segment에 변경된 내역을 확인하여 처리해야한다면, AxonThreadFactory에게 TrackingSegmentWorker 인스턴스 생성을 요청합니다.
Segment에 대한 Event 처리(ProcessingLoop)를 요청합니다.
9번 Segment Event 처리 과정을 자세히 확인하기 위해 순서도를 그리면 다음과 같습니다.
EventStream을 오픈합니다.
EventStream에서 최신 Event가 존재하는지 확인합니다. 존재하지 않는다면 Token 값을 갱신하고 작업을 종료합니다.
최신 Event를 수신받은 후 해당 App에서 처리가 가능한 Event인지 확인합니다. 만약 처리할 수 없다면 BlackList 등록이 가능한지 확인하고 이를 등록합니다. 이후 해당 Event는 MessageMonitor에 보고한 뒤 무시합니다.
처리가 가능한 Event라면 UnitOfWork를 수행합니다. 해당 과정에서 Token 값은 자동 갱신합니다. 이후 EventHandler를 찾아 메소드를 수행합니다.
Event 처리가 완료되면 작업을 종료합니다.
내부구조는 복잡하지만 이를 한줄로 요약하자면 "주기적으로 TrackingEventProcessor에서 처리가 가능한 Event가 존재하는지 확인 및 처리(UnitOfWork)하고 Token 갱신하는 작업"으로 정의할 수 있습니다.
4. Axon Server 라우팅기능(Event)
이번에는 Client가 아닌 AxonServer 입장에서 Event 전달 흐름을 살펴보도록 하겠습니다.
Query Application을 구동하면 Token 정보를 읽어옵니다. 이후 EventStore에게 자신이 보유한 Token 정보를 알려준 다음 EventStream을 오픈합니다. 위 예시에는 요청당시 EventStore에는 추가로 유입된 Event가 없으므로 Application의 Token값 변경 후 작업을 종료합니다.
만약 Command App으로부터 Event가 추가된다면, 다음 ProcessingLoop 작업에서 해당 Event를 Query App으로 전달합니다. 수신받은 App에서 해당 Event 처리 가능 여부를 확인하는데, 만약 처리하지 못할 경우는 AxonServer에게 BlackList 추가를 요청합니다. 따라서 이후 신규 적재되는 Event에 대해서는 수신받지 않습니다.
신규 App이 추가로 기동되어 AxonServer에 등록요청한 상태에서 마지막 수신 Event가 2번이라면, AxonServer에서 3번부터 해당 Event를 App으로 전달합니다.
4. 마치며
이번 포스팅에서는 EventHandler 메소드를 수행하기위해서 알아야할 내부 구조를 알아봤습니다. 다음 포스팅에서는 EventHandler 메소드 구현에 대해 다루어보겠습니다.
만약 이러한 상황에서 c65f80c3-9c44-4ca6-a977-72983a675203 식별자를 지닌 AccountAggregate 에서 1원을 인출하는 명령이 발생된다면 내부적으로는 어떠한 과정을 거칠까요?
Command 어플리케이션 구현 - 1 포스팅에서 소개한 Command 이벤트 수행 내부 흐름도입니다. 당시 4번 과정에 대해서 다음과 같이 소개했습니다.
4. UnitOfWork 수행합니다. 이 과정에서 Chain으로 연결된 handler 들을 거치면서 대상 Aggregate에 대하여EventStore로부터 과거 이벤트들을 Loading 하여 최신 상태로 만듭니다. 이후 해당 Command와 연결된 Handler 메소드를 Reflection을 활용하여 호출합니다.
즉 새로운 명령을 수행하기 위해서는 c65f80c3-9c44-4ca6-a977-72983a675203 식별자를 지닌 Aggregate를 대상으로 기존에 발행된 7개의 이벤트를 EventStore에서 읽어와 Loading하는 작업이 선행됩니다. 그 결과 최신 상태로 Aggregate를 만든 이후에 새 Command 적용 및 Event를 발생시킵니다.
이를 통해 알 수 있는 사실은 동일 Aggregate에 대해서 Event 갯수가 늘어날 수록 새로운 Command를 적용하는데 오랜 시간이 소요된다는 점입니다.
3. 개선 방안(Snapshot)
EventSourcing 패턴을 적용하는 Application에는 이전 단계에서 확인한 근본적인 문제점을 안고 있습니다. 따라서 이를 완화하기 위해서 일정 주기별로 Aggregate에 대한 Snapshot을 생성해야합니다.
Snapshot이란 특정 시점의 Aggregate의 상태를 말합니다. 일반적으로 EventStore에는 Aggregate의 상태를 저장하지 않고 이벤트만 저장합니다. 하지만 특정 시점의 Aggregate의 상태를 저장하여 Loading 과정에서 Snapshot 이후 Event만 Replay하여 빠르게 Aggregate Loading이 가능합니다.
AxonFramework에서도 Configuration 설정을 통해서 Aggregate 별로 Snapshot 설정이 가능합니다. Snapshot 설정에는 특정 Threshold를 넘어가면 생성되며, Snapshot 적용 예제를 통해 문제점을 완화해보도록 하겠습니다.
1. Command 모듈 AxonConfig 파일을 오픈합니다.
2. AxonConfig 클래스에 내용을 추가합니다.
AxonConfig.java
@Configuration
@AutoConfigureAfter(AxonAutoConfiguration.class)
public class AxonConfig {
@Bean
SimpleCommandBus commandBus(TransactionManager transactionManager){
return SimpleCommandBus.builder().transactionManager(transactionManager).build();
}
@Bean
public AggregateFactory<AccountAggregate> aggregateFactory(){
return new GenericAggregateFactory<>(AccountAggregate.class);
}
@Bean
public Snapshotter snapshotter(EventStore eventStore, TransactionManager transactionManager){
return AggregateSnapshotter
.builder()
.eventStore(eventStore)
.aggregateFactories(aggregateFactory())
.transactionManager(transactionManager)
.build();
}
@Bean
public SnapshotTriggerDefinition snapshotTriggerDefinition(EventStore eventStore, TransactionManager transactionManager){
final int SNAPSHOT_TRHRESHOLD = 5;
return new EventCountSnapshotTriggerDefinition(snapshotter(eventStore,transactionManager),SNAPSHOT_TRHRESHOLD);
}
@Bean
public Repository<AccountAggregate> accountAggregateRepository(EventStore eventStore, SnapshotTriggerDefinition snapshotTriggerDefinition){
return EventSourcingRepository
.builder(AccountAggregate.class)
.eventStore(eventStore)
.snapshotTriggerDefinition(snapshotTriggerDefinition)
.build();
}
}
위 코드는 AccountAggregate 기준으로 Snapshot을 설정하도록 작성된 코드입니다. SnapshotTriggerDefinition을 통하여 Aggregate의 발행된 Event가 5개 이상일 경우 Snapshot을 생성하도록 지정하였습니다. Threshold 값에는 얼마를 지정 해야한다는 기준은 없으며, 비즈니스 로직에 따라 생성 주기를 조절하면 됩니다.
Snapshot 설정을 완료한 다음 Application을 재시작 한다음 다시 API 테스트를 하면 수행 당시에는 Snapshot이 존재하지 않기 때문에 전체를 Loading 합니다. 이때 Event를 적용하는 과정에서 Threshold 값을 넘었기 때문에 EventStore에 Snapshot을 새롭게 생성합니다.
Snapshot 생성 이후 다시 1원을 인출하게되면, 이전 시퀀스 번호인 8번 Snaphot이 존재하므로 전체 Event를 읽어오지 않고 Snapshot정보를 읽어온 다음 Command 명령을 수행합니다.
o.a.commandhandling.SimpleCommandBus : Handling command [com.cqrs.command.commands.WithdrawMoneyCommand]
org.axonframework.messaging.Scope : Clearing out ThreadLocal current Scope, as no Scopes are present
c.c.command.aggregate.AccountAggregate : handling WithdrawMoneyCommand(accountID=c65f80c3-9c44-4ca6-a977-72983a675203, holderID=70f956e3-069c-4666-b0f4-324dfb0a807e, amount=1)
c.c.command.aggregate.AccountAggregate : applying WithdrawMoneyEvent(holderID=70f956e3-069c-4666-b0f4-324dfb0a807e, accountID=c65f80c3-9c44-4ca6-a977-72983a675203, amount=1)
c.c.command.aggregate.AccountAggregate : balance 292
org.axonframework.messaging.Scope : Clearing out ThreadLocal current Scope, as no Scopes are present
Snapshot 생성 이후 5번의 Event 발생까지는 Snapshot 시점 이전부터 생성된 Event가 재생됩니다. 만약 다시 Threshold를 넘어서게 되면 새로운 Snapshot이 생성되고 그 이후부터는 새로운 Snapshot 이후 Event가 재생됩니다.
4. 성능개선
Aggregate를 매번 로딩하면 이를 복원하는데 드는 비용이 지속 수반됩니다. 따라서 자주 사용하는 Aggregate는 Cache를 적용하면 Loading 비용이 줄어들 것입니다. Axon에서 이를 위해 기본적으로 WeakReferenceCache를 제공하며 이를 적용한 Configuration은 다음과 같습니다.
AxonConfig.java
@Configuration
@AutoConfigureAfter(AxonAutoConfiguration.class)
public class AxonConfig {
@Bean
public AggregateFactory<AccountAggregate> aggregateFactory(){
return new GenericAggregateFactory<>(AccountAggregate.class);
}
@Bean
public Snapshotter snapshotter(EventStore eventStore, TransactionManager transactionManager){
return AggregateSnapshotter
.builder()
.eventStore(eventStore)
.aggregateFactories(aggregateFactory())
.transactionManager(transactionManager)
.build();
}
@Bean
public SnapshotTriggerDefinition snapshotTriggerDefinition(EventStore eventStore, TransactionManager transactionManager){
final int SNAPSHOT_TRHRESHOLD = 5;
return new EventCountSnapshotTriggerDefinition(snapshotter(eventStore,transactionManager),SNAPSHOT_TRHRESHOLD);
}
@Bean
public Cache cache(){
return new WeakReferenceCache();
}
@Bean
public Repository<AccountAggregate> accountAggregateRepository(EventStore eventStore, SnapshotTriggerDefinition snapshotTriggerDefinition, Cache cache){
return CachingEventSourcingRepository
.builder(AccountAggregate.class)
.eventStore(eventStore)
.snapshotTriggerDefinition(snapshotTriggerDefinition)
.cache(cache)
.build();
}
}
5. 마치며
3개의 포스팅을 통해 Command Application을 구현하는 방법에 대해서 살펴보았습니다. 다음 포스팅은 Aggregate 관련 번외편을 진행할 예정입니다. 따라서 데모 프로젝트를 위한 Application 구현은 이번 포스팅이 마지막입니다.
@Service
@RequiredArgsConstructor
public class TransactionServiceImpl implements TransactionService {
private final CommandGateway commandGateway;
@Override
public CompletableFuture<String> createHolder(HolderDTO holderDTO) {
return commandGateway.send(new HolderCreationCommand(UUID.randomUUID().toString()
, holderDTO.getHolderName()
, holderDTO.getTel()
, holderDTO.getAddress()));
}
@Override
public CompletableFuture<String> createAccount(AccountDTO accountDTO) {
return commandGateway.send(new AccountCreationCommand(accountDTO.getHolderID(),UUID.randomUUID().toString()));
}
@Override
public CompletableFuture<String> depositMoney(DepositDTO transactionDTO) {
return commandGateway.send(new DepositMoneyCommand(transactionDTO.getAccountID(), transactionDTO.getHolderID(), transactionDTO.getAmount()));
}
@Override
public CompletableFuture<String> withdrawMoney(WithdrawalDTO transactionDTO) {
return commandGateway.send(new WithdrawMoneyCommand(transactionDTO.getAccountID(), transactionDTO.getHolderID(), transactionDTO.getAmount()));
}
}
Service 구현 코드를 보면 직관적으로 이해할 수 있듯이 CommandGateway를 통해 Command를 생성 합니다. 이는 지난 포스팅에서 다룬 Command 수행 내부 흐름 첫번째 단계에 해당합니다.
참고로 CommandGateway에서 제공되는 API는 크게 두 가지로 첫째는 위 소스코드에서 사용한 send 메소드이고 나머지는 sendAndWait 메소드입니다. send 메소드는 비동기 방식이며, sendAndWait은 동기 방식의 메소드입니다. 동기 방식의 메소드는 default가 응답이 올때까지 대기하며 이는 호출 후 hang 상태가 지속되면 스레드 고갈이 일어날 수 있습니다. 따라서 메소드 파라미터에 timeout을 지정하여 실패 처리할 수 있습니다. 자세한 내용은 Axon 공식 문서를 참고 바랍니다.
4. Controller 구현
Controller를 통해 API 매핑작업을 수행합니다.
1. controller 패키지 만든 후 controller 클래스를 생성합니다.
2. Controller 클래스를 구현합니다.
@RestController
@RequiredArgsConstructor
public class TransactionController {
private final TransactionService transactionService;
@PostMapping("/holder")
public CompletableFuture<String> createHolder(@RequestBody HolderDTO holderDTO){
return transactionService.createHolder(holderDTO);
}
@PostMapping("/account")
public CompletableFuture<String> createAccount(@RequestBody AccountDTO accountDTO){
return transactionService.createAccount(accountDTO);
}
@PostMapping("/deposit")
public CompletableFuture<String> deposit(@RequestBody DepositDTO transactionDTO){
return transactionService.depositMoney(transactionDTO);
}
@PostMapping("/withdrawal")
public CompletableFuture<String> withdraw(@RequestBody WithdrawalDTO transactionDTO){
return transactionService.withdrawMoney(transactionDTO);
}
}
Controller 클래스는 단순히 전달받은 DTO를 Service에 전달하는 역할만 수행하므로 자세한 설명은 생략합니다. 이로써 Command Application 기본 코드 작성은 끝났습니다.
5. Log 설정
Command, EventSourcing Handler 메소드가 수행되는 상황을 분석하기 위해서 Logging 설정을 진행합니다.
1. resource 폴더 및 application.yml 파일을 연다음 logging 설정을 추가합니다.
Command Application API 테스트를 수행하기 위한 코드를 작성합니다. API 테스트를 위해 Postman을 비롯하여 여러 툴이 있지만, IntelliJ의 http 기능을 사용해서 테스트를 진행하도록 하겠습니다.
1. Command 모듈 적절한 위치에 http 확장자로 끝나는 파일을 생성합니다.
2. http 코드를 작성합니다.
POST http://localhost:8080/holder
Content-Type: application/json
{
"holderName" : "kevin",
"tel" : "02-1234-5678",
"address" : "OO시 OO구"
}
###
POST http://localhost:8080/account
Content-Type: application/json
{
"holderID" : "계정 생성 후 반환되는 UUID"
}
###
POST http://localhost:8080/deposit
Content-Type: application/json
{
"accountID" : "계좌 생성 후 반환되는 UUID",
"holderID" : "계정 생성 후 반환되는 UUID",
"amount" : 300
}
###
POST http://localhost:8080/withdrawal
Content-Type: application/json
{
"accountID" : "계좌 생성 후 반환되는 UUID",
"holderID" : "계정 생성 후 반환되는 UUID",
"amount" : 10
}
###
7. API 테스트
1. AxonServer가 기동된 상태에서 Command App을 수행합니다. 혹시 Axon Server 기동 방법이 궁금하신 분은 AxonServer 설치 및 실행 포스팅을 참고 바랍니다.
2. http 파일에서 계정 생성 url에 커서를 위치 시킨다음 [Alt + Enter] 키를 누릅니다.
3. Run Localhost:8080 버튼을 눌러 API를 실행합니다.
4. 정상 실행결과 및 반환된 계정 식별자 값을 확인합니다.
또한 위 그림과 같이 Application 로그에도 정상적으로 CommandHanlder 및 EventSourcingHandler 메소드가 수행된 것을 확인할 수 있습니다.
8. 성능 개선
데모 프로젝트에서는 Command 명령 생성과 이를 처리하는 Command Handler를 하나의 App에 모두 구현하였음에도 불구하고 위 Application에서는 Command 발행 시 Axon Server와의 통신을 수행합니다. 이는 AxonServer와 연결시 기본적으로 CommandBus로써 AxonServerCommandBus를 사용하기 때문입니다.
이를 개선하기 위해서는 Command 처리시 AxonServer 연결없이 명령을 처리하도록 변경이 필요합니다. AxonFramework에서는 SimpleCommandBus 클래스를 제공하며, 설정을 통해 CommandBus 인터페이스 교체가 가능합니다.
설정 변경을 통해 Command Bus를 변경하도록 하겠습니다.
1. Command 모듈에config패키지 생성 후AxonConfig클래스를 생성합니다.
2. AxonConfig 클래스를 구현합니다.
AxonConfig.java
@Configuration
@AutoConfigureAfter(AxonAutoConfiguration.class)
public class AxonConfig {
@Bean
SimpleCommandBus commandBus(TransactionManager transactionManager){
return SimpleCommandBus.builder().transactionManager(transactionManager).build();
}
}
AxonFramework는 기본적으로 AxonAutoConfiguration 클래스를 통해 Default 속성을 정의합니다. Custom 속성을 추가하기 위해 Axon 기본 설정이 완료된 후 수행될 수 있도록@AutoConfigureAfter어노테이션을 추가했습니다.
3. Application 수행 후 테스트하면 CommandBus가 SimpleCommandBus로 교체된 것을 확인할 수 있습니다.
@AllArgsConstructor
@ToString
@Getter
public class AccountCreationCommand {
@TargetAggregateIdentifier
private String holderID;
private String accountID;
}
DepositMoneyCommand.java
@AllArgsConstructor
@ToString
@Getter
public class DepositMoneyCommand {
@TargetAggregateIdentifier
private String accountID;
private String holderID;
private Long amount;
}
WithdrawMoneyCommand.java
@AllArgsConstructor
@ToString
@Getter
public class WithdrawMoneyCommand {
@TargetAggregateIdentifier
private String accountID;
private String holderID;
private Long amount;
}
Event와 달리 Command 클래스에는 @TargetAggregateIdentifier 어노테이션이 붙었습니다. 이는 AxonFramework 모델링의 단위가 Aggregate이고 각 Aggregate마다 고유한 식별자가 부여되어야 하기 때문입니다. 따라서 Command 클래스를 디자인 할때에도 어떤 Aggregate를 대상으로 명령을 수행할 것인지 알아야 하기 때문에 대상 Aggregate의 식별자 지정이 필요합니다.
4. Aggregate 구현
도메인 주도 개발 방법론(DDD)을 배우면 반드시 등장하는 개념이 Aggregate입니다. AxonFramework 에서도 DDD 기반으로 설계되었기에 Aggregate가 필요합니다. 데모 프로젝트에서는 Holder와 Account 연관된 Aggregate를 구현하도록 하겠습니다.
@RequiredArgsConstructor
@Aggregate
public class HolderAggregate {
@AggregateIdentifier
private String holderID;
private String holderName;
private String tel;
private String address;
}
AccountAggregate.java
@RequiredArgsConstructor
@Aggregate
public class AccountAggregate {
@AggregateIdentifier
private String accountID;
private String holderID;
private Long balance;
}
Aggregate 클래스에는 클래스 위에 Aggregate임을 알려주는 Annotation을 추가합니다. 또한 Aggregate 별로 식별자가 반드시 존재해야되기 때문에 유일성을 갖는 대표키 속성에 @AggregateIdentifier을 추가합니다.
AxonFramework 에서는 모든 명령(Command)과 이벤트(Event)가 Aggregate에서 발생합니다. 따라서 Aggregate에 대한 명령과 이벤트를 처리할 수 있는 Handler 메소드 작성이 필요합니다. 또한 기본적으로 Event Sourcing 패턴을 사용하기 때문에 명령이 발생한 Event를 적용하는 단계가 필요합니다.
Handler는 대개 Aggregation 클래스에서 정의하며, 외부 클래스에서 별도 정의도 가능합니다. 데모에서는 Aggregate에서 정의하는 방법을 사용할 것이며 외부 정의 방식은 Axon 공식 문서를 참조 바랍니다.
AxonFramework를 사용함에 있어 주로 사용하는 Handler Annotation은 다음과 같습니다.
@CommandHandler : Aggregate에 대한 명령이 발생되었을 때 호출되는 메소드임을 알려주는 마커 역할
@EventSourcingHandler : CommandHandler에서 발생한 이벤트를 적용하는 메소드임을 알려주는 마커 역할
@EventHandler : Query 모델 혹은 이벤트 발생시 해당 이벤트를 적용하는 메소드임을 알려주는 마커 역할
HolderAggregation 클래스를 대상으로 계정 생성 명령(HolderCreationCommand)과 이로인해 발생하는 계정 생성 이벤트(HolderCreationEvent) 처리하는 Handler 메소드를 작성하면 다음과 같습니다.
소스코드를 보면 @CommandHandler와 @EventSourcingHandler 어노테이션이 추가된 것을 확인할 수 있습니다.
먼저 CommandHandler 메소드부터 살펴보겠습니다. 위 코드에서 CommandHandler는 생성자에 추가되었습니다. 이는 계정 생성 명령은 곧 HolderAggregate의 생성을 의미하는 것이기 때문입니다. 해당 메소드 안에 apply는 AggregateLifeCycle 클래스의 static 메소드이며, 해당 메소드를 통해서 이벤트를 발행합니다.
EventSourcingHandler 메소드는 CommandHandler에서 기존에 발행된 이벤트 및 현재 발생한 Command 이벤트를 적용하는 역할을 수행합니다.
위 그림은 HolderCreationCommand 명령이 발생되었을 때, 수행되는 내부 흐름을 간략하게 표현했습니다.
사용자로부터 Command 명령을 CommandGateway로 전달하면, 메시지 변환 과정(GenericCommandMessage)을 거쳐 CommandBus로 전달합니다.
CommandBus는 Command 명령을 Axon Server로 전송합니다.
AxonServer에서 명령을 Command Bus를 통해 해당 Command를 처리할 App에게 전달합니다.
UnitOfWork(4~7 단계)를 수행합니다. 이 과정에서 Chain으로 연결된 handler 들을 거치면서 대상 Aggregate에 대하여 EventStore로부터 과거 이벤트들을 Loading 하여 최신 상태로 만듭니다. 이후 해당 Command와 연결된 Handler 메소드를 Reflection을 활용하여 호출합니다.
CommandHandler 메소드를 호출하는 과정에서 apply 메소드 호출을 통해 이벤트(HolderCreationEvent)를 발행합니다.
발행된 Event는 내부 로직을 거치면서 Event 처리를 수행할 Handler를 매핑한 후 EventSourcingHandler 메소드를 Reflection을 활용하여 호출합니다.
EventSourcingHandler 호출이 완료되면, EventBus를 통해 Event 발행을 요청합니다.(publish)
코드를 보면 모든 예외 처리 및 유효성 검증을 CommandHandler에서 하고 있습니다. 이는 EventStore에 적재된 모든 Event는 재생해야할 대상이기 때문에 EventSourcingHandler에서는 Replay만 수행합니다. 따라서 CommandHandler에서 사전 Exception 처리 및 유효성 검증을 통해서 검증된 Event만을 발행해야합니다.
5. Axon Server 라우팅 기능(Command)
지금까지 AxonFramework를 사용하는 Client 입장에서 동작 원리를 살펴봤습니다. 이번에는 Server 입장에서 메시지 라우팅이 어떻게 이루어지는지 살펴보도록 하겠습니다.
상황 1. Command를 처리하는 Handler가 하나만 Axon Server에 등록된 경우
Application 기동시 AxonServer와 연결을 시도합니다. 연결이 완료되면, 해당 App은 자신이 처리가능한 Command Handler 정보를 Server에 등록합니다.
이때 다른 App에서 Command 명령을 요청하게되면 AxonServer에서는 해당 Command를 수행할 수 있는 App을 알기 때문에 해당 App으로 Command 명령을 전달합니다.
상황2. 동일한 Command를 처리하는 Handler가 복수개 등록된 경우
동일한 Command A를 처리할 수 있는 Handler 메소드를 포함하는 App이 복수개로 등록되었을 경우 내부 흐름은 다음과 같습니다.
Axon Server에서는 Command가 도착할 경우 어떤 App에서 수행해야할지를 결정 해야합니다. 따라서 이를 위해 라우팅 테이블에 두 App의 정보를 등록합니다.
라우팅 테이블에는 어떤 노드들이 Server와 연결되어있고, 해당 노드들이 어떤 Command를 처리할 수 있는지에 대한 정보가 담겨있습니다. 내부 아키텍처는 Consistenet Hashing 기법을 사용하고 있으며, 관련 설명은charsyam 님 블로그를 참고바랍니다.
이러한 상황에서 새로운 App에서 A Command를 요청했다면, 해당 요청 속에 포함된 라우팅 키를 찾아 라우팅 테이블에서 적합한 App을 선정하여 호출하게 됩니다. 그렇기에 Client Side 모델 데이터가 Sharding 되어있거나 고가용성을 위해 Cluster로 App을 구축했더라도 Command 명령은 정확히 하나의 App Command Handler에만 전달됩니다.
라우팅 키는 @TargetAggregateIdentifier 혹은 @RoutingKey 어노테이션을 Command에 포함시에 자동으로 생성됩니다.
6. 마치며
이번 포스팅에서는 Event, Command, Aggregate 모델을 구현했습니다. 다음 시간에는 API 구현 및 테스트를 통해서 실제 동작하는 과정에대해 알아보도록 하겠습니다.
Tip)
1. AxonServer에 저장된 Event 내역은 DashBoard에서 Search 항목을 누르면 조회할 수 있습니다.
2. Dashboard Commands 탭에서는 등록된 Command Handler 정보 및 현재 수행중인 Command 발생 빈도를 확인할 수 있습니다.
3. Command 명령이 발생하면 내부적으로는 몇차례 Command 메시지 변환 과정을 거쳐 부가적인 정보가 추가됩니다.
9. Axon Server 연동 테스트를 위해 QueryApplication 클래스에EventHandler메소드를 추가합니다.
(※ Command와 마찬가지로 연동 테스트 이후 해당 메소드는 삭제합니다.)
10. Query 모듈을 실행합니다. App이 정상적으로 실행되고, AxonServer 연결과 이벤트 추적을 위한 TrackingEventProcessor가 할당된 것을 확인합니다.
11. Axon Server 대시보드(http://localhost:8024) Overview 화면에서 기존에 연결된 Command App과 새로 연결된 Query App 토폴로지를 확인합니다.
12. 테스트를 위해 Command, Query 모듈에 작성한 핸들러 메소드를 삭제합니다.
3. 마치며
이번 포스팅을 통해서 AxonFramework의 기본 설정 및 Axon Server와의 연동을 살펴보았습니다. 하지만 중간에 등장한 CommandHandler, EventHandler, CommandBus, TrackingEventProcessor 등의 용어는 아직 생소합니다. 다음 포스팅부터는 본격적으로 Command, Query 프로그램 작성하면서 위 개념등을 살펴보겠습니다.
지금부터 EventSourcing과 CQRS가 적용된 프로젝트를 구현하면서 AxonFramework 사용법을 배워봅니다.
이에 앞서 앞으로 진행할 프로젝트에 대한 설계를 통해 구조를 잡아보겠습니다.
프로그램 요구사항
계정 생성시 소유주, 전화번호, 주소를 입력한다.
계정 생성이 완료되면, 계정 ID가 발급된다.
계좌 생성시, 계정 ID를 입력한다.
계좌 생성이 완료되면 고유한 계좌 번호를 반환한다.
계좌번호를 통해서 입금 가능하다.
계좌번호를 통해서 출금 가능하다.
인출과정에서 잔액이 부족한경우 "잔액이 부족합니다." 메시지를 출력한다.
소유자가 보유한 전체 계좌 개수 및 잔액 조회가 가능하다.
2. 프로그램 설계
앞으로 구현할 프로그램은 간단한 은행 입출금 관련 데모입니다. 짧은 요구사항이지만 도메인이 복잡해진다면 계좌 관리(Account)와 거래(Transacation)는 별도 Bounded Context로 분리할 수 있습니다. 하지만 데모 프로젝트에서는 편의상 두 도메인을 하나의 Bounded Context에 구현하겠습니다.
CQRS
AxonFramework는 기본적으로 CQRS 아키텍처를 따르므로, 데모도 마찬가지로 해당 구조를 기반으로 설계했습니다. 즉 Command 와 Query App을 분리하고 각 App별로 DB를 사용하도록 구성했습니다.
편의상 두 App의 DB는 Postgresql로 통일하였으며, 각기 다른 스키마 사용을 통해 두 DB를 논리적으로 분리했습니다. Command DB는 AxonFramework에서 내부적으로 사용하는 saga, token, association_value 데이터를 관리합니다.
(※ Read 모델은 MongoDB로 구성하는 등의 Polyglot 구조 변경 가능합니다.)
또한 이미 앞선 장을 통해서 EventStore 및 메시지 라우팅을 담당하는 AxonServer를 사용하고 있으므로 이는 고려하지 않겠습니다.
다이어그램
데모에서 사용되는 구조는 다음과 같습니다. Command 모델은 소유주(holder)와 계좌(accont)로 나뉘어 Aggregation을 만들었습니다. 반면 Query 모델은 소유주의 전체 계좌의 총액을 보여주도록 Materialized View 를 ERD로 표현했습니다.
Command
Aggregate
Query
Materialized Viewsummary
Command, Event 도출
이벤트 주도 개발 방법에서 가장 중요한 것은 이벤트 설계입니다. 이때 Event Storming 전략을 사용하여 Command, Event 등을 도출합니다.
(※ Event Storming 단계에서 포스트잇을 사용하는데, 비슷한 느낌을 주기 위해서 이미지를 사용했습니다.)
계정 생성
계좌 생성
입금
출금
서비스 EndPoint 설계
다음은 Controller 매핑되는 API EndPoint를 설계하겠습니다.
참고로 Command App은 8080 , Query App은 9090 Port를 사용했습니다.
계정 생성
POST : localhost:8080/holder
{
"holderName" : 소유주,
"tel" : 전화번호,
"address" : 주소
}
계좌 생성
POST : localhost:8080/account
{
"holderID" : 계정 ID
}
EventSourcing, CQRS 관련하여 Java 진영에서 사용되는 프레임워크를 검색한 결과, 크게 AxonFramework랑 Eventuate 두 가지를 주로 사용되고 있었습니다.
저는 그 중 대중적이고 Spring Boot에 친화적인(?) AxonFramework를 선정하여 공부한 흔적을 남겨보고자 합니다. 포스팅 중간 AxonIQ 기술 블로그 및 웨비나 자료 첨부는 원저작자에게 사용허가를 받았음을 알립니다.
2. Axon Framework 소개
출처 : https://youtu.be/GEN0jRkyEtU
Axon Framework는 2010년 최초 프로젝트가 시작되었으며, 2015년 이전까지는 관심도가 미비하였지만 이후 MSA가 열풍을 불게되면서 다운로드 수가 폭발적으로 증가하였습니다. 지금은 대략 월간 10만건 정도의 다운로드 수를 기록하고 있으며, 앞으로 점점 더 증가할 것으로 기대하고 있습니다.
해당 제품은 오픈소스로써 네덜란드에서 설립된 AxonIQ 회사에서 개발을 주도하고 있습니다. 주력 제품으로는 DDD, EventSourcing, CQRS를 구현할 수 있는 AxonFramework와 EventStore, 마이크로 서비스간 메시지 Routing을 담당하는 Axon Server 입니다.
(※ Axon Server는 Enterprise 버전이 별도로 있으며, 구매시 Cluster 구성 및 Security 설정 등이 가능합니다.)
기본적으로 CQRS 구조를 따르고 있습니다. 즉 외부로부터 명령(Command)이 들어오면, 해당 명령에 대한 이력을 EventStore에 저장하고 동시에 Event를 발생시킵니다.
발생된 이벤트는 EventHandler를 통하여 Read Model에 반영되고, 사용자 입장에서는 Read Model에 대한 Query를 통하여 데이터를 읽는 구조입니다.
(※ 사용자 편의에 따라 Command와 Query Model은 동일 DBMS에 설정할 수도 분리할 수도 있으며, 종류 또한 다르게 구성할 수 있습니다.)
앞으로 IntelliJ IDE를 사용해서 Spring Boot 기반 AxonFramework을 활용하여 EventSourcing, CQRS, Saga 등을 구현하는 방법에 대해서 포스팅을 진행하려고 합니다.
AxonFramework가 DDD(Domain Driven Development), EDD(Event Driven Development)에 기반하고 있으나 샘플코드를 간략하게 작성하기 위해서 DDD스러움은 배제하고(개발 실력, 도메인 지식 부족으로 인한 getter 남용 등....) Axon 제공 기능에 집중하여 소개하도록 하겠습니다.
