[Maven] Goal, Plugin, Phase, Lifecycle

1. Maven

• Java 프로젝트 빌드 툴
  • 빌드 프로세스를 단순화하려는 시도로 시작되었다.
  • 보통 Java 프로젝트에서 사용하지만 Java 프로젝트 뿐 아니라 JVM에서 동작하는 Kotlin or Scale에서도 사용할 수 있고 심지어 C#, Ruby에서도 사용 할 수 있다.

You can not only build Java projects with it, but pretty much every project written in a JVM language like Kotlin or Scala, as well as other languages like C# and Ruby.

 

 

2. 특징

1. 종속성 관리: 외부 라이브러리(3th-party dependency)를 현재 프로젝트에 쉽게 포함 시킬 수 있다.
   • 참고 : 서드파티는 프로그래밍을 도와주는 라이브러리를 만드는 외부 생산자를 뜻한다
   • Java - maven → JS - npm, Ruby - gems, PHP - composer 같은 역할이라고 생각하면 된다
   • 프로젝트에 사용할 라이브러리를 pom.xml에 dependency로 정의 해 놓으면, 메이븐이 repository에서 검색해서 자동으로 추가해준다. 심지어 각 라이브러리가 참조하고있는 라이브러리까지 모두 찾아서 추가해준다. 이것을 '의존성 전이' 라고 한다.
2. 컴파일: 이론적으로는 직접 javac 컴파일러를 이용해 큰 규모의 자바 프로젝트를 컴파일 할 수 있지만, 사실상 현실적으론 토이 프로젝트 일 때나 가능한 수준이다. Mavan을 사용한다면 mvn clean install 명령어를 이용해 손쉽게 전체 프로젝트 컴파일 및 패키징이 가능하다.
3. EveryThing Java: Maven은 코드 퀄리티 체크 및 테스트 케이스 실행, 심지어 외부 서버에 어플리케이션을 배포하는 것도 가능하다.

1. Dependency Management: Maven lets you easily include 3rd party dependencies (think libraries/frameworks such as Spring) in your project. An equivalent in other languages would be Javascript’s npm, Ruby’s gems or PHP’s composer.

2. Compilation through convention: In theory you could compile big Java projects with a ton of classes, by hand with the javac command line compiler (or automate that with a bash script). This does however only work for toy projects. Maven expects a certain directory structure for your Java source code to live in and when you later do a mvn clean install , the whole compilation and packaging work will be done for you.

3. Everything Java: Maven can also run code quality checks, execute test cases and even deploy applications to remote servers, through plugins. Pretty much every possible task you can think of.

 

 

 

3. Goal

A goal is actually just a Java method which does some specific task within your build.

• Maven에서 특정 작업을 수행하는 Java Method라고 생각하면 편하다.
  • 실제 Maven Goal은 void를 리턴하는 execute method 이다.
    • public void execute () {}

• 좀 더 상세히 구조를 살펴보자면, 위와 같이 ~Mojo class안에 하나의 goal(execute method)이 존재하는 구조이다.
  • Mojo: maven plain old java object

 

위에는 기본적으로 Maven과 함께 번들로 제공되는 Maven의 대표적인 Goal과 이를 포함하고 있는 플러그인이다. 물론 위에 나와 있는 Maven에서 제공하는 플러그인 외에 3rd party 플러그인도 사용할 수 있다.

• Goal 실행은 다음과 같이 가능하다.
• goal 실행 방법 : mvn <plugin name>:<goal name>

 

4. Plugin

• 하나 이상의 goal의 집합체.
• 비유하자면, goal은 메서드이고 Plugin은 goal을 메서드로 가지는 클래스라고 할 수 있다.

// failsafe plugin안에 있는 goal 설명 보기
mvn <PLUGIN>:help

mvn failsafe:help

// 결과
This plugin has 3 goals:

failsafe:help
  Display help information on maven-failsafe-plugin.
  Call mvn failsafe:help -Ddetail=true -Dgoal=<goal-name> to display parameter
  details.

failsafe:integration-test
  Run integration tests using Surefire.

failsafe:verify
  Verify integration tests ran using Surefire.

 

5. Phase

Going one level higher, Maven offers a neat way to group multiple goals from multiple plugins. This group of goals is called a phase

