[멀티 모듈] Spring Boot Multi Module로 MSA 환경 구성하기

1. 개요

예전에 봤던 Spring Cloud 강의를 복습하며 이벤트 스트리밍, SAGA 패턴, CQRS 등 MSA에 사용되는 여러 기술들에 익히기 위해 간단한 프로젝트를 만들고 학습하고 있었다. 

 

처음 multi module을 공부해야겠다 했던 건 kafka 관련 설정과 이벤트 통신을 위한 dto들의 코드 중복 때문이었다. MSA 환경을 구성하면서도 코드가 중복된다는게 많이 느껴졌고 공통 모듈로 빼고 싶다는 생각이 들었다. 

또한 JWT 토큰을 사용하여 인증, 인가 처리를 하고 있었기 때문에 위 로직도 어디로 빼야할 지 고민이 되었다. 

 

 

정말 예전에 multi module에 대해서 강의를 본 적이 있는데, 그 땐 이런게 있구나 하고 넘어갔지만 이번엔 제대로 알아보고 multi module로 msa 환경을 구성해보려 한다. 

 

 

 

 

 

 

 

 

2. 멀티 모듈

✅ 모듈

Oracle Java 문서에서 모듈이란 패키지의 한 단계 위의 집합체이며, 관련된 패키지와 리소스들의 재사용할 수 있는 그룹이라고 정의하고 있다.
이때 각 모듈은 독립적으로 개발, 빌드, 테스트, 배포가 가능하다.

 

 

 

✅ 멀티 모듈 

멀티 모듈은 위에서 언급한 모듈들을 하나의 프로젝트 안에서 관리하는 것을 의미한다. 

멀티 모듈 안에서 각각의 모듈은 서로를 향한 의존성을 가질 수 있다.

여러개의 모듈을 생성할 때 반드시 멀티 모듈 프로젝트를 생성해야하진 않지만 코드 중복 제거, 모듈간 의존성을 위해 저장소에 배포하지 않아도 되는 점 등 장점이 있다. 

 

 

 

회원 시스템을 예로 들어보자. 

 

회원 시스템에는 다음과 같은 독립적인 프로젝트 단위가 있다. 

• member internal api : 내부에 관리자 페이지에서 호출하는 api 서버
• member external api : 고객 화면에서 호출하는 api 서버
• member batch : 주기적인 작업을 수행하는 서버

 

 

[ 단일 모듈로 구성된 멀티 프로젝트 ]

 

3가지 프로젝트 모두 유저라는 동일한 도메인에 대해서 구성하고 있기 때문에 중복 코드가 발생할 것이다. (ex. Member 도메인 모델)
 
그런데 만약에 이러한 중복 코드에 수정사항이 생긴다면 세 모듈의 코드를 수정해야 하고 유지보수 난이도가 올라갈 것이다. 

 

 

[ 멀티 모듈로 구성된 단일 프로젝트 ] 

위의 문제를 해결하고자 단일 프로젝트 내에서 여러 개의 모듈을 가질 수 있는 구조가 나왔다. 

 

위 그림처럼 하나의 프로젝트 내에서 기존의 프로젝트 단위는 모듈이 되었고, 공통된 코드(common)는 분리해서 함께 사용할 수 있다.

 

 

 

 

 

 

 

 

 

 

 

3. 멀티 모듈 & DDD & MSA

멀티 모듈은 위에서 언급했으니 DDD, MSA의 각 개념들부터 간단하게 짚고 넘어가면

 

MSA 란?

MSA는 시스템을 독립적인 마이크로서비스로 분리하는 아키텍처이다. 각 서비스는 독립적으로 개발, 배포, 확장 가능하며 특정 도메인에 초점을 맞추어 설계된다. MSA는 복잡한 시스템에서 서비스 간의 연관성을 최소화하고 독립적인 서비스로 구성되도록 하여, 시스템의 유지보수와 확장성을 높이는 데 유리하다

 

 

DDD 란?

DDD는 도메인 지식을 반영한 모델링을 통해 복잡한 비즈니스 로직을 관리하는 설계 방식이다. 핵심 비즈니스 도메인을 식별하고 이를 기반으로 한 모델을 중심으로 시스템을 구축한다. DDD 설계를 통해 각 마이크로 서비스들은 서비스 간 의존성을 낮추고 독립적인 배포와 개발이 가능하게 만든다. 

 

 

 

위 세 가지는 서로 보완적이며 각자의 장점들을 합쳐 유연하고 확장 가능한 시스템을 구축할 수 있다. 

 

 

예를 들어, DDD(도메인 주도 설계)로 시스템을 도메인 중심으로 설계하여 비즈니스 로직을 명확히 구분한 후, MSA 아키텍처로 시스템을 구성할 수 있다. 각 도메인을 독립적인 마이크로서비스로 분리함으로써 시스템의 결합도를 낮추고 독립적으로 배포 및 확장이 가능하다. 

 

 

또한, MSA는 독립적인 마이크로서비스를 여러 개 운영하는 방식이므로, 공통으로 필요한 기능(예: 인증, 로깅, 예외 처리 등)이 여러 서비스에서 반복적으로 구현되어야 하는 경우가 발생할 수 있다. 스프링 멀티모듈을 사용하면 이러한 공통 기능을 common 모듈로 추출하여 재사용할 수 있다.

MSA와 멀티모듈의 결합은 각 마이크로서비스가 필요한 기능만 참조할 수 있게 하여 아키텍처의 유연성을 유지하면서도 반복되는 코드 작성을 최소화할 수 있게 한다. 

 

 

 

 

 

 

 

 

 

 

 

 

4. Spring Boot 에서 멀티 모듈 적용하기 

