[만들면서 배우는 클린 아키텍처] 8. 경계 간 매핑하기

 

만들면서 배우는 클린 아키텍처 책을 읽고 정리하며 소감을 적는 포스트입니다.

 

모델 매핑에 대한 논쟁

---

이제 각 계층의 어떤 역할을 하는지에 대해 다뤄봤으므로 늘상 겪는 문제인 각 계층의 모델을 매핑하는 것에 대해서 다뤄보자. 매퍼 구현을 피하기 위해 두 계층에서 같은 모델을 사용하는 것에 대해 아래와 같이 논의해본적이 있을 것이다.

 

 

매핑에 찬성하는 개발자

• 두 계층 간에 매핑을 하지 않으면 양 계층에서 같은 모델을 사용해야 하는데 이렇게 되면 두 계층이 강하게 결합됩니다.

 

매핑에 반대하는 개발자

• 하지만 두 계층 간에 매핑을 하게 되면 보일러플레이트 코드를 너무 많이 만들게 돼요. 많은 유스케이스들이 오직 CRUD만 수행하고 계층에 걸쳐 같은 모델을 사용하기 때문에 계층 사이의 매핑은 과합니다.

두 개발자 모두 일정 부분 맞기 때문에 몇 가지 매핑 전략을 알아보자.

 

‘매핑하지 않기’ 전략

---

첫 번째 전략은 ‘No Mapping’ 전략이다.

• ‘송금하기’ 유스케이스와 관련된 요소들
• 포트 인터페이스가 도메인 모델을 입출력 모델로 사용하면 두 계층 간의 매핑을 할 필요가 없다.

 

웹 계층에서는 웹 컨트롤러가 SendMoneyUseCase 인터페이스를 호출해서 유스케이스를 실행한다. 이 인터페이스는 Account 객체를 인자로 가진다. 즉, 웹 계층과 애플리케이션 계층 모두 Account 클래스에 접근하여 두 계층이 같은 모델을 사용하는 것을 의미한다.

 

반대쪽의 영속성 계층과 애플리케이션 계층도 같은 관계다. 모든 계층이 같은 모델을 사용하니 계층 간 매핑을 전혀할 필요가 없다.

 

단점

• 도메인과 애플리케이션 계층은 웹이나 영속성과 관련된 요구사항에 관심이 없음에도 불구하고 모든 요구사항을 다뤄야 한다.
  • 단일 책임 원칙을 위반
• Account 클래스에 오로지 특정 계층에서만 필요한 필들들을 포함하는 파편화된 도메인 모델로 이어질 수 있음

 

그러나 (조금 지저분하게 느껴질 수는 있지만) 모든 계층이 정확히 같은 구조의, 정확히 같은 정보를 필요로 하는 경우에는 ‘매핑하지 않기’ 전략은 완벽한 선택지다. 하지만 애플리케이션 계층이나 도메인 계층에서 웹과 영속성 문제를 다루게 되면 곧바로 다른 전략을 취해야 한다.

 

이 말은 어떤 매핑 전략을 선택했더라도 나중에 언제든 바꿀 수 있다는 것이다. 경험상 많은 유스케이스들이 간단한 CRUD 유스케이스로 시작했다가 시간이 지남에 따라 값비싼 매핑 전략이 필요한, 풍부한 행동과 유효성 검증을 가진 제대로 된 비즈니스 유스케이스로 변경되었기 때문이다. 영원히 간다한 CRUD 유스케이스로 남는다면 다른 매핑 전략에 시간을 들이지 않았기 떄문에 이것 역시 반가운 일이다.

 

‘양방향’ 매핑 전략

---

각 계층이 전용 모델을 가진 매핑 전략을 ‘Two-Way’ 매핑 전략이라고 한다.

• 각 어댑터가 전용 모델을 가지고 있어서 해당 모델을 도메인 모델로, 도메인 모델을 해당 모델로 매핑할 책임을 가지고 있다.

 

