'유즈케이스' 태그의 글 목록

유즈케이스

[Clean Architecture] 4. 유즈케이스 구현하기 2023.02.20

PREV 1 NEXT

[Clean Architecture] 4. 유즈케이스 구현하기

2023. 2. 20. 13:53

이번 장에서는 육각형 아키텍처 스타일에서 유즈케이스를 구현하는 방법을 알아보자.

이를 위해 한 계좌에서 다른 계좌로 돈을 송금하는 유즈케이스를 구현해 볼 것이다.

먼저 도메인 엔티티를 만드는 방법을 살펴본 다음, 해당 도메인 엔티티를 중심으로 유즈케이스를 구현해보자.

이 때 도메인은 대상, 유즈케이스는 대상에 가해지는 행위 정도로 생각하면 이해하기 쉽다.

1. 도메인 구현하기

먼저 입출금이 가능한 Account 엔티티를 만들자.

public class Account {
    private AccountId id;
    private Money baselineBalance;
    private ActivityWindow activityWindow;

    public Money calculateBalance() {
        return Money.add(
                this.baselineBalance,
                this.activityWindow.calculateBalance(this.id)
        );
    }

    public boolean withdraw(Money money, AccountId targetAccountId) {
        if(!mayWithdraw(money)) {
            return false;
        }

        Activity withdrawal = new Activity(
                this.id,
                this.id,
                targetAccountId,
                LocalDateTime.now(),
                money
        );

        this.activityWindow.addActivity(withdrawal);
        return true;
    }

    private boolean mayWithdraw(Money money) {
        return Money.add(
                this.calculateBalance(),
                money.negate()
        ).isPositive();
    }

    public boolean deposit(Money money, AccountId sourceAccountId) {
        Activity deposit = new Activity(
                this.id,
                sourceAccountId,
                this.id,
                LocalDateTime.now(),
                money
        );

        this.activityWindow.addActivity(deposit);
        return true;
    }

    @Value
    public static class AccountId {
        private Long value;
    }
}

Account 엔티티에 대한 모든 입금과 출금은 Activity 엔티티를 사용하고 있는데,

Account 엔티티가 도메인 이라면 Activity 엔티티는 유즈케이스 라고 할 수 있다.

ActivityWindow 란 무엇인가? 한 계좌에 요청된 모든 행위를 메모리에 한꺼번에 올려두는 것은 성능 저하의 원인이 될 수 있기 때문에,

Account 엔티티는 ActivityWindow 객체를 둠으로써 특정 기간동안의 행위만을 보유하고 있을 수 있다.

그리고 외부에서 Account 엔티티에 요청이 들어오면 withdraw(삭제), deposit(추가) 메소드를 이용해

ActivityWindow 에 새로운 행위를 더하거나 과거의 행위를 제거할 수 있다.

Account 엔티티는 도메인 모델이기 때문에 행위를 구현하지 않았다.

단지 관련 속성(계좌번호, 잔액 등)만 포함하고, 행위는 모두 Activity 엔티티로 구현해 해당 엔티티를 가져다가 사용하기만 한다.

✅ 풍부한 도메인 모델 vs 빈약한 도메인 모델

도메인 모델을 어떻게 작성해야 하는지에 대한 지침은 정해져 있지 않다.

그래서 책에서는 자주 사용되는 풍부한 도메인 모델과 빈약한 도메인 모델 두가지 유형을 소개한다.

풍부한 도메인 모델은 도메인 엔티티에 가능한 한 많은 도메인 로직을 구현하는 형태이다.

이 경우 유즈케이스는 도메인의 모델의 진입점으로 동작하며 많은 비즈니스 규칙이 유즈케이스 구현체 대신 엔티티에 위치하게 된다.

빈약한 도메인 모델은 이와 반대로 엔티티에는 상태 필드와 getter, setter 메서드만 포함하고 다른 로직은 가지지 않는다.

그 대신 로직은 유즈케이스 클래스에서 구현된다.

2. 유즈케이스 구현하기

1. 입력을 받는다.
2. 비즈니스 규칙을 검증한다. (이는 도메인 엔티티와 공유하는 책임이다)
3. 모델 상태를 조작한다. (조작 후 영속성 계층에 전달해 저장한다)
4. 출력을 반환한다. (조작 및 저장 결과 반환한다)

위는 유즈케이스의 역할이다. 이를 바탕으로 송금 유즈케이스를 구현해보자.

넓은 서비스 문제를 피하기 위해 모든 유즈케이스를 한 서비스 클래스에 넣지 말고, 각 유즈케이스별를 각각의 분리된 서비스 클래스로 만들자.

@RequiredArgsConstructor
@Transactional
public class SendMoneyService implements SendMoneyUseCase {

    private final LoadAccountPort loadAccountPort;
    private final AccountLock accountLock;
    private final UpdateAccountStatePort updateAccountStatePort;
    
