[maven] Maven Shade Plugin 로 fat jar 만들때 rewrite, transformers, filters 작업을 수행한다

Maven Shade Plugin 중복 리소스 처리 원리

Maven Shade Plugin은 여러 JAR를 합쳐 하나의 실행 가능한 Fat JAR로 만드는 것이다 

빌드 결과물(target/classes) + 의존성 JAR들 안의 클래스/리소스 파일을 모두 하나의 JAR에 복사한다 

동일한 경로를 가진 파일이 여러 JAR에 있응면 중복 경고를 발생시키고 중복해결을 위해 rewrite(마지막 파일만 포함하도록 덮어쓰기), transformers(합치기), filters(제외하기) 작업을 수행한다

즉, 직접 어떤 파일을 합칠지 버릴지 정해야 안전하게 fat jar가 생성된다 

 

중복 처리 방식

transformers

(1) META-INF/services/*

대표적으로 Spring Boot에서 META-INF/spring.handlers, META-INF/spring.schemas 합칠 때 사용한다. 

 

(2) LICENSE, NOTICE, DEPENDENCIES

라이선스(LICENSE)이나 저작권 표기(NOTICE)은 법적 용도로 존재하기 때문에 무작정 지우는 것은 고려되지 않는다.

따라서, LICENSE 나 NOTICE는 transformer 통해서 하나의 파일로 합치는  것이 권장된다. (OSS 배포시 필수제공 필요)

<transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"/>
    <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer"/>
    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
      <resource>META-INF/DEPENDENCIES</resource>
</transformer>

 

(3) META-INF/MANIFEST.MF : Jar 메타데이터

<!-- 실행 클래스 지정 -->
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
	<mainClass>com.eundms.RunCheckstyle</mainClass>
</transformer>

filters

1. META-INF/** 내 서명 파일 제외 

META-INF/*.SF, *.DSA, *.RSA : JAR 디지털 서명 정보

 

 

원래 각각의 JAR는 서명된 상태로 배포되는데 Fat JAR로 합칠 때 서명정보도 같이 복사되면

JVM이 서명을 검증하다가 실패하거나 의미 없는 서명으로 경고를 발생시킨다

 

따라서, 제외한다. 

<filters>
  <filter>
    <artifact>*:*</artifact>
    <excludes>
          <exclude>META-INF/*.SF</exclude>
          <exclude>META-INF/*.DSA</exclude>
          <exclude>META-INF/*.RSA</exclude>
    </excludes>
  </filter>
</filters>

 처음에 META-INF/** 하면 되는 거 아닌가라고 생각했지만, 반드시 포함되어야 하는 META-INF/services/*가 있을 수도 있고, 

 

 

 

2. module-info.class 제외

java9 모듈 시스템 도입에서 생긴 파일로 각 라이브러리가 모듈 의존성/exports 를 선언하는 메타데이터이다 

fat jar에 각 라이브러리의 module-info.class가 중복되어 jvm 입장에서는 강한 캡슐화 정보가 충돌 되는 것으로 인식한다.

따라서, shade 과정에서 하나만 남기거나 무시하게 되는데 이게 경고나 런타임 문제가 발생할 수 있는 원인이 된다. 

 

따라서, 제외한다.

<filters>
  <filter>
    <artifact>*:*</artifact>
    <excludes>
      <exclude>module-info.class</exclude>
    </excludes>
  </filter>
</filters>

 

3. 특정 불필요한 리소스 

mozilla/public-suffix-list.txt

 

 

>> 계속 확인함 

mvn clean package
java -jar target/라이브러리-1.0.0.jar