각 계층은 도메인 모델과는 완전히 다른 구조의 전용 모델을 가지고 있다. 두 계층 모두 양방향으로 매핑하기 때문에 ‘양방향’ 매핑이라고 부른다.

• 웹 계층에서는 웹 모델을 인커밍 포트에서 필요한 도메인 모델로 매핑하고, 인커밍 포트에 의해 반환된 도메인 객체를 다시 웹 모델로 매핑한다.
• 영속성 계층은 아웃고잉 포트가 사용하는 도메인 모델과 영속성 모델 간의 매핑과 유사한 매핑을 담당한다.

 

장점

• 각 계층이 전용 모델을 가지고 있는 덕분에 각 계층이 전용 모델을 변경하더라도 다른 계층에는 영향이 없다.
  • 웹 모델은 데이터를 최적으로 표현할 수 있는 구조를 가질 수 있다.
  • 도메인 모델은 유스케이스를 제일 잘 구현할 수 있는 구조를 가질 수 있다.
  • 영속성 모델은 데이터베이스에 객체를 저장하기 위해 ORM에서 필요로 하는 구조를 가질 수 있다.
• 이 매핑 전략은 웹이나 영속성 관심사로 오염되지 않은 깨끗한 도메인 모델로 이어진다. JSON이나 ORM 매핑 애너테이션도 없어도 된다.
  • 단일 책임 원칙을 만족하는 것이다.
• 개념적으로는 ‘매핑하지 않기’ 전략 다음으로 간단한 전략이라는 것이다.
  • 매핑 책임이 명확하다.
  • 바깥쪽 계층/어댑터는 안쪽 계층의 모델로 매핑하고, 다시 반대 방향으로 매핑한다.
  • 안쪽 계층은 해당 계층의 모델만 알면 되고 매핑 대신 도메인 로직에 집중할 수 있다.

 

단점

• 너무 많은 보일러플레이트 코드가 생긴다.
  • 매핑 프레임워크를 사용하더라도 매핑 구현에 꽤 시간이 든다.
  • 매핑 프레임워크가 내부 동작 방식을 제네릭 코드와 리플렉션 뒤로 숨길 경우 매핑 로직 디버깅도 고통스럽다.
• 도메인 모델이 계층 경계를 넘어서 통신하는 데 사용되고 있다.
  • 인커밍 포트와 아웃고잉 포트는 도메인 객체를 입력 파라미터와 반환값으로 사용한다.
  • 바깥쪽 계층의 요구에 따른 변경에 취약해진다.

 

양방향 매핑 전략도 silver bullet이 아니다. 따라서 어떤 매핑 전략도 철칙처럼 여겨져셔는 안 된다. 각 유스케이스마다 적절한 전략을 택할 수 있어야 한다.

 

‘완전’ 매핑 전략

---

또 다른 매핑 전략은 ‘Full’ 매핑 전략이다.

• 각 연산이 전용 모델을 필요로 하기 때문에 웹 어댑터와 애플리케이션 계층 각각이 자신의 전용 모을 각 연산을 실행하는 데 필요한 모델로 매핑한다.

이 매핑 전략에서는 각 연산마다 별도의 입출력 모델을 사용한다. 계층 경계를 넘어 통신할 때 도메인 모델을 사용하는 대신 SendMoneyUseCase 포트의 입력 모델로 동작하는 SendMoneyCommand 처럼 각 작업에 특화된 모델을 사용한다. 이런 모델을 가리켜 ‘command’, ‘requset’ 혹은 이와 비슷한 단어로 표현한다.

• 웹 계층은 입력을 애플리케이션 계층의 커맨드 객체로 매핑할 책임을 가지고 있다.
  • 이러한 커맨드 객체는 애플리케이션 계층의 인터페이스를 명확하게 만들어 준다.
  • 각 유스케이스는 전용 필드와 유효성 검증 로직을 가진 전용 커맨드를 가진다.