    @Override
    public boolean sendMoney(SendMoneyCommand command) {
        //TODO: 비즈니스 규칙 검증
        //TODO: 모델 상태 조작
        //TODO: 출력 값 반환
    }
}

서비스는 SendMoneyUseCase를 구현하고, 계좌 정보를 불러오기 위해 LoadAccountPort를 호출한다.

그리고 변경된 계좌 상태를 저장하기 위해 UpdateAccountStatePort를 호출한다.

✅ 입력 유효성 검증

입력 유효성 검증은 유즈케이스의 책임이 아니다. 이는 입력 모델(DTO)에서 다루는 것이 바람직하다.

현 유즈케이스에서 입력 모델은 SendMoneyCommand 이다.

이 입력 모델의 생성자에 입력 유효성을 검증하는 로직을 직접 작성할 수도 있지만,

자바의 Bean Validation API 표준 라이브러리를 사용하면 훨씬 간편하게 검증 작업을 처리할 수 있다.

@Getter
public class SendMoneyCommand extends SelfValidating<SendMoneyCommand> {

    @NotNull
    private final AccountId sourceAccountId;

    @NotNull
    private final AccountId targetAccountId;

    @NotNull
    private final Money money;

    public SendMoneyCommand(
            AccountId sourceAccountId,
            AccountId targetAccountId,
            Money money) {
        this.sourceAccountId = sourceAccountId;
        this.targetAccountId = targetAccountId;
        this.money = money;
        requireGreaterThan(money, 0)
        this.validateSelf();
    }
}

기본적으로 제공되는 유효성 검증 도구가 부족하다면 직접 구현하는 것도 가능하다.

package shared;

public abstract class SelfValidating<T> {

  private Validator validator;

  public SelfValidating() {
    ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
    validator = factory.getValidator();
  }

  protected void validateSelf() {
    Set<ConstraintViolation<T>> violations = validator.validate((T) this);
    if (!violations.isEmpty()) {
      throw new ConstraintViolationException(violations);
    }
  }
}

✅ 생성자 활용하기

SendMoneyCommand 클래스는 생성자에서 많은 작업을 처리하고 있다.

혹시 Builder 패턴을 활용하면 더 깨끗한 코드를 작성할 수 있지 않을까?

생성자를 private 으로 만들고 빌더의 build() 메서드 내부에 생성자 호출을 숨길 수 있다.

그러면 파라미터가 여러개인 생성자를 호출하는 대신 다음과 같이 객체를 만들 수 있다.

new SendMoneyCommandBuilder()
  .sourceAccountId(new AccountId(41L))
  .targetAccountId(new AccountId(42L))
  // ...다른 여러 필드를 초기화
  .build();

하지만 빌더를 사용하는 경우, 이 빌더를 호출하는 코드에서 필드가 누락되었을 경우 컴파일 타임에 이를 캐치할 수 없다.

따라서 웬만하면 생성자 패턴을 이용하는 것을 권장한다. (요즘은 IDE가 좋아져서 생성자 패턴도 나름 깔끔하다)

✅ 유즈케이스의 입력 모델

서로 다른 유즈케이스 간에 동일한 입력 모델(DTO)을 사용해도 될까?

얼핏 생각해보면 게시글을 업데이트 하는 DTO와 게시글을 생성하는 DTO가 동일해도 큰 문제는 없을 것 같다.

하지만 이렇게 구현하는 경우, 나중에 게시글 업데이트 부분에서만 기능이 추가되는 경우, 공통으로 사용하던 DTO를 수정하게 되면

게시글 생성 부분에서는 문제가 발생할 수 있다.

또한 서로 다른 유즈케이스는 서로 다른 유효성 검증 로직을 필요로 할 수 있으므로,

유즈케이스의 입력 모델은 각각 분리하여 작성하도록 하자.

물론 각 유즈케이스마다 해당하는 입력 모델을 만들어줘야 하기 때문에 비용이 조금 더 많이 들 수 있다.

✅ 비즈니스 규칙 검증

입력 유효성 검증은 유즈케이스의 책임이 아니지만, 비즈니스 규칙 검증은 분명히 유즈케이스의 책임이다.

그런데 언제 입력 유효성을 검증하고 언제 비즈니스 규칙을 검증해야 할까? 이 두 상황은 아래와 같이 구분하면 좋다.

도메인 모델의 현재 상태에 접근해야 하는가? : 비즈니스 규칙 검증
도메인 모델의 현재 상태에 접근할 필요가 없는가? : 입력 유효성 검증

송금 유즈케이스로 예시를 들면 "출금 계좌는 초과 출금되어서는 안된다" 라는 규칙은 비즈니스 규칙 검증에 해당하고,

