본문 바로가기

Spring

[Spring] Maven 빌드 플러그인 세팅

maven을 이용한 빌드 실행 시 플러그인을 설정하여 필요한 기능을 추가할 수 있다.
Maven 플러그인 중 빌드 설정 시 필수로 필요했던 몇가지 설정을 알아보고자 한다.

 

빌드 실행

$ mvn clean package $ java -jar target/[프로젝트명].jar

mvn clean install VS mvn clean package

 

로컬 maven 폴더에 jar 파일 저장 유무가 다르다.

  • Install
  • 프로젝트 하위 .target 폴더 + mvn 폴더 내 repository 폴더에 각각 jar 생성
  • Package
  • 프로젝트 하위 .target 폴더에만 jar 생성

 

빌드 시 Junit 테스트 실행 설정

<build> 
    <plugins> 
        <plugin> 
            <groupId>org.apache.maven.plugins</groupId> 
            <artifactId>maven-surefire-plugin</artifactId> 
            <version>2.12.1</version> 
            <configuration> 
                <skipTests>false</skipTests> 
            </configuration>
        </plugin> 
    </plugins>
</build>

태그 값이 false인 경우 빌드 시 junit 테스트가 실행되며

테스트 실패 시 빌드도 실패하게 된다.

true로 설정한 경우 테스트 성공여부와 상관없이 빌드도 성공하게 된다.

 

빌드 시 dependency 추가 설정

플러그인 세팅 없이 jar 파일로 내보낼 경우 프로젝트 dependency는 포함되지 않는다.
따라서 maven 빌드 플러그인을 세팅해야한다.

 

  • Maven-assembly-plugin
    • 내부에 dependency 전체를 저장하여 내보내기 때문에 용량이 큼
  • Maven-jar-plugin + maven-dependency-plugin
    • manifest.mf 파일에 라이브러리 상대 경로를 저장해서 불러오도록 함
    • maven-assembly-plugin 보다 상대적으로 가벼움

 

maven-assembly-plugin

<build> 
    <plugins> 
        <plugin> 
            <groupId>org.apache.maven.plugins</groupId> 
            <artifactId>maven-assembly-plugin</artifactId> 
            <version>3.2.0</version>
            <configuration> 
                <descriptorRefs> 
                    <descriptorRef>jar-with-dependencies</descriptorRef> 
                </descriptorRefs> 
            </configuration> 
            <executions> 
                <execution> 
                    <id>make-assembly</id> 
                    <!-- this is used for inheritance merges --> 
                    <phase\>package</phase\> 
                    <!-- bind to the packaging phase --> 
                    <goals> 
                        <goal>single</goal> 
                    </goals> 
                </execution> 
            </executions> 
        </plugin> 
    </plugins> 
</build>

 

maven-jar-plugin + maven-dependency-plugin

<build> 
    <plugins> 
        <plugin>
            <groupId>org.apache.maven.plugins</groupId> 
            <artifactId>maven-jar-plugin</artifactId> 
            <version>3.2.0</version> 
            <configuration> 
                <archive> 
                    <manifest> 
                        <addClasspath>true</addClasspath> 
                        <packageName>com.demo.sample</packageName> 
                        <classpathPrefix>lib/</classpathPrefix> 
                    </manifest> 
                </archive> 
            </configuration>
        </plugin> 
        <plugin> 
            <groupId>org.apache.maven.plugins</groupId> 
            <artifactId>maven-dependency-plugin</artifactId> 
            <executions> 
                <execution> 
                    <id>copy-dependencies</id> 
                    <phase>package</phase> 
                    <goals> 
                        <goal>copy-dependencies</goal>
                    </goals> 
                    <configuration> 
                        <outputDirectory>${project.build.directory}/lib</outputDirectory> 
                        <overWriteReleases>false</overWriteReleases>
                        <overWriteSnapshots>false</overWriteSnapshots> 
                        <overWriteIfNewer>true</overWriteIfNewer> 
                    </configuration>
                </execution> 
            </executions> 
        </plugin> 
    </plugins> 
</build>

 

빌드 오류 발생 시 처리

  • Mvn 명령어 없을 경우 (Mac 기준)
  • $ brew install mvn $ mvn -version
  • Maven-compiler-plugin 오류만약 1번에 설치한 버전과 충돌한다면 오류가 안나는 버전을 찾아 맞춰준다.
  • pom.xml에 maven-compiler-plugin 추가
<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-compiler-plugin</artifactId> 
    <version>3.8.1</version>
    <configuration> 
    	<source>${java.version}</source> 
        <target>${java.version}</target>
        <encoding>utf-8</encoding> 
    </configuration> 
</plugin>

 

참고

https://mand2.github.io/til/build-plugs-of-maven/
https://www.lesstif.com/java/maven-surefire-plugin-test-8912906.html