Spring 멀티 모듈 적용하기

[보틀] 프로젝트를 진행하면서 스프링 멀티 모듈 프로젝트를 적용하게 된 이유와 과정을 기록하려고 합니다. 

멀티 모듈 프로젝트를 구성하는 방법에 대해서는 자세히 설명하지 않겠습니다.

 

단일 프로젝트

우선 늘 그래왔듯이 단일 프로젝트로 시작했습니다.

큰 규모의 프로젝트가 아니고, 아직은 하나의 서버로 운영하기 때문에 단일 프로젝트로 구성해도 큰 문제가 없습니다.

하지만 실 서비스 운영을 생각했을 때는, 서버 인스턴스 사양을 업그레이드를 하던지 (aws 프리티어 사용 중..) 단일 서버가 아닌 여러 서버로 분리하는 것이 필요하다고 생각했습니다.

 

그리고 보틀은 소개팅 서비스로, 일정 시간에 유저들을 매칭해 주는 핵심 기능이 있습니다.

이 작업은 스케줄러에 의해 동작합니다. 초기에는 유저의 수도 적고 매칭하는 시간 간격도 길게 잡아 하나의 서버에서 동작해도 문제가 없을 것으로 생각됩니다.

하지만 유저의 수가 조금만 많아져도 스케줄러 작업에 많은 시간이 소요되기 때문에 다른 요청에 영향을 미칠 수 있습니다.

그래서 마찬가지로 추후에 서버를 분리하여 운영하는 것이 불가피할 것이라고 생각했습니다.

위 문제와 별개로, 스케줄러 작업을 따로 분리한다면 나중에 서비스가 많이 커졌을 때는 스프링 배치를 붙여서 해결할 수도 있습니다.

 

결론은 관심사의 분리(스케줄러 작업과 API 작업의 분리) + 확장성을 위해 멀티 모듈을 적용하기로 했습니다.

 

모듈 분리 과정

모듈을 어떻게 분리를 할지 고민을 했습니다.

모듈을 분리하는 방법은 정말 정하기 나름이었습니다.

도메인 별로 분리할 수도 있고, 레이어 별로 분리할 수도 있습니다.

 

하지만 지금 당장은 API 작업과 스케줄러 작업을 분리하는 것이 목적이므로, api 모듈 / batch 모듈로 분리했습니다.

 

분리하고 나니 다음과 같이 구성되었습니다.

• api 모듈 - controller, service, domain, repository
• batch 모듈 - scheduler

그리고 batch 모듈이 api 모듈을 의존하도록 했습니다. (batch -> api)

 

지금 구조가 문제는 없지만, batch 모듈이 api 모듈을 의존하는 게 살짝 신경 쓰입니다.

api 모듈은 사실 application 그 자체이기 때문에, 나중에 서비스가 커져서 다른 모듈을 붙이게 될 때 모두 api 모듈을 의존하게 될 것 같았습니다.

따라서 api 모듈에서 핵심 로직을 분리하고, api 모듈은 말 그대로 http 통신을 위한 모듈로 구조를 변경하게 되었습니다.

 

최종적으로 다음과 같이 모듈을 분리했습니다.

• api 모듈 - 통신을 위한 모듈 (controller 계층)
• app 모듈 - 도메인 및 도메인 로직을 위한 모듈 (service, domain, repository)
• batch 모듈 - 배치 작업을 위한 모듈

그리고 의존성은 다음과 같이 흐르도록 했습니다.

• api -> app
• batch -> app

추후에 모듈을 붙인다면 핵심 로직을 가지고 있는 app을 바라보도록 할 수 있게 되었습니다.

멀티모듈 적용 후 프로젝트 구조

멀티 모듈 적용 시 알면 좋은 것들

Component Scan 지정

모듈을 분리하게 되면 각 모듈에서 다른 모듈의 Bean을 등록하지 못하게 됩니다.

왜냐하면 component scan은 Application 파일이 위치한 패키지를 기준으로 등록할 Bean을 찾기 때문입니다. 따라서 component scan 할 패키지를 직접 지정해줘야 합니다.

 

아래는 api 모듈의 Application 파일에 패키지를 지정해 주는 코드입니다.

@ConfigurationPropertiesScan
@SpringBootApplication(
    scanBasePackages = [
        "com.nexters.bottles.api",
        "com.nexters.bottles.app",
    ]
)
class BottlesApiApplication

fun main(args: Array<String>) {
    runApplication<BottlesApiApplication>(*args)
}

 

gradle의 implementation과 api

보통 의존성을 추가할 때, implementation("xxxx")와 같은 방식으로 추가합니다.

 

그러나 implementation 키워드는 해당 의존성을 현재 프로젝트에서만 사용할 수 있게 하며, 이 의존성을 다른 프로젝트에 노출하지 않습니다. 즉, 의존성 전이가 일어나지 않는다는 의미입니다.

 

그럼 다른 프로젝트에서도 함께 사용하기 위해서는 api를 사용해야 합니다. api는 implementation과 달리 의존성 전이가 일어나서, 해당 프로젝트를 사용하는 다른 프로젝트에서도 그 의존성을 함께 사용할 수 있게 됩니다.

 

정리하면, 

• implementation - 다른 프로젝트에 의존성 전이가 일어나지 않음
• api - 다른 프로젝트에 의존성 전이가 일어남

dependencies {
    api("org.springframework.boot:spring-boot-starter-web")
    api("org.springframework.boot:spring-boot-starter-data-jpa")
    api("org.springframework.boot:spring-boot-starter-data-jdbc")
}

 

---

 

멀티 모듈을 어떻게 구성하고 적용하는지에는 정답이 없는 것 같습니다.

현재 구조로 진행하다가 어딘가 문제가 생기거나 조금 더 효율적인 구조가 떠오르면 그때 변경할 수도 있습니다. 계속 고민하며 좋은 구조를 찾아가는 것이 좋을 것 같습니다.