• 애플리케이션 계층은 커맨드 객체를 유스케이스에 따라 도메인 모델을 변경하기 위해 필요한 무엇인가로 매핑할 책임을 가진다.

 

장점

• 계층간 통신에 도메인 모델을 사용하지 않는다.
• 여러 유스케이스의 요구사항을 함께 다뤄야 하는 매핑에 비해 구현과 유지보수과 더 쉽다.

 

단점

• 한 계층을 다른 여러 개의 커맨드로 매핑하는 데는 하나의 웹 모델과 도메인 모델 간의 매핑보다 더 많은 코드가 필요하다.
• 애플리케이션 계층과 영속성 계층 사이에서는 매핑 오버헤드가 존재한다.

 

이 매핑 전략을 전역 패턴으로는 추천하지 않는다. 이 전략은 웹 계층(혹은 인커밍 어댑터 종류 중 아무거나)과 애플리케이션 계층 사이에서 상태 변경 유스케이스의 경계를 명확하게 할 때 가장 빛을 발한다. 하지만 애플리케이션 계층과 영속성 계층 사이에서는 매핑 오버헤드가 때문에 사용하지 않는 것이 좋다.

 

또한 어떤 경우에는 연산의 입력 모델에 대해서만 이 매핑을 사용하고, 도메인 객체를 그대로 출력 모델로 사용하는 것도 좋다.

• ex) SendMoneyUseCase가 업데이트된 잔고를 가진 채로 Account 객체를 반환하는 것

이 처럼 매핑 전략은 여러 가지를 섞어쓸 수 있고, 섞어 써야만 한다. 어떤 매핑 전략도 모든 계층에 걸쳐 전역 규칙일 필요가 없다.

 

‘단방향’ 매핑 전략

---

마지막으로 ‘One-Way’ 전략이다.

• 동일한 ‘상태’ 인터페이스를 구현하는 도메인 모델과 어댑터 모델을 이용하면 각 계층은 다른 계층으로부터 온 객체를 단방향으로 매핑하기만 하면 된다.

이 전략에서는 모든 계층의 모델들이 같은 인터페이스를 구현한다. 이 인터페이스는 관련 있는 특성(attribute) 대한 getter 메서드를 제공해서 도메인 모델의 상태를 캡슐화 한다.

 

도메인 모델 자체는 풍부한 행동을 구현할 수 있고, 애플리케이션 계층 내의 서비스에서 이러한 행동에 접근할 수 있다. 도메인 객체를 바깥 계층으로 전달하고 싶으면 매핑 없이 할 수 있다. 왜냐하면 도메인 객체가 인커밍/아웃고잉 포트가 기대하는 대로 상태 인터페이스를 구현하고 있기 때문이다.

 

그러고 나면 바깥 계층에서는 상태 인터페이스를 이용할지, 전용 모델로 매핑해야 할지 결정할 수 있다. 행동을 변경하는 것이 상태 인터페이스에 의해 노출돼 있지 않기 때문에 실수로 도메인 객체의 상태를 변경하는 일은 발생하지 않는다.

 

바깥 계층에서 애플리케이션 계층으로 전달하는 객체들도 이 상태 인터페이스를 구현하고 있다. 애플리케이션 계층에서는 이 객체를 실제 도메인 모델로 매핑해서 도메인 모델의 행동에 접근할 수 있게 된다. 이 매핑은 factory 라는 DDD 개념과 잘 어울린다. DDD 용어인 팩터리는 어떤 특정한 상태로부터 도메인 객체를 재구성할 책임을 가지고 있다.

 

이 전략에서 매핑 책임은 명확하다. 만약 한 계층이 다른 계층으로부터 객체를 받으면 해당 계층에서 이용할 수 있는 다른 무언가로 매핑하는 것이다. 그러므로 각 계층은 한 방향으로만 매핑한다. 그래서 단방향 매핑 전략인 것이다.

 

