모듈이란?

• 사전마다 거의 재각각으로 설명이 되어있지만, 공통적으로 나오는 내용으로 정리했을 때 모듈이라는 개념은 독립적으로 운영될 수 있는 의미를 가지는 구성요소 단위
  • 일반적으로 모듈은 독립적으로 컴파일, 패키지, 테스트 및 배포될 수 있는 단위

모듈은 여러 가지로 정의될 수 있지만, 일반적으로 큰 체계의 구성요소이고, 다른 구성요소와 독립적으로 운영된다.

출처: wikipedia

멀티 모듈이란?

• 오라클 자바 문서에서는, 모듈을 패키지의 한 단계 위의 집합체이며, 관련된 패키지와 리소스들의 재사용할 수 있는 그룹이라고 정의

일반적으로 우리가 코드의 재사용성을 높일 때는 코드의 중복이 생기거나 겹치는 부분이 생겼을 때다.

• 회원 시스템을 개발한다고 했을 때, 위와 같이 세 가지의 독립적인 프로젝트가 나온다고 가정하자.
• 이런 구조를 가지고 있을 때 가장 큰 문제점은 시스템의 중심 Domain이 가져야할 구조와 규칙을 동일하게 보장해주는 메커니즘이 없다.
• 개발자는 동일한 Member 도메인을 가지고 있는 세 어플리케이션을 매우 귀찮고 불안하게 복사&붙여넣기를 하며 개발할 것이다.

• 그래서 멀티 모듈은 공통으로 사용하는 코드를 모아놓고 같이 슬 수 있게 하는 기능이다.

멀티 모듈 사용

1. 모듈 생성

• 예시로 사용할 간단한 프로젝트

• multi-module-api: API 관련 모듈
• multi-module-batch: Batch 관련 모듈
• multi-module-database: multi-module-api와 multi-module-batch에서 공통으로 사용하는 모듈(쉽게 말하면 현재 예시에서는 엔티티)

2. settings.gradle 설정

rootProject.name = 'multi-module-project'
include 'multi-module-database'
include 'multi-module-api'
include 'multi-module-batch'

• rootProject와 그 하위 프로젝트를 include해준다.

3. rootProject gradle 설정

plugins {
    id 'java'
    id 'org.springframework.boot' version '2.7.9'
}

repositories {
    mavenCentral()
}

bootJar.enabled = false

// subprojects는 settings.gradle에 include된 프로젝트 전부를 관리
subprojects {
    group = 'com.example'
    version = '0.0.1-SNAPSHOT'
    sourceCompatibility = '11'

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

    configurations {
        compileOnly {
            extendsFrom annotationProcessor
        }
    }

    repositories {
        mavenCentral()
    }

    // 관리하는 모듈의 공통 dependencies
    dependencies {
        compileOnly 'org.projectlombok:lombok'
        annotationProcessor 'org.projectlombok:lombok'
    }

    test {
        useJUnitPlatform()
    }
}

project(':multi-module-api') { // 컴파일 시 multi-module-database 로딩
    dependencies {
        compileOnly project(':multi-module-database')
    }
}

project(':multi-module-batch') { // 컴파일 시 multi-module-database 로딩
    dependencies {
        compileOnly project(':multi-module-database')
    }
}

project(':multi-module-database') { 
// multi-module-databse는 bootJar로 패키징 할 필요 없음
    bootJar { enabled = false }
    jar { enabled = true }
}

• rootProject와 그 하위에 있는 multi-module-database 는 jar 파일을 생성할 필요가 없다.
• 중점적으로 봐야할 것은 subprojects와 project()다.
  • subprojects는 settings.gradle에 include된 프로젝트 전부를 관리
    • 위 예시에서는 SpringBoot와 Java에 의존성을 두고 있기에 관련된 plugin을 등록
  • project의 경우 하위 프로젝트간의 의존성을 관리
    • 위 예시에서는 module-api와 module-web은 모두 module-common에 의존하고 있기 때문에 이를 등록

이전에 추가했던 multi-module-database 에 대한 의존성이 multi-module-api와 multi-module-batch에 잘 주입된 것을 확인할 수 있다.

4. 하위 프로젝트 gradle 설정

//multi-module-api
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    implementation project(':multi-module-database')
}

//multi-module-batch
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-batch'
    testImplementation 'org.springframework.batch:spring-batch-test'
    implementation project(':multi-module-database')
}

//multi-module-database
dependencies {
    runtimeOnly 'com.h2database:h2'
		implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
}

5. 테스트

• 아주 간단하게 위 설정들이 제대로 동작하는지에 대한 테스트
  

• Controller는 multi-module-api에 존재한다.
  

• Entity는 multi-module-database에 존재한다.

• 위와 같이 요청을 보내면, 200OK가 뜨면서

• DB에까지 잘 추가가 완료되었다.

멀티 모듈을 사용하면,

1. 코드의 중복을 줄일 수 있다.

• 공통된 로직이 있는 여러 서비스를 운영하게 되었을 때, 공통된 부분을 모듈화하고, 의존성을 추가하여 공유할 수 있다.

2. 각 모듈의 기능을 파악하기 쉬워진다.

• 공통의 기능은 의존성 주입으로, 모듈별로 기능을 분리하여 작성하기 때문에, 코드의 이해가 쉬워진다.

3. 빌드를 쉽게 진행할 수 있다.

• ./gradlew :moduleName:build 을 통해 빌드를 쉽게 진행할 수 있다.
• 이전의 경우에는 프로젝트 빌드/테스트를 별도로 각각 진행했던 반면에, 멀티 모듈의 위 명령어를 통해 각각 빌드할 수 있다.

💡참고 자료💡
https://tecoble.techcourse.co.kr/post/2021-09-06-multi-module/
https://techblog.woowahan.com/2637/
https://jojoldu.tistory.com/123
https://dkswnkk.tistory.com/691