[Spring] 멀티 모듈 프로젝트 적용

😎 멀티 모듈을 도입한 이유

 

멀티 모듈 적용 전

 

위 이미지는 진행중인 하우스 프로젝트에서 멀티 모듈을 적용하기 전의 패키지 구조입니다.

기존에는 서비스의 모든 코드들이 단일 모듈에 포함된 상태였습니다.

 

하우스 프로젝트는 푸시 알림 기능을 포함하고 있는데, 푸시 알림을 전송하는 서버를 분리하기로 결정했습니다.

하우스 서버 → 하우스 API 서버, 하우스 알림 서버

 

이 때, API 서버와 알림 서버 모두 domain 패키지의 코드, external.client 패키지의 코드, common 패키지의 코드를 그대로 재사용해야 했습니다. 하지만 유지 보수 측면에서 바라봤을 때, 서버가 둘로 분리되면서 공통된 패키지의 내용이 수정되면 매번 API 서버와 알림 서버의 코드를 함께 수정해줘야 하는 불편함이 발생할 수 있었습니다.

 

이러한 불편함을 해소하기 위한 방안으로 멀티 모듈 도입을 결정했습니다. 🤩

 

 

🤔 멀티 모듈이란?

 

멀티 모듈은 하나의 시스템이나 프로젝트를 여러 개의 독립적인 모듈로 분리하여 구성하는 방식입니다.

모듈화된 구조는 코드의 재사용성을 높여주는데, 비슷한 기능을 가진 모듈을 다른 프로젝트에서도 재사용해서 개발 시간과 노력을 절약할 수 있다는 장점이 있습니다.

 

멀티 모듈 적용 후

 

위 이미지는 단일 모듈로 구성되었던 하우스 프로젝트에 멀티 모듈 적용을 완료한 모습입니다.

전체 코드는 깃허브에서 확인할 수 있습니다.

API 서버(hous-api)와 알림 서버(hous-notification)에서 공통적으로 사용되는 부분을 hous-common, hous-core, hous-external 모듈로 구성했습니다.

이렇게 구성을 한 덕분에, 공통된 부분에서 수정사항이 발생해도 분리한 모듈에서 한 번만 수정을 하면 되기 때문에 유지 보수 측면에서 더 간편해졌습니다.

 

 

👻 멀티 모듈 적용 방법

 

이제 멀티 모듈을 적용하기 위한 방법들을 살펴보겠습니다!

 

🔮 새로운 모듈 추가

 

 

먼저 새로운 모듈을 추가할 때는 최상단 프로젝트에서 마우스 우클릭을 하고 New > Module 을 선택합니다.

이후 모듈 이름을 지정하고 생성하면 새로운 모듈이 만들어집니다.

 

settings.gradle

 

모듈이 생성되면 settings.gradle 파일에 자동으로 새로운 모듈이 include 됩니다.

이는 새로운 폴더를 생성하고 직접 include 해줘도 모듈로 인식된다는 의미입니다.

 

 

🔮 build.gradle 설정

 

다음은 build.gradle 을 설정할 차례입니다.

우선 최상단 프로젝트의 build.gradle 파일입니다.

 

// server/build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
}

plugins {
    id "org.springframework.boot" version "2.7.1"
    id "io.spring.dependency-management" version "1.0.11.RELEASE"
    id "java"
}

