Gradle로 멀티모듈 프로젝트 구성하기

서론

현재 제가 있는 부서에서는 같은 데이터베이스를 공유하는 다수의 프로젝트가 존재하는데, 하나의 도메인을 공유하고 깃을 따로 관리하기 위해 도메인 클래스들은 멀티 프로젝트에 Nexus Maven 저장소를 이용해서 도메인 클래스를 분리하는 형태로 사용하고 있습니다. 저는 이미 세팅이 된 환경에서 개발을 하고 있기에 따로 설정에 관해서는 건드릴 부분이 없기도 하고, 직접 구성해 본 적도 없어서 이번기회에 정리와 함께 직접 환경 구성을 해보고자 포스팅하게 되었습니다.

이번 게시글에서는 멀티모듈의 정의와 Gradle을 이용한 멀티모듈의 구성에 대해 정리해보겠습니다.

목차

1. 멀티모듈이란?
2. Gradle로 멀티모듈 구성하기
3. 테스트

테스트 환경

• Apple Silicon (M1), IntelliJ
• Java 11, Spring Boot, JPA, Gradle
• Docker MySQL

소스 확인

https://github.com/dkswnkk/multi-module-test/tree/main/multi-module-project

 

멀티모듈이란?

멀티 모듈은 하나의 프로젝트를 여러 개의 작은 모듈로 나누어서 개발하고 관리하는 방식을 의미합니다. 각각의 모듈은 독립적으로 개발 및 빌드될 수 있고, 필요할 경우 다른 모듈과 의존성을 가질 수 있습니다. 현재 많은 프로그래밍 언어와 프레임워크에서 멀티모듈을 지원하며, Java에서는 Maven, Gradle과 같은 빌드 도구를 사용하여 멀티모듈을 구성할 수 있고, Python에서는 setuptools, Node.js에서는 npm 등이 있습니다.

즉, 애플리케이션에서 공통으로 사용하는 Util, Domain, Repository 등을 공통 모듈로 분리해 사용할 수 있습니다.

좀 더 직관적으로 예를 들어서 알아보겠습니다.

먼저 위 이미지는 단일 프로젝트입니다. API 서버, Batch 서버, Admin 서버는 각각이 독립된 프로젝트이며, 각각의 서버들은 Spring Boot + JPA를 사용하고 있기에 User 엔티티를 필요로 하고 있습니다. 따라서 각 서버마다, 공통된 User라는 도메인을 가지고 있어야 서비스 로직을 구성할 수 있습니다.

반대로 위 이미지는 멀티 모듈 프로젝트입니다. API 서버, Batch 서버, Admin 서버는 각각의 서버마다 가진 User 엔티티가 아니라 동일한 하나의 User 엔티티에 의존하고 있습니다.

위 예시를 통해 단일 프로젝트의 경우에 크게 다음 두 가지의 문제점이 생긴다는 것을 알 수 있습니다.

• 공통적인 코드 처리 필요: 동일한 하나의 데이터베이스를 사용하지만 domain을 각각의 프로젝트에 선언했기 때문에, 동일성을 보장하기 위해 API 서버에서 도메인이 변경되면 동일한 작업을 Batch 서버에도 진행해야 한다.
• 휴먼 에러: 프로젝트가 커질수록 공통된 코드들을 사람의 실수로 일치시키지 못해 에러가 발생활 확률이 높아집니다.

즉, 한 프로젝트에서 도메인(Entity) 클래스에 변수를 추가한 경우에 다른 모든 프로젝트에서도 동일하게 추가해주지 않으면 데이터베이스 조회 시 등 에러가 발생할 수밖에 없는데 이런 copy & paste 반복 작업을 개발자가 손수 하다 보면 휴먼에러가 발생할 수밖에 없음은 물론 같은 데이터베이스를 사용하는 Entity 임에도 불구하고 코드가 모두 다른 이상한 상황이 발생하게 됩니다.

 

Gradle로 멀티모듈 구성하기

이제 멀티모듈 프로젝트를 한번 구성해 보겠습니다.

New Project > Gradle > Java > NEXT

먼저 저는 multi-module-project라는 Gradle 프로젝트를 생성했습니다. 여기서 이 프로젝트가 루트 프로젝트가 되며 다른 모든 하위 모듈들을 관리하는 역할을 하게 됩니다.

