코드를 보는 것만으로도 어떤 아키텍처인지 파악할 수 있다면 좋지 않을까?
새 프로젝트에서 가장 먼저 제대로 만들려고 하는 것은 패키지 구조다. 프로젝트에서 계속 사용할 괜찮아 보이는 구조를 잡는다. 그러고 나서 프로젝트가 진행될수록 점점 바빠지고 패키지 구조는 짜임새 없는 엉망진창 코드를 그럴싸하게 보이게 만드는 껍데기일 뿐이라는 점을 깨닫게 된다. 한 패키지에 있는 클래스들이 불러오지(import) 말아야 할 다른 패키지에 있는 클래스들을 불러오게 된다.
계층으로 구성하기
코드를 구조화하는 첫 번째 접근법은 계층을 이용하는 것으로서, 다음과 같이 구성할 수 있다.
여기서는 전에 봤듯이 domain 패키지에 AccountRepository 인터페이스를 추가하고, persistence 패키지에 AccountRepositoryImpl 구현체를 둠으로써 의존성을 역전시켰다.
그러나 이 패키지 구조는 최적의 구조가 아니다.
- 애플리케이션의 기능 조각이나 특성을 구분 짓는 패키지 경계가 없다.
- 이 구조에서 관리하는 기능을 추가해야 한다면 web 패키지에 UserController를 추가하고,
- domin 패키지에 UserService, UserRepository, User를 추가하고
- persistence 패키지에 UserRepositoryImpl을 추가하게 될 것이다.
- 아주 빠르게 서로 연관되지 않은 기능들끼리 예상하지 못한 부수효과를 일으킬 수 있는 클래스들의 묶음으로 변모할 가능성이 크다.
- 애플리케이션이 어떤 유스케이스들을 제공하는지 파악할 수 없다.
- AccountServic와 AccountController가 어떤 유스케이스를 구현했는지 파악할 수 없다.
- 즉, 특정 기능을 찾기 위해서는 어떤 서비스가 이를 구현했는지 추측해야 하고, 해당 서비스 내의 어떤 메서드가 그에 대한 책임을 수행하는지 찾아야 한다.
- 패키지 구조를 통해서는 우리가 목표로 하는 무슨 아키텍처인지 파악할 수 없다.
- 육각형 아키텍처 스타일을 따랐다고 추측할 수는 있고, 그렇기 때문에 패키지 클래스들을 조사해 볼 수 있다.
- 하지만 어떤 기능이 웹 어댑터에서 호출되는지, 영속성 어댑터가 도메인 계층에 어떤 기능을 제공하는지 한눈에 알아볼 수 없다. (코드 속에 숨겨져 있다.)
➜ 기능별로 세분화하자.
기능으로 구성하기
가장 본질적인 변경은 계좌와 관련된 모든 코드를 최상위의 account 패키지에 넣었다는 점이다. 계층 패키지들도 없앴다.
기능별로 묶은 account와 같은 레벨의 새로운 패키지로 들어가고, 패키지 외부에서 접근되면 안 되는 클래스들에 대해 package-private 접근 수준을 이용해 패키지 간의 경계를 강화할 수 있다. 이렇게 하면 각 기능 사이의 불필요한 의존성을 방지할 수 있다.
또한 AccountService의 책임을 좁히기 위해 SendMoneyService로 클래스명을 바꿨다. (이는 계층에 의한 패키지 구조 방식에서도 가능했다.) 이제 클래스명만으로도 '송금'기능을 찾을 수 있게 됐다.
그러나 기능에 의한 패키징 방식은 사실 계층에 의한 패키징 방식보다 아키텍처의 가시성을 훨씬 더 떨어뜨린다. 어댑터를 나타내는 패키지명이 없고, 인커밍 포트, 아웃고잉 포트를 확인할 수 없다. 심지어 도메인 코드와 영속성 코드 간의 의존성을 역전시켜서 구현체를 모르게 했음에도 같은 패키지 내에 있어서 실수로 영속성 코드에 의존하는 것을 막을 수 없다.
아키텍처적으로 표현력 있는 패키지 구조
육각형 아키텍처에서 구조적으로 핵심적인 요소는 엔티티, 유스케이스, 인커밍/아웃고잉 포트, 인커밍/아웃고잉(혹은 주도하거나 주도되는) 어댑터다.
구조의 각 요소들은 패키지 하나씩에 직접 매핑된다. 최상위에는 Account와 관련된 유스케이스를 구현한 모듈임을 나타내는 account 패키지가 있다.
- 그다음 레벨에는 도메인 모델이 속한 domain 패키지가 있다.
- application 패키지는 도메인 모델을 둘러싼 서비스 계층을 포함한다. SendMoneyService는 인커밍 포트 인터페이스인 SendMoneyUseCase를 구현하고, 아웃고잉 포트 인터페이스이자 영속성 어댑터에 의해 구현된 LoadAccountPort와 UpdateAccountStatePort를 사용한다.
- adapter 패키지는 애플리케이션 계층의 인커밍 포트를 호출하는 인커밍 어댑터와 애플리케이션 계층의 아웃고잉 포트에 대한 구현을 제공하는 아웃고잉 어댑터를 포함한다.
간단하게 보면 web 어댑터와 persistence 어댑터로 이뤄진 간단한 웹 애플리케이션이 된다.
이처럼 표현력 있는 패키지 구조는 아키텍처에 대한 적극적인 사고를 촉진한다. 많은 패키지가 생기고, 현재 작업 중인 코드를 어떤 패키지에 넣어야 할지 계속 생각해야 하기 때문이다.
그런데 패키지가 아주 많다는 것은 모든 것을 public으로 만들어서 패키지 간의 접근을 허용해야 할까?
적어도 어댑터 패키지에 대해서는 그렇지 않다. 이 패키지에 들어 있는 모든 클래스들은 application 패키지 내에 있는 포트 인터페이스를 통하지 않고는 바깥에서 호출되지 않기 때문에 package-private 접근 수준으로 둬도 된다. 그러므로 애플리케이션 계층에서 어댑터 클래스로 향하는 우발적인 의존성은 있을 수 없다.
하지만 application 패키지와 domain 패키지 내의 일부 클래스들은 public으로 지정해야 한다. 의도적으로 어댑터에서 접근 가능해야 하는 포트들은 public이어야 한다. 도메인 클래스들은 서비스, 그리고 잠재적으로는 어댑터에서도 접근 가능하도록 public이어야 한다. 서비스는 인커밍 포트 인터페이스 뒤에 숨겨질 수 있기 때문에 public일 필요가 없다.
어댑터 코드를 자체 패키지로 이동시키면 필요할 경우 하나의 어댑터를 다른 구현으로 쉽게 교체할 수 있다는 장점도 있다. 데이터베이스가 변경 됐다고 가정했을 때, 간단하게 관련 아웃고잉 포트들만 새로운 어댑터 패키지에 구현하고 기존 패키지를 지우면 된다.
이 패키지 구조의 또 다른 매력적인 장점은 DDD 개념에 직접적으로 대응시킬 수 있다는 점이다. account 같은 상위 레벨 패키지는 다른 바운디드 컨텍스트(bounded context)와 통신할 전용 진입점과 출구(포트)를 포함하는 바운디드 컨텍스트에 해당한다. domain 패키지 내에서는 DDD가 제공하는 모든 도구를 이용해 우리가 원하는 어떤 도메인 모델이든 만들 수 있다.
설명을 붙이면,
프로그램에서 account와 같은 상위 레벨 패키지는 DDD에서 말하는 '바운디드 컨텍스트'에 대응된다.
▪️ 바운디드 컨텍스트는 어떤 특정 영역, 즉 도메인에 대한 모델의 경계를 정의한다.
▪️ 이 경계는 그 영역에 대한 개념과 규칙을 포함하며, 다른 영역과 통신할 수 있는 진입점과 출구를 제공한다.
예를 들어, account라는 바운디드 컨텍스트는 계산 관련 로직과 규칙을 담당하며, 다른 바운디드 컨텍스트(예를 들어, order라는 상품 주문 관련 영역)와 통신할 수 있는 포트를 제공할 수 있다.)
domain 패키지는 DDD에서 도메인 모델을 만드는 데 필요한 도구들을 포함하고 있다. 여기에서 도메인 모델이란 비즈니스 로직을 담당하는 실제 코드를 말한다. DDD 도구를 사용하면 특정 비즈니스 요구사항에 맞게 도메인 모델을 생성하고 구현할 수 있다.
모든 구조와 마찬가지로 패키지 구조를 소프트웨어 프로젝트 내내 유지하기 위해서는 지켜야 할 규칙이 있다. 또한 패키지 구조가 적합하지 않아서 어쩔 수 없이 아키텍처-코드 갭을 넓히고 아키텍처를 반영하지 않는 패키지를 만들어야 하는 경우도 생긴다.
완벽한 방법은 없다. 그러나 표현력 있는 패키지 구조는 적어도 코드와 아키텍처 간의 갭을 줄일 수 있게 해 준다.
의존성 주입의 역할
클린 아키텍처의 가장 본질적인 요건은 애플리케이션 계층이 인커밍/아웃고잉 어댑터에 의존성을 갖지 않는 것이다.
예제 코드의 영속성 어댑터와 같이 아웃고잉 어댑터에 대해서는 제어 흐름의 반대 방향으로 의존성을 돌리기 위해 의존성 역전 원칙을 이용해야 한다.
- 애플리케이션 계층에 인터페이스를 만들고 어댑터에 해당 인터페이스(포트)를 구현한 클래스를 두면 된다.
- 모든 계층에 의존성을 가진 중립적인 컴포넌트를 하나 두고, 이 컴포넌트가 아키텍처를 구성하는 대부분의 클래스를 초기화하는 역할을 한다.
- AccountController는 SendMoneyUseCase(인터페이스)가 필요하므로 의존성 주입을 통해 SendMoneyService(구현체) 클래스의 인스턴스를 주입
- 이와 비슷하게 SendMoneyService 인스턴스를 만들 때도 의존성 주입 메커니즘이 LoadAccountPort 인터페이스로 가장한 AccountPersistenceAdapter 클래스의 인스턴스를 주입
"인터페이스로 가장하다"라는 표현은 해당 인스턴스가 인터페이스를 통해 해당 구현체를 대표하고 있는 상황을 의미
유지보수 가능한 소프트웨어를 만드는 데 어떻게 도움이 될까?
실제 코드 구조를 최대한 우리가 목표로 하는 아키텍처에 가깝게 만들어 주는 육각형 아키텍처의 패키지 구조로 살펴봤다. 코드에서 아키텍처의 특정 요소를 찾으려면 이제 아키텍처 다이어그램의 박스 이름을 따라 패키지 구조를 탐색하면 된다.
'만들면서 배우는 클린 아키텍처'라는 책을 토대로 정리한 포스팅입니다.
자세한 내용은 책을 참고하시기 바랍니다. 문제시 바로 삭제하겠습니다.