하지만 매핑이 계층을 넘나들며 퍼져 있기 때문에 이 전략은 다른 전략에 비해 개념적으로 어렵다. 이 전략은 계층 간의 모델이 비슷할 때 가장 효과적이다. 예를 들어, 읽기 전용 연산의 경우 상태 인터페이스가 필요한 모든 정보를 제공하기 때문에 웹 계층에서 전용 모델로 매핑할 필요가 전혀 없다.

 

언제 어떤 매핑 전략을 사용할 것인가?

---

이 질문의 답은 평범하고 슬플게도 ‘그때 그때 다르다’ 이다. 각 매핑 전략이 저마다 장단점을 갖고 있기 때문에 한 전략을 전체 코드에 대한 전역 규칙으로 정의하려는 충동을 이겨내야 한다.

 

언제 어떤 전략을 사용할지 결정하려면 팀 내에서 합의할 수 있는 가이드라인을 정해둬야 한다. 이 가이드라인은 어떤 상황에서 어떤 매핑 전략을 가장 먼저 택해야 하는가와 왜 해당 전략을 우선시하는지도 설명할 수 있어야 한다.

 

예를 들어, 변경 유스케이스와 쿼리 유스케이스에 서로 다른 매핑 가이드라인을 정해뒀다고 해보자. 또 웹 계층과 애플리케이션 계층 사이에서 사용할 매핑 전략과 애플리케이션 계층과 영속성 계층 사이에서 사용할 매핑 전략을 다르게 세웠다고 가정해보자.

 

변경 유스케이스

• 웹 계층과 애플리케이션 계층 사이에서는 ‘완전 매핑’ 전략을 첫 번째 선택지로 택해야 한다.
  • 유스케이스간의 결합을 제거하여 유스케이스별 유효성 검증 규칙이 명확해지고 특정 유스케이스에서 필요하지 않은 필드를 다루지 않아도 된다.
• 애플리케이션과 영속성 계층 사이에서는 ‘매핑하지 않기’ 전략을 첫 번째 선택지로 둔다.
  • 매핑 오버헤드를 줄이고 빠르게 코드를 짜기 위해서
  • 만약 애플리케이션 계층에서 영속성 문제를 다뤄야 하게 되면 ‘양방향’ 매핑 전략으로 변경하여 영속성 문제를 영속성 계층에 가둘 수 있게 한다.

 

쿼리 유스케이스

• 매핑 오버헤드를 줄이고 빠르게 코드를 짜기 위해 ‘매핑하지 않기’ 전략이 웹 계층과 애플리케이션 계층 사이, 애플리케이션 계층과 영속성 계층 사이 첫 번째 선택지가 되어야 한다.
• 하지만 마찬가지로 만약 애플리케이션 계층에서 영속성 문제나 웹 문제를 다뤄야 하게 되면 웹 계층과 애플리케이션 계층 사이, 애플리케이션 계층과 영속성 계층 사이 각각 ‘양방향’ 매핑 전략으로 변경해야 한다.

 

요약

---

계층 사이에서 문지기처럼 동작하는 인커밍 포트와 아웃고잉 포트는 서로 다른 계층이 어떻게 통신해야 하는지를 정의한다. 여기서는 계층 사이에 매핑을 수행할지 여부와 어떤 매핑 전략을 선택할지가 포함된다.

 

각 유스케이스에 대해 좁은 포트를 사용하면 유스케이스마다 다른 매핑 전략을 사용할 수 있고, 다른 유스케이스에 영향을 미치지 않으면서 코드를 개선할 수 있기 때문에 특정 상황, 특정 시점에 최선의 전략을 선택할 수 있다.

 

상황별로 매핑 전략을 선택하는 것은 전력 매핑 전략을 사용하는 것보다 어렵고 더 많은 커뮤니케이션을 필요로 하겠지만 매핑 가이드라인이 있는 한, 더 유지보수하기 쉬운 코드가 될 것이다.