• 0개 ~ N개의 Goal들을 포함하는 일련의 그룹

 

• 예를 들어 jar라는 Goal은 package Phase의 일부이다 = jar goal is bound to the package phase

Maybe you’re wondering what’s the point of having this additional grouping of goals in phases?
Well the answer is that the Maven team wanted to make the system as configurable as possible.
But before I explain that fully, we need to go all the way up to the highest level concept which is the build lifecycle.

 

 

그리고 밑에는 대표적인 Phase에 대한 설명이다.

validate: check if all information necessary for the build is available
compile: compile the source code
test-compile: compile the test source code
test: run unit tests
package: package compiled source code into the distributable format (jar, war, …)
integration-test: process and deploy the package if needed to run integration tests
install: install the package to a local repository
deploy: copy the package to the remote repository

• mvn <phase> 명령을 실행하는 것은 phase에 지정된 plugin의 특정 goal을 실행하는 것이다.
• goal이 없는 phase도 있다.
• validate, initialize, verify .. 등이다.
• 이들을 독립적으로 실행되지 않고, lifecycle을 통해서만 실행된다.

 

• 다음 명령을 사용하여 특정 Phase에 바인딩된 모든 Goals와 해당 플러그인을 나열할 수 있다.

mvn help:describe -Dcmd=PHASENAME

mvn help:describe -Dcmd=compile

// 결과
compile' is a phase corresponding to this plugin:
org.apache.maven.plugins:maven-compiler-plugin:3.1:compile

 

6. Lifecycle

A build lifecycle is simply an ordered sequence of phases. The idea is that the lifecycle contains everything required for a full build.

• 라이프사이클은 단순히 Phase의 순서가 지정된 시퀀스이다 = Maven이 미리 정의 하고 있는 빌드 순서
  • ex) Default(Build) Maven 라이프사이클은 23단계로 구성되어 있으며 validata 및 initialization에서 install및 deploy에 이르는 Phase들을 포함한다. 그리고 각 Phase는 플러그인에 포함된 0 ~ N개의 goal과 매핑된다.

 

• 메이븐은 3개의 표준 라이프사이클을 제공한다.
  1. Clean : 빌드 시 생성되었던 Output을 지워준다 → target 폴더 삭제
  2. Default(Build) : 일반적인 빌드 프로세스를 위한 모델이다.
  3. Site : 프로젝트 문서와 사이트 작성을 수행한다.

 

 

When you pass a phase to the Maven command, first all previous phases in the lifecycle get executed, followed by the phase you specified.

• 만약 Maven Command로 phase(ex: mvn install)를 입력한다면, 해당 phase의 이전 phase가 모두 순서대로 실행된 다음 입력한 phase가 실행된다. (validate ~ intstall까지 전체 실행)
  • = 각각의 phase는 의존 관계를 가지고 있어 어떤 phase를 실행하면 이전 단계의 phase가 모두 수행 된다.
  • ex: 빌드 lifecycle의 마지막 단계인 mvn deploy를 수행하면 default lifecycle의 모든 phase가 실행된다.

 

 

📌 정리

다시 최상위 개념인 Lifecycle부터 정리해보자면,

Lifecycle

• Maven이 정의해 놓은 빌드 순서. 총 3개가 있다.(clean, default, site)
• 순서가 있는 phase들의 모음(?)

phase

• lifecycle의 각 단계.
• 예를 들어 clean lifecycle은 3개의 phase로 구성되어 있다. (pre-clean, clean, post-clean).
• 그리고 각 phase는 의존 관계를 갖고 있어 어떤 phase를 실행하면 이전 단계의 phase가 모두 수행된다.

goal

• 실제로 실행되는 메서드(혹은 실행 단위).
• 각 phase는 0개, 1개, 혹은 그 이상의 goal을 실행한다.

plugin

• goal들의 그룹. goal이 메서드라면 plugin은 클래스이다. (혹은 goal은 플러그인에 포함되어 있는 명령어정도로 이해하면 된다).
• 사실 Maven 자체는 기본적인 기능만을 가지고 있고, 빌드에 필요한 대부분의 기능들은 플러그인을 실행해서 제공 되는 형태이다. = 즉 phase를 실행하면 해당 phase와 연결된 플러그인의 goal이 실행되는 구조이다.