들어가기 앞서 패키지 구조는 아래와 같이 가져갔다. 

 

Spring Cloud 관련 모듈인 api gateway, eureka 가 있고, 예전에 만들어뒀던 todo 애플리케이션에 member 기능을 추가했다. temp-server는 그냥 micro server 개수를 늘리기 위해 만들어 보았다.. ㅋㅋ

common은 공통 모듈 역할을 하고 infra는 kafka, zipkin 등의 애플리케이션을 띄우는 데 필요한 docker 관련 설정을 해두었다. 

📦spring-cloud-test
 ┣ 📂apigateway
 ┣ 📂common
 ┣ 📂eureka
 ┣ 📂gradle
 ┣ 📂infra
 ┣ 📂member-server
 ┣ 📂temp-server
 ┣ 📂todo-app-server
 ┣ 📜.gitattributes
 ┣ 📜.gitignore
 ┣ 📜build.gradle
 ┣ 📜gradlew
 ┣ 📜gradlew.bat
 ┣ 📜HELP.md
 ┗ 📜settings.gradle

 

루트 모듈 생성

멀티 모듈을 전부 관리할 루트 모듈을 생성한 후 src 디렉토리는 삭제해준다. 

 

src 디렉토리가 남아있을 경우 아래와 같은 에러와 마주치게 될 것이다.

Execution failed for task ':bootRun'.
> Failed to calculate the value of task ':bootRun' property 'mainClass'.
   > Main class name has not been configured and it could not be resolved

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at https://help.gradle.org.
Deprecated Gradle features were used in this build, making it incompatible with Gradle 9.0.
You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.
For more on this, please refer to https://docs.gradle.org/8.4/userguide/command_line_interface.html#sec:command_line_warnings in the Gradle documentation.
BUILD FAILED in 1s
3 actionable tasks: 2 executed, 1 up-to-date

 

 

 

 

하위 모듈 생성

하위 모듈 역할을 할 새로운 모듈 생성은 인텔리제이에서 간단하게 할 수 있다. 만약 전체 모듈에서 공통적으로 사용할 디펜던시가 있다면 루트 모듈에서 주입해주면 되기 때문에 본인의 모듈에서만 사용할 의존성만 추가해주면 된다. 

 

 

생성 후 아래 파일들은 전부 지워주자.

 

삽질을 좀 했던 부분인데, gradle 관련 파일이 하위 모듈에 남아있으면 gradle build를 진행할 때 하위 모듈도 따로 링크를 맺게 되고 루트 모듈에서 관리할 수 없다. 

 

 

 

처음 모듈을 생성하고 난 후의 build.gradle의 모습이다. 

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.3.5'
    id 'io.spring.dependency-management' version '1.1.6'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(21)
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
    useJUnitPlatform()
}

 

 

여기서 dependencies만 남겨두고 전부 지워주자. (루트 모듈로부터 주입 받을 내용은 제외하기 위함, 있어도 문제 없지만 코드 중복)

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

 

 

 

 

루트 모듈에서 build.gradle 설정

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.3.5'
    id 'io.spring.dependency-management' version '1.1.6'
}

bootJar.enabled = false // 루트 프로젝트의 bootJar 비활성화

subprojects {
    group = 'com.example'
    version = '0.0.1-SNAPSHOT'

    apply plugin: 'java'
    apply plugin: 'org.springframework.boot'
    apply plugin: 'io.spring.dependency-management'

    java {
        toolchain {
            languageVersion = JavaLanguageVersion.of(21)
        }
    }

    bootJar.enabled = true
    jar.enabled = false

    tasks.named('test') {
        useJUnitPlatform()
    }

    ext {
        set('springCloudVersion', "2023.0.3")
    }

    repositories {
        mavenCentral()
    }

    dependencies {
        implementation 'org.springframework.boot:spring-boot-starter'
        testImplementation 'org.springframework.boot:spring-boot-starter-test'
        testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

        // 공통으로 사용할 의존성 추가
    }

    dependencyManagement {
        imports {
            mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
        }
    }
}

 

 

하위 모듈에 주입할 내용들은 subprojects {} 안에 넣어준다. 

실행 목적을 가진 하위 모듈은 bootJar만 활성화 하고 Jar는 비활성화 해준다.

 

하지만 common 모듈 같이 다른 모듈에서 공유해야 하는 경우라면 BooJar를 비활성화 하고 Jar는 활성화 해준다. 

 

 

project(':common') {

    bootJar { enabled = false } // 공통 모듈은 bootJar 로 패키징 할 필요 없음
    jar { enabled = true }

    dependencies {
    }
}

 

이렇게 루트 모듈에서 하위 모듈을 특정해서 gradle 설정을 해줄 수도 있고, common 모듈의 build.gradle 파일에서 직접 설정할 수 있다. 

 

 

 

 

 

루트 모듈의 setting.gradle 설정

rootProject.name = [루트 모듈]
include [하위 모듈1]
include [하위 모듈2]
include [하위 모듈3]
include [하위 모듈4]
include [하위 모듈5]
...

 

루트 모듈에서 설정한 build.gradle 파일을 주입할 모듈 들을 include 해주면 spring boot에서 multi module 설정이 끝이난다.

 

이후 gradle refresh를 돌려보면 아래 처럼 루트 모듈 하나만 뜨고 그 아래에 하위 모듈이 떠야한다. 

상위에 여러 개가 뜬다면 설정이 잘못된 경우이다. 

 

 

 

 

이렇게 구성이 됐다면 모듈들을 이렇게 모아서 볼 수 있고 복수 선택 후 한번에 실행도 가능하다. 너무 편한 것... 😀