// 하위 모든 프로젝트 공통 세팅
subprojects {
    apply plugin: "org.springframework.boot"
    apply plugin: "io.spring.dependency-management"
    apply plugin: "java"

    group = "hous"
    version = "1.0.7-SNAPSHOT"
    sourceCompatibility = "11"

    repositories {
        mavenCentral()
    }

    configurations {
        compileOnly {
            extendsFrom annotationProcessor
        }
    }

    dependencies {
        compileOnly "org.projectlombok:lombok"
        annotationProcessor "org.projectlombok:lombok"
        testCompileOnly("org.projectlombok:lombok")
        testAnnotationProcessor("org.projectlombok:lombok")
        testImplementation("org.springframework.boot:spring-boot-starter-test") {
            exclude group: "org.junit.vintage", module: "junit-vintage-engine"
        }
    }

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

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

 

단일 모듈 프로젝트의 build.gradle 파일과 다른 부분을 살펴보면 subprojects 가 있습니다.

subprojects 에는 setting.gradle 에 include 된 모든 프로젝트에 공통적으로 적용할 설정을 작성하면 됩니다.

 

이제 하위 프로젝트들의 build.gradle 을 살펴보겠습니다.

먼저 공통된 부분인 hous-common, hous-core, hous-external 의 build.gradle 파일입니다.

 

// server/hous-common/build.gradle

bootJar { enabled = false }
jar { enabled = true }

dependencies {
    ...
}

// server/hous-core/build.gradle

bootJar { enabled = false }
jar { enabled = true }

dependencies {
    implementation project(":hous-common")
    ...
}

// server/hous-external/build.gradle

bootJar { enabled = false }
jar { enabled = true }

dependencies {
    implementation project(":hous-common")
    ...
}

 

다음은 API 서버(hous-api)와 알림 서버(hous-notification)의 build.gradle 파일입니다.

 

// server/hous-api/build.gradle

dependencies {
    implementation project(":hous-core")
    implementation project(":hous-common")
    implementation project(":hous-external")
		...
}

// server/hous-notification/build.gradle

dependencies {
    implementation project(":hous-core")
    implementation project(":hous-common")
    implementation project(":hous-external")
		...
}

 

공통된 모듈의 build.gradle 내용을 보면 아래와 같은 부분이 있습니다.

 

• bootJar { enabled = false } : Spring Boot는 기본적으로 bootJar 태스크를 사용하여 실행 가능한 JAR 파일을 생성합니다. 이 옵션을 false 로 설정하면, 빌드 프로세스 중에 실행 가능한 JAR 파일이 생성되지 않습니다.

• jar { enabled = true } : 일반적인 Java 프로젝트에서 생성되는 JAR 파일을 활성화하는 설정입니다. 이 옵션을 true 로 설정하면, 빌드 프로세스 중에 일반적인 JAR 파일이 생성됩니다. 일반적으로 이 JAR 파일은 프로젝트의 컴파일된 클래스 파일 및 리소스 파일을 포함합니다.

 

공통된 부분인 hous-common, hous-core, hous-external 모듈들은 개별적으로 실행되지 않고, API 서버와 알림 서버에 포함되기 때문에 위와 같은 옵션을 추가합니다.

 

마지막으로 모듈간의 의존성을 설정하면 됩니다.

• implementation project(":some-module") : 의존성 관리를 설정하는 부분입니다. 이 설정은 현재 프로젝트가 some-module 프로젝트에 의존한다는 것을 나타냅니다.

 

❗️ 주의할 점

모듈간의 의존성을 설정할 때 순환참조가 에러가 발생하지 않도록 주의해야 합니다.

예를 들어,
hous-core 모듈에서 hous-common 의 코드를 사용하고,
hous-common 모듈에서 hous-core 의 코드를 사용하는 경우가 순환참조가 일어나는 상황입니다!

그렇기 때문에 멀티 모듈을 설계할 때, 각 모듈의 역할을 명확히 하고 의존성 구조를 주의해서 설계해야 합니다.

 

 

🔮 Component Scan 패키지 등록

 

현재 API 서버와, 알림 서버에서는 hous-common, hous-core, hous-external 모듈의 코드를 사용하고 있습니다. 하지만, 별다른 설정을 하지 않는다면 Spring 은 다른 모듈에 있는 클래스들을 Bean 으로 등록할 수 없습니다.

 

@SpringBootApplication(scanBasePackages = {"hous.core", "hous.common", "hous.external", "hous.api"})
public class ApiApplication {

	public static void main(String[] args) {
		SpringApplication.run(ApiApplication.class, args);
	}
}

 

위와 같이 scanBasePackages 에 패키지 이름들을 입력해줘서 Component Scan 시에 스캔할 패키지를 지정해야 Spring 이 정상적으로 모든 Bean 들을 등록할 수 있게 됩니다.

 

 

👻 멀티 모듈 빌드 방법

 

API 서버와 알림 서버를 빌드하는 방법은 다음과 같습니다.

 

# API 서버
./gradlew hous-api:bootJar

# 알림 서버
./gradlew hous-notification:bootJar