"송금되는 금액은 0보다 커야 한다" 라는 규칙은 입력 유효성 검증에 해당한다.

이렇게 구분법을 명확히 해 두어야 나중에 특정 유효성 검증 로직을 어느 위치에 생성할지 결정하거나 어디에 구현해 두었는지 찾기 쉽다.

그럼 비즈니스 규칙 검증은 어떻게 구현할까? 가장 좋은 방법은 도메인 엔티티 안에 구현하는 것이다.

이렇게 하면 규칙이 대상과 함께 위치하기 때문에 위치를 정하는 것도 쉽고 추론하기도 쉽다.

package buckpal.domain;

public class Account {

  // ...
  
  public boolean withdraw(Money money, AccountId targetAccountId) {
    if (!mayWithdraw(money)) {
      return false;
    }
    // ...
  }
}

만약 이 방법이 여의치 않다면 유즈케이스 코드에서 도메인 엔티티를 사용하기 전 부분에 구현해도 된다.

package buckpal.application.service;

@RequireArgsConstructor
@Transactional
public class SendMoneyService implements SendMoneyUseCase {

  // ...
  
  @Override
  public boolean sendMoney(SendMoneyCommand command) {
    requireAccountExists(command.getSourceAccountId());
    requireAccountExists(command.getTargetAccountId());
    // ...
  }
}

하지만 이 코드는 단순히 출금 계좌와 입금 계좌가 데이터베이스에 존재하는지의 여부만 확인하는 코드이다.

즉 도메인 모델을 로드해서 상태를 검증할 필요는 없는 코드이다.

만약 도메인 모델의 로드가 필요하다면 유즈케이스 코드가 아닌 도메인 엔티티 내에 비즈니스 규칙을 구현하도록 하자.

어차피 도메인 모델을 가져와야 한다면, 굳이 규칙의 대상과 거리가 먼 유즈케이스 코드에 규칙을 작성할 필요는 없으니까!

✅ 유즈케이스의 출력 모델

앞에서는 유즈케이스의 입력 모델을 살펴보았다. 그럼 출력 모델은 어떨까?

입력과 비슷하게 출력도 가능하면 각 유즈케이스에 맞게 구체적일수록 좋고, 최소한의 정보만 반환하는 것이 좋다.

또한 유즈케이스 간에 동일한 출력 모델을 공유하는 것은 유즈케이스간의 결합도를 높이는 행위이므로 지양하자.

단일 책임 원칙에 따라 모델을 분리해서 유지/관리하자. 같은 이유로 도메인 엔티티를 출력 모델로 사용하는것도 지양하자.

✅ 읽기 전용 유즈케이스

아무런 연산이 필요 없는 읽기 전용 유즈케이스는 어떨까? 구현할 필요가 있을까?

놀랍게도 이 책에서는 쿼리를 위한 전용 포트를 만들고, 이를 쿼리 서비스로 구현하라고 제안하고 있다.

package buckpal.application.service;

@RequiredArgsConstructor
class GetAccountBalanceService implements GetAccountBalanceQuery {

    private final LoadAccountPort loadAccountPort;

    @Override
    public Money getAccountBalance(AccountId accountId) {
        return loadAccountPort.loadAccount(accountId, LocalDateTime.now())
                .calculateBalance();
    }
}

GetAccountBalanceQuery 라는 인커밍 포트를 구현했고,

데이터베이스로부터 데이터를 로드하기 위해 LoadAccount라는 아웃고잉 포트를 호출하는 코드이다.

이런 식으로 읽기 전용 쿼리를 구현하면 다른 유즈케이스와 코드 상에서 명확하게 구분된다는 장점이 있다.

3. 정리

이번 장에서는 클린 아키텍쳐를 만들기 위해 유즈케이스를 어떻게 구현하면 좋은지 알아보았다.

핵심은, 유즈케이스와 각 유즈케이스 관련 모델은 공유하는 것 보다 독립적으로 구현하는게 좋다는 것이다.

그래야 각 유즈케이스의 역할을 명확히 이해할 수 있고, 장기적을 유지보수 하기도 쉬우며, 여러명의 개발자가 동시에 작업할 수 있다.

단점은, 작성해야 하는 코드의 양이 많아진다.

'Java' 카테고리의 다른 글

[Clean Architecture] 8. 경계 간 매핑하기 (0)	2023.02.20
[Effective Java] ITEM87 : 커스텀 직렬화 형태를 고려해보라 (0)	2022.11.28
[Effective Java] ITEM84 : 프로그램의 동작을 스레드 스케줄러에 기대지 말라 (0)	2022.11.06
[Effective Java] ITEM74 : 메서드가 던지는 모든 예외를 문서화하라 (0)	2022.11.06
[Effective Java] ITEM69 : 예외는 진짜 예외 상황에만 사용하라 (0)	2022.09.20

스미스요원