[Spring Boot - 🐱PetClinic🐶] 6. 패키지 구조 분석🔍

🗒 계층형과 도메인형

패키지를 구성하는 방식은 크게 두 가지로 나눌 수 있다. 계층형과 도메인형이다. 이 두 가지 구성 방식은 각자의 장단점이 존재한다. 각자의 장단점을 토대로 프로젝트에 가장 적합하다고 판단되는 도메인 구성 방식을 선택하는 것이 좋다고 한다. 절대적인 기준은 없는 것 같다.

일단 시스템의 규모에 따라 프로젝트가 너무 작아서 나누는 것이 무의미하다고 판단이 된다면 패키지 하나에 다 몰아넣는 것이 유리하다. 요구사항이 늘면서 프로젝트의 규모가 커지면 컨트롤러, DTO, Entity, 서비스 등의 패키지로 나누는 것이 좋다. 이렇게 나누는 방식이 계층형이다. 프로젝트가 더욱 커지게 되면 패키지별 파일의 수가 늘어나게 된다. 그렇게 되면 프로젝트를 유지보수하기 힘들어진다. 이럴 때는 도메인별로 패키지를 구성하는 것이 조금 더 유리해진다. 도메인별로 구성하게 되면 기능을 추가할 때 패키지 하나를 추가하고 그곳에서 작업하면 되기 때문에 확장성이 있다. 정답은 없다고는 하지만 확장성을 고려할 때 도메인형으로 구성하는 것이 좋을 것 같다.

🗂 Pet Clinic의 패키지 구성

내가 지금 분석하고 있는 Pet Clinic은 도메인형으로 패키지를 나누고 있다. 몇 년 전에 작성됐던 Pet Clinic은 계층형이었는데 리패키지를 진행하며 도메인형으로 바뀐 것 같다. 내가 처음 봤던 Pet Clinic은 계층형이었는데 어떤 블로그에서 도메인형이라고 소개해서 다시 찾아봤더니 가장 최근에 업로드된 코드는 도메인형으로 바뀌었다..

이게 Pet Clinic의 src/main/java 하위의 패키지 구성이다. org/springframework/samples/petclinic 패키지 아래에 네 개의 패키지가 있다.

• model: 각 도메인에서 공통으로 사용되는 엔티티들이 모여있는 패키지
  이 엔티티들은 @MappedSuperClass이다. 테이블과 매핑되지 않고 @Entity들이 extends 해서 사용한다.
• owner: 반려동물과 그들의 주인, 방문일과 관련된 파일들이 모여있는 패키지
  Find Owners 탭을 통해 접근할 수 있는 페이지들 관련 패키지다.
• system: 캐시 관련된 설정을 하는 파일과 메인 화면을 처리하는 컨트롤러와 Runtime Exception이 발생했을 때 처리하는 컨트롤러가 모여있는 패키지
  다른 패키지들과 관련 없는 파일들이 모여있다.
• vet: 수의사와 관련된 파일들이 모여있는 패키지
  Veterinarians 탭을 통해 접근할 수 있는 페이지들 관련 패키지다.

🧩 마무리

사실 가장 처음 궁금했던 게 '패키지 구성을 어떻게 하는 게 좋을까?'였다. 처음 웹 프로그래밍을 접했을 때는 계층형으로 구성하는 것으로 배웠었는데 규모가 커지면 복잡해 보일 것 같았다. 장단점을 찾아보다 보니 결론은 프로젝트 규모에 따라 다르다는 것이었다. 규모가 정말 작지 않은 이상 확장성을 고려해 도메인형으로 구성하는 게 좋을 것 같다. 이 부분은 프로젝트를 많이 경험하다 보면 나름의 노하우가 생기지 않을까?

그리고 여담으로 Pet Clinic 분석하기 전 혼자 삽질하다 알게 된 건데 Spring Boot에서는 메인 클래스가 다른 패키지들과 같거나 상위에 있어야 @Entity, @Repository 등의 어노테이션을 읽을 수 있다는 것이었다. 이 프로젝트를 분석하기 전에는 관련 지식이 하나도 없는 상태여서 다른 패키지들을 나누듯 메인 패키지를 만들어 그 하위에 메인 클래스를 위치시켰는데 엔티티나 리포지토리 어노테이션을 읽지 못했다. 어찌어찌 찾다가 @EnableJpaRepositories(basePackages = {"리포지토리 패키지 명"})과 @EntityScan(basePackages = {"엔티티 패키지 명"})을 추가해서 해결하긴 했는데 Pet Clinic 패키지 구조를 보니 그냥 다른 패키지들과 같은 위치에 메인 클래스를 넣으면 됐다. 그걸 몰라서 '왜 안 되는 거지..?'를 반복했다.. 폭풍 구글링의 시간들... 그런데 알고 나니까 당연했다. 메인 클래스의 상위로는 안 올라가는 게 당연한데.. 같은 위치에서 하위로만 스캔하는 게 당연한데.... 바보 같은 짓이었지만 그래도 하나 배웠다는 데 의의를 두는 것이 정신건강에 이롭겠지. 그래서 기초지식을 쌓아야겠다고 생각했었다. 기초를 알면 이런 바보 같은 실수는 하지 않겠지...

[참고]

패키지 구조 관련 설명 -
https://www.inflearn.com/questions/16046/
https://cheese10yun.github.io/spring-guide-directory/