[Gradle] Gradle Shadow Plugin 사용 이유 및 사용법

🤔Gradle Shadow Plugin을 사용하게 된 이유

컴파일 후 실행을 하던 중, java.lang.NoClassDefFoundError를 마주하게 되었다.

해당 에러는 클래스를 찾지 못해서 발생한다.

나의 경우, build.gradle에 추가한 dependency와 관련한 클래스를 찾지 못해 생겨난 문제였다.

이를 해결하기 위해서는 Gradle Shadow Plugin을 사용해야 했다.

🔍Gradle Shadow Plugin이란?

이 플러그인은 다양한 라이브러리와 종속성을 포함한 fat jar를 생성한다.

fat jar는 실행 가능한 JAR 파일로, 모든 종속성을 포함하고 있으므로 더 이상 종속성 파일을 별도로 다운로드하거나 설치할 필요가 없다.

🪄Gradle Shadow Plugin 사용법

1. build.gradle 파일에서 다음을 추가한다.

plugins {
  id 'com.github.johnrengelman.shadow' version '8.1.0'
  id 'java'
}

 

⚠️ 자신의 환경에 맞는 버전을 적어줘야한다.

Gradle 버전	Shadow 버전
5.x	5.2.0 - 6.0.0
6.x	5.2.0 - 6.1.0
7.x	7.0.0 +
8.x	8.0.0 +

 

🗒️ Shadow v5.+는 Gradle 5.x - 6.x 및 Java 7 - 15와만 호환되며 v6.1.0+에는 Java 8+가 필요하다.

2. Gradle에서 shadowJar를 실행한다.

파일이름-all.jar 형태로 결과물이 생성된다.