Spring Boot Maven Plugin

🔨 Apache Maven

Apache Maven은 소프트웨어 프로젝트 관리 및 이해 도구이다. project obejct model (POM) 개념을 바탕으로 Maven은 프로젝트의 build, reporting, documentation 을 관리할 수 있다.

기본적으로 Eclipse나 intelliJ에는 Maven이 내장되어 있으나, 따로 Maven을 설치해서 사용해도 된다.
https://maven.apache.org/download.cgi

또한, Spring Initializr을 이용하여 Spring Boot Project를 생성할 때에는 기본적으로 mvnw와 mvnw.cmd 파일이 포함되어있다.
https://start.spring.io/

Maven Wrapper(mvnw)은 Maven을 설치하지 않아도 Maven Build를 할 수 있다. Apache Maven을 프로젝트에서 요구하는 버전으로 유지하기 위해 사용하는 유용한 도구이며 Gradle Wrapper와 같은 개념의 도구이다.

// 일반적인 Maven 명령어
mvn clean package

// mvnw을 이용한 명령어
./mvnw clean package		// linux
mvnw.cmd clean install		// windows

---

🔖 Spring Boot Maven Plugin

Spring Boot Maven Plugin은 다음과 같은 Spring Boot 지원을 제공한다.
1. 프로젝트를 실행가능한 jar 파일이나 war 파일로 패키지(package)
2. Spring Boot 애플리케이션 실행
3. Build 정보 생성
4. 통합 테스트를 하기 전에 Spring Boot 애플리케이션을 시작

Spring Boot Maven Plugin을 사용하려면 pom.xml 안에 plugins 색션에 적절히 추가한다.

<project>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>getting-started</artifactId>
    <!-- ... -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

Milestone(M) 또는 SNAPSHOT release를 사용하려면, 적절한 pluginRepository 속성들을 추가해야한다.

• Milestone(M) : 테스트 버전
• SNAPSHOT : 개발단계, 일종의 백업시점

<pluginRepositories>
    <pluginRepository>
        <id>spring-snapshots</id>
        <url>https://repo.spring.io/snapshot</url>
    </pluginRepository>
    <pluginRepository>
        <id>spring-milestones</id>
        <url>https://repo.spring.io/milestone</url>
    </pluginRepository>
</pluginRepositories>

---

🔖 Spring Boot Maven Plugin 설정

spring-boot-starter-parent 스타터를 parent로 추가하고 Spring Boot 버전만 설정하면 된다. 다른 스타터들을 추가할때에는 버전을 제거할 수 있다.

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.4</version>
</parent>

spring-boot-starter-parent-{version}.pom을 확인해보면 parent로 spring-boot-dependencies가 설정되어 있다.

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.5.4</version>
</parent>

maven pom 상속 구조가 [현재 spring boot project] -> [spring-boot-starter-parent] -> [spring-boot-dependencies] 순으로 되어 있다는 것을 알 수 있다.

spring-boot-dependencies-{version}.pom에는 Spring Boot에서 지원하는 모든 의존 라이브러리들에 대한 버전이 선언되어 있다.

spring-boot-dependencies에서 제공하는 버전을 바꾸고 싶다면 properties 속성에 추가하면 된다.

<properties>
    <activemq.version>5.16.2</activemq.version>
    <spring.version>5.0.6.RELEASE</spring.version>
</properties>

---

🔖 Goals

Spring Boot Plugin은 다음과 같은 goal들을 가지고 있다.

Goal	설명
spring-boot:build-image	OCI image로 패키지
spring-boot:build-info	build-info.properties 파일 생성
spring-boot:repackage	Repackage, Jar나 War 파일로 재패키지
spring-boot:run	현재 위치에서 애플리케이션을 실행
spring-boot:start	Spring 애플리케이션을 시작, "run" goal과 달리 애플리케이션 작동을 block하지 않고 다른 goal들을 허용
spring-boot:stop	"start" goal로 시작된 애플리케이션을 종료

---

🔖 Packaging

"repakcage" goal로 프로젝트를 실행가능한 jar/war 파일로 패키지한다.

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

spring-boot-starter-parent 스타터를 사용한다면, repackage execution으로 미리 구성되어 있기에 plugin 정의만 추가되면 된다.

위의 예시는 pom.xml에 정의된 "provided" dependency들을 모두 포함하여 jar/war 파일로 패키징한다. package 단계에서 제외하기 원하는 dependency들은 exclude 옵션을 사용한다.

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

파라미터

파라미터명	Type	기본값	설명
outputDirectory	File	${project.build.directory}	생성된 파일이 저장될 폴더
attach	Boolean	true	true : repackage jar/war 배포, false : repackage jar/war 배포 안함
classifier	String		repackage jar/war 파일에 추가할 분류자, 설정하지 않으면 일반 jar/war를 대체
excludeDevtools	Boolean	true	Repackaing시, Spring Boot devtools 배제 여부
excludeGroupIds	String		Repackaing시, 배제할 groupId 리스트
excludes	List		Repackaging시, 배제할 dependency
includeSystemScope	Boolean	false	system 스코프 라이브러리들을 포함 여부
includes	List		Repackaing시, 포함할 dependency
skip	Boolean	false	실행 건너뛰기

---

🔖 War Packaging

war로 패키징하여 외부 Tomcat으로 배포할 경우에는 추가적인 설정이 필요하다.

1) packaging 속성을 war로 설정

<packaging>war</packaging>

2) spring-boot-starter-tomcat 스타터 스코프 변경

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

"provided" 스코프는 runtime 시점에 JDK나 컨테이너에 의해 제공되는 의존 라이브러리들을 표시한다.

3) spring-boot-maven-plugin classifier 설정

classifier을 설정하면 실행가능한 war파일과 original war파일이 분리되어 생성된다. 실행가능한 war파일의 이름이 설정된 classifier가 뒤에 붙어서 생성된다.

<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <configuration>
                            <classifier>exec</classifier>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

4) Application.java에 SpringBootServletInitailizer 상속 추가

이전의 웹 애플리케이션은 /WEB_INF 디렉토리 안에 하나의 web.xml을 가지고 있었다. web.xml은 Web Application Deployment Descriptor(DD)로써, 웹 애플리케이션을 구동시킬 때 올라가야할 설정들(DispatcherServlet, ContextLoaderListener, Filter)을 정의하는 곳이다.

Sevlet 3.0부터 web.xml 파일 없이도 WebApplicationInitializer 인터페이스로 설정들을 정의할 수 있다.
SpringBootServeltInitalizer은 WebApplicationInitializer 인터페이스를 구현하였으며, SpringApplication을 전통적인 WAR 배포로 실행할 수 있게 해준다.

@SpringBootApplication
public class NodeApplication extends SpringBootServletInitializer {

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

	@Override
	protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
		return builder.sources(NodeApplication.class);
	}

}

🐑 End..