multi-module-project의 구성

루트 프로젝트는 하위 모듈을 관리하는 역할만 하기 때문에 불필요한 src폴더와 같은 구성들을 제거해 줍니다.

Root 모듈 클릭 > New > Module..

다음으로 Root 모듈 클릭 > New > Module.. 을 통해 다른 프로젝트 또한 생성합니다. 

저는 위와 같이 간단하게 multi-module-api, multi-module-batch, multi-module-database을 Spring Project 모듈로 만들었습니다.

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

mult-module-project > setting.gradles

그 후, mult-module-project의 setting.gradles에서 모듈들을 include 해줍니다.

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

repositories {
    mavenCentral()
}

bootJar.enabled = false

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'
        implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    }

    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 }
}

multi-module-project, 즉 root 프로젝트의 build.gradle는 위를 참고하여 설정합니다.

multi-module-database를 bootJar로 패키징 할 필요가 없는 이유는 database와 같이 Entity Class를 주로 모아 놓은 클래스인 경우 main() 메서드가 필요하지 않습니다. bootJar 작업은 실행 가능한 jar을 생성하려고 시도하기 위해 main() 메서드가 필요하지만, multi-module-database는 main() 없이 라이브러리의 역할을 하는 모듈이기 때문에 false로 비활성화하도록 합니다.

만약 "Could not find method compile() for arguments" 에러가 발생한다면  원인은 compile, testCompile, runtime, testRuntime을 Gradle 7.0 버전에서 더 이상 사용할 수 없기 때문입니다. 

따라서 Gradle 7.0 버전 이상을 사용하고 있다면 implementation, testImplementation, runtimeOnly, testRuntimeOnly로 변경하여 사용하면 됩니다.

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

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

multi-module-api 프로젝트와 multi-module-baatch의 build.gradle 설정은 각각 순서대로 위와 같습니다.

빌드 수행 결과

그리고 빌드를 수행하면 위와 같이 multi-module-database가 multi-module-api와 multi-module-batch에 정상적으로 의존성을 가지고 있는 걸 확인할 수 있습니다.

 

테스트 진행

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String email;

    private String password;

    public User(String email, String password) {
        this.email = email;
        this.password = password;
    }
}


public interface UserRepository extends JpaRepository<User, Long> {
}

그리고 간단하게 테스트를 진행하기 위해 multi-module-database에 엔티티와 Repository를 위와 같이 추가했습니다. 

@Controller
@RequiredArgsConstructor
public class ApiController {

    private static final String EMAIL = "email@gmail.com";
    private static final String PASSWORD = "password";

    private final UserRepository userRepository;

    @PostMapping("/sign-up")
    public void signUp() {
        userRepository.save(new User(EMAIL, PASSWORD));
    }
}

마찬가지로 multi-module-api에는 위와 같이 Controller를 구성했습니다.

API 호출

값 저장 되는 것 확인

그리고 multi-module-api 프로젝트 실행 후 API를 호출하면 정상적으로 값이 DB에 저장되는 것을 확인할 수 있습니다.

"Parameter 0 of constructor in com.example.multimoduleapi.ApiController required a bean of type 'com.example.multimoduledatabase.UserRepository' that could not be found."

만약 위와 같은 오류가 발생했다면 multi-module-api에서 multi-module-databse의 Entity와 Repository를 Scan 하지 못했기 때문입니다.

@SpringBootApplication
@EntityScan(basePackages = {"com.example.multimoduledatabase"})
@EnableJpaRepositories(basePackages = {"com.example.multimoduledatabase"})
public class MultiModuleApiApplication {
    public static void main(String[] args) {
        SpringApplication.run(MultiModuleApiApplication.class, args);
    }
}

해결법은 위와 같이 @EntityScan과 @EnableJpaRepositories를 이용해 basePackages 값을 작성해 주시면 됩니다.

 

참고

1. https://techblog.woowahan.com/2637/
2. https://velog.io/@soyeon207/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B6%80%ED%8A%B8-%EB%A9%80%ED%8B%B0-%EB%AA%A8%EB%93%88-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EB%A7%8C%EB%93%A4%EA%B8%B0