[Gradle] 자바 플러그인

 

 

 

 

 

 

🧐 java 플러그인

자바 플러그인은 자바 애플리케이션을 빌드하는데 필요한 컴파일, 테스트 및 여러 기능들을 프로젝트에 추가합니다.

이는 많은 다른 JVM 언어 플러그인의 기반이 되는 플러그인입니다.

 

해당 플러그인을 사용하기 위해서는 build.gradle에 다음과 같이 작성할 수 있습니다.

plugins {
    id 'java'
}

 

 

 

 

 

 

 

🧐 java 플러그인에서 제공하는 Task

몇개만 살펴보도록 하겠습니다.

더욱 자세히 확인하고 싶다면 다음 링크를 참고해주세요.

 

 

🌱 compileJava

Depends on: 컴파일 classpath에 영향을 주는 모든 작업

해당 작업은 프로덕션 자바 코드를 JDK 컴파일러를 이용하여 컴파일하는 작업입니다.

해당 작업을 실행하면 다음과 같아집니다.

사용된 코드는 예시 코드들입니다.

 

 

 

 

 

 

🌱 processResources

프로덕션의 resources를 build 디렉토리 하위의 프로덕션의 resources 디럭테리에 복사합니다.

이를 수행하면 다음과 같아집니다.

 

 

 

 

 

🌱 classes

Depends on: [compileJava], [processResources]

이는 다른 작업에만 의존하는(depens on) 집계(aggregate) 작업입니다.
다른 플러그인들은 컴파일 작업을 추가로 연결할 수 있습니다.

해당 작업을 수행한 결과는, compileJava와 processResources를 수행한 결과와 동일합니다.

 

 

 

 

 

 

🌱 compileTestJava

Depends on: [classes], testCompileClasspath와 관련된 모든 작업(tatk)

JDK 컴파일러를 사용하여 테스트코드를 컴파일합니다.

실행한 결과는 다음과 같습니다.

 

 

 

 

 

 

🌱 processTestResources

test resources를 build 디렉토리 하위의 테스트의 resources 디럭테리에 복사합니다.

이를 수행하면 다음과 같아집니다.

 

 

 

 

 

 

🌱 testClasses

Depends on: [compileJava], [processTestResources]

classes와 비슷하게 해당 작업을 수행한 결과는, compileJava와 processTestResources를 수행한 결과와 동일합니다.

 

 

 

 

 

 

 

🌱 jar

Depends on: [classes]

main source set 애 첨부된 classes와 resources를 기반으로 JAR 파일을 생성합니다.

실행 결과는 다음과 같습니다.

 

 

 

 

 

🌱 javadoc

Depends on: [classes]

Javadoc을 사용하여 프로덕션 자바 코드에 대한 API 문서를 생성합니다.

실행 결과는 다음과 같습니다.

 

 

 

 

🌱 test

Depends on: [testClasses], test runtile classpath와 관련된 모든 작업(task)들

JUnit 등을 사용하여 단위 테스트를 실행합니다.

 

 

 

 

🌱 clean

프로젝트의 build 디렉토리를 삭제합니다

 

 

 

 

🌱 cleanTaskName

지정한 작업에서 만들 파일을 삭제합니다.

예를 들어 cleanJar은 jar task에 의해 생성된 JAR 파일을 삭제합니다.

cleanTest는 test task에 의해 생성된 테스트 결과를 삭제합니다.

 

 

 

 

🌱 assemble

Depends on: [jar], archives configuration에 첨부된 아티팩트를 생성하는 다른 모든 작업들

프로젝트의 모든 archives를 조립합니다.

(뭔지는 저도 잘 모르겠어용...ㅠㅠ)

 

 

 

 

🌱 check

Depends on: [test]

태스트 실행과 같이 검증 작업을 모두 수행하는 잡업입니다.

일부 플러그인에서는 [check] 작업에 그들만의 검증 작업을 추가할 수 있습니다.

 

 

 

 

🌱 build

Depends on: [check], [assemble]

프로젝트를 완전히 빌드하는 작업입니다.

 

 

 

 

 

task들의 관계는 다음과 같습니다.

 

 

 

 

 

 

 

 

 

 

 

 

🧐 Dependency Configuration

이번에는 자바 플러그인에서 제공하는 여러 configuration들을 살펴보도록 하겠습니다.

compilejava나 test와 같은 작업(task)들은 이러한 configuration들 중 하나 이상을 사용하여 해당 파일을 가져와 사용합니다.

예를 들어 이러한 의존성들을 컴파일 혹은 런타임 classpath에 배치할 수 있습니다.

 

 

