멀티 모듈에서 다른 모듈의 의존성 주입

[f1v3-dev]

문제 상황

• core: DB 관련 설정 및
• api: Controller, Service 레이어 관리

core 모듈의 빈을 api 모듈에서 주입하려고 할 때 의존성 주입에서 오류가 발생하여 SpringBoot Application 이 실행되지 않는 상황입니다.

어떤 문제점들이 존재하는걸까요?

[hwangdaesun]

위 문제를 해결하기 위해서 @SpringBootApplication에대해서 알아볼 필요가 있습니다

@SpringBootApplication 안에는 @EnableAutoConfiguration과 @componentscan이 있습니다.

@EnableAutoConfiguration 은 Spring이 애플리케이션 컨텍스트를 자동으로 구성하게 합니다. 이렇게 하면 별다른 설정 없이 @entity를 Scan할 수 있습니다.

그러나, 저희 프로젝트의 core 모듈에서는 별도로 @EntityScan을 사용합니다. 따라서, Spring Boot의 자동 구성(auto-configuration)에서 엔터티를 검색하는 기능이 비활성화됩니다.

@Configuration
@EntityScan(basePackages = "com.dnd.sbooky.core")
@EnableJpaRepositories(basePackages = "com.dnd.sbooky.core")
class CoreJpaConfig {

}

그렇기 때문에 api 모듈에서는 core 모듈의 빈들을 사용할 수 없는 문제가 발생합니다.

이를 해결하기 위해 api 모듈의 MainApplication인 SbookyApplication의 위치를 com.dnd.sbooky로 이동하였습니다.

문제의 PR : #30

[hwangdaesun]

추가로 논의해야할 것은 아래와 같습니다.

MainApplication인 SbookyApplication의 위치를 com.dnd.sbooky로 이동하는 해결책이 최선의 해결책인가?

모듈간의 의존성을 완전히 격리 시키기 위해서는 basePackage를 다르게 하는 게 맞는 것 같은데, api 모듈에서 필요한 core 모듈의 빈들만 옮길 수 있을까?

[f1v3-dev]

같은 생각을 하고 계시네요 ㅋㅋㅋ 필요한 정보들만 들고있는 모듈의 빈만 들고오는게 가장 깔끔해보이긴 합니다..

[hwangdaesun]

동의합니다. 아직까지 모듈이 많이 않아서 지금은 이대로해도 괜찮을 듯 싶어요.

[f1v3-dev]

패키지 구조를 모듈별로 분리하는 과정에서 빈 주입 문제가 발생합니다.

• 기존: com.dnd.sbooky
• 변경: com.dnd.sbooky.api , com.dnd.sbooky.core

패키지 구조가 변경이 되더라도, build.gradle의 의존성 설정(implementation project(:core)) 를 통해 빈 주입이 되는 것으로 잘못 이해하고 있었습니다.

정확한 이유를 찾아보니, @SpringBootApplication 내부 어노테이션 중 @ComponentScan 동작이 현재 위치한 패키지(com.dnd.sbooky.api)만 스캔하여 core 모듈의 빈을 사용할 수 없는 상황이었습니다.

이러한 이유로 빈 스캔이 필요하다 는 것을 파악하였으며 해결 방안은 다음과 같습니다:

1. Application.java 위치를 변경 (com.dnd.sbooky)
2. @SpringBootApplication 옵션에 scanBasePackages = "com.dnd.sbooky" 지정
3. api 모듈 내부에 configuration 클래스를 만들어서 @componentscan

현재 프로젝트에서는 단순하게 1번 방법을 통해 컴포넌트 스캔의 대상이 되는 패키지를 크게 가져가도록 하였습니다.

---

의문점

Application.java (Main)의 위치를 최상위 패키지(com.dnd.sbooky)로 지정한 만큼, 다른 모듈의 빈까지 주입받는 상황인데 api 모듈에서 정말 전체 빈 정보가 필요할까? 라는 의문이 들긴 합니다.

아직까지는 작업중인 모듈이 api, core 2가지 모듈이기 때문에 큰 이슈는 없는 것으로 보이나 새로운 모듈이 등장하게 될 시점에는 Configuration Class 를 도입하여, 필요한 정보만 빼오는 방법을 사용하는 방법을 고민할 필요가 있어보여요!