Spring 인텔리제이 Service, Common, Batch 모듈 분리하기 (Maven)

🙄 배경

토이 프로젝트와 회사 프로젝트에서 Spring, IntelliJ, Maven을 기반으로 모듈 분리를 하면서 알게된 모듈 분리 방법과 모듈 분리 과정에서 겪을 수 있는 문제를 해결하는 설정 방법에 대해 공유하고자 한다.

👍 모듈 분리를 해야 하는 이유?

- 의존성 최소화

예를 들어, 동일한 모듈에서 배치 서비스를 개발할 때는 스프링 시큐리티가 필요 없을 수 있는데, 이때 동일한 모듈이라는 이유로 강제로 스프링 시큐리티 의존성을 포함하게 되면서 개발/테스트 과정에서 시큐리티 때문에 영향을 받을 수 있다.

 

모듈을 분리하면 필요한 최소 의존성만 관리함으로써 이러한 의존성 관련 문제/영향을 고려하지 않아도 된다.

- 유지보수

특정 모듈에 장애가 발생한다면 해당 모듈만 확인하면 되기 때문에 문제를 해결하기 쉬워진다. 또한, 장애로 해당 모듈이 갑작스럽게 종료된다고 해도 다른 서비스 모듈들은 영향을 받지 않기 때문에 피해를 최소화할 수 있다는 장점도 있다.

0. 준비

포스팅에 사용된 환경은 다음과 같다.

 

- JDK17

- IntelliJ

- Maven

- Spring Boot 3.1.3

 

가장 흔하고 예시로 적절하다고 생각하는 서비스, 공통, 배치 모듈 3개로 분리해보려고 한다.

1. 프로젝트 생성

2. 모듈 생성하기

File > New > Module > New Module에 접근해서 service, batch, common을 생성한다.

 

 

모듈을 모두 생성하면 아래와 같은 구조가 된다.

 

3. 각 모듈에 의존성 추가하기

각 모듈에 필요한 의존성을 pom.xml에 추가한다.

 

이름	추가한 모듈
service	web, security, security-test, common
batch	batch, batch-test, common
common	data-jpa, mariadb, h2
parent	lombok, starter-test

lombok과 starter-test는 어디에서도 쓸 수 있기 때문에 parent 모듈에 의존성을 추가했다.

4. 플러그인 추가하기

spring-boot-maven-plugin 플러그인을 추가한다.

(해당 플러그인은 패키징 할 때 executable jar 파일로 구조를 변경해 주는 역할을 한다.)

 

spring-boot-maven-plugin는 메인 클래스가 포함된 모듈에만 추가해야 하므로, 라이브러리 역할을 하는 common 모듈 외에 service, batch 모듈에 별도로 추가한다.

(common에도 포함하면 main 클래스를 찾지 못해 패키징에 실패하게 된다.)

 

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

 

플러그인까지 추가가 완료되면, 기본적인 모듈 분리는 이걸로 끝이 난다.

하지만 이대로 애플리케이션을 실행하려고 하면 에러가 발생할 수밖에 없다.

 

이제 서비스 모듈에서 JPA와 common 모듈을 스캔하는 설정 방법에 대해서 알아보자.

5. 설정

service에서는 common 모듈에 있는 클래스들을 함께 사용할 것이므로 때문에, common 모듈 패키지까지 포함해서 컴포넌트 스캔을 해야 한다.

 

@SpringBootApplication(scanBasePackages = {"com.example"})
public class ServiceApplication {

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

 

service 모듈의 패키지 경로는 com.example.service이고, common 모듈의 패키지 경로는 com.example.common 이므로 상위 패키지 경로인 com.example 까지만 입력하면 관련 모든 설정을 가지고 올 수 있다. 만약, 패키지 경로가 공통된 부분이 없거나 다르게 나눠야 하는 등 다른 경우가 있다면 필요에 따라 추가적으로 경로를 작성하면 된다.

 

하지만 컴포넌트 스캔을 했음에도, JPA를 사용하는 경우는 애플리케이션을 실행할 때 Repository 부분에서 해당 Bean을 찾지 못한다는 문제가 발생할 수 있다.

 

보통 JPA를 사용한다면 common 모듈에 Entity, Repository 등 JPA와 관련된 클래스를 작성할 텐데, 이들을 사용하기 위해서는 별도 설정이 필요하다.

 

@Configuration
@EntityScan(basePackages = "com.example.common.entity")
@EnableJpaRepositories(basePackages = "com.example.common.repository")
@EnableJpaAuditing
public class JpaConfig {

}

 

Spring Data JPA에서 지원하는 @EntityScan, @EnableJpaRepositories 어노테이션을 사용하여 엔티티 패키지와 Repository 패키지 경로를 따로 설정 파일에 작성해야 service 모듈에서 사용할 수 있다.

 

만약 BaseEntity 등의 공통 엔티티를 사용하는 경우라면 @EnableJpaAuditing도 함께 사용하여 JPA 관련 설정을 하나의 클래스에 작성하면 관리하기 좋다.

 

REFERENCE

https://stackoverflow.com/questions/70833195/spring-boot-multi-module-spring-boot-maven-plugin-compilation-failure