🌱 implementation

오직 내부에서만 사용하고 외부로는 노출되지 않은 의존성을 선언하는데 사용합니다.

 

 

 

 

 

🌱 compileOnly

컴파일 시에는 필요하지만, 런타임 시에는 필요하지 않는 의존성을 선언하는데 사용합니다.

 

 

 

 

 

🌱 runtimeOnly

컴파일 시에는 필요없지만, 런타임에는 필요한 의존성을 선언하는데 사용합니다.

 

 

 

 

 

 

🌱 testImplementation

테스트를 실행하는데 필요한 의존성을 선언합니다.

이는 implementation을 상속합니다. 즉 implementation으로 선언된 의존성들도 testImplementation에 포함됩니다.

 

정말 포함되는지 확인해 보겠습니다.

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'junit:junit:4.12'
    implementation 'org.apache.commons:commons-lang3:3.5'
}

// 출력을 위한 부분
configurations {
    println "implementation: "
    prettyPrint(implementation.getAllDependencies())
    println ""
    println "testImplementation: "
    prettyPrint(testImplementation.getAllDependencies())
}

private void prettyPrint(DependencySet dependencies) {
    dependencies.forEach(it -> println("  "+it.group + ":" + it.name + ":" + it.version))
}
// 출력을 위한 부분

다음과 같이 implementation으로 설정된 의존성이 testImplementation에 포함된 것을 알 수 있습니다.

 

 

 

 

 

 

 

🌱 testCompileOnly

테스트코드를 컴파일 할 때에는 필요하지만, 런타임 시에는 필요하지 않은 의존성을 선언합니다.

(이는 compileOnly를 상속하지 않습니다.)

 

 

 

 

 

 

🌱 testRuntimeOnly

테스트코드 런타임 시에는 필요하지만, 컴파일 시에는 필요하지 않은 의존성을 선언하는데 사용합니다.

이는 runtimeOnly을 상속합니다. 즉 runtimeOnly으로 선언된 의존성들도 testRuntimeOnly에 포함됩니다.

 

 

 

 

 

 

 

🌱 compileClasspath

compileClasspath에 추가될 의존성들을 선언하는데 사용합니다.

이는 implementaion과 compileOnly를 상속하기 때문에, implementation으로 설정된 의존성과 compileOnly 의존성들로 선언된 요소들을 포함합니다.

 

예를 들어 다음과 같이 코드를 작성하면,

dependencies {
    implementation 'junit:junit:4.12'
    compileOnly 'org.apache.commons:commons-lang3:3.5'
}

compileClasspath는 다음과 같아집니다.

 

 

 

 

 

🌱 runtimeClasspath

runtimeClasspath에 추가될 의존성들을 선언하는데 사용합니다.

이는 implementaion과 runtimeOnly를 상속하기 때문에, implementation으로 설정된 의존성과 runtimeOnly 의존성들로 선언된 요소들을 포함합니다.

 

 

 

 

 

 

🌱 testCompileClasspath

testCompileClasspath에 추가될 의존성들을 선언하는데 사용합니다.

이는 testImplementaion과 testCompileOnly를 상속하기 때문에, testImplementaion으로 설정된 의존성과 testCompileOnly 의존성들로 선언된 요소들을 포함합니다.

이때 testImplementation은 implementation을 상속하기 때문에, implementation으로 선언된 의존성들 역시도 이곳에 포함됩니다.

 

예를 들어 다음과 같이 코드를 작성하면

dependencies {
    implementation 'junit:junit:4.12'
    testCompileOnly 'com.google.guava:guava:28.1-jre'
    testImplementation 'org.apache.commons:commons-lang3:3.5'
}

testCompileClasspath는 다음과 같아집니다.

 

 

 

 

 

 

🌱 testRuntimeClasspath

testRuntimeClasspath에 추가될 의존성들을 선언하는데 사용합니다.

이는 testImplementaion과 testRuntimeOnly를 상속하기 때문에, testImplementaion으로 설정된 의존성과 testRuntimeOnly 의존성들로 선언된 요소들을 포함합니다.

 

 

 

 

 

 

 

 

🌱 annotationProcessor

컴파일 시에 사용될 Annotation Processor에 대한 의존성을 선언하는데 사용합니다.

 

 

 

이러한 Configuration들의 관계는 다음 글에서 자바 라이브러리 플러그인이 추가적으로 제공하는 api configuration까지 살펴본 후에 정리하도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

🔎 Reference

https://docs.gradle.org/current/userguide/java_plugin.html#java_plugin

The Java Plugin