Gradle - Java Plugin

4 분 소요

Gradle 공식 문서의 Java Plugin 부분을 번역한 내용입니다. 오역이 있을 수 있습니다. 잘못된 부분이나 다른 의견이 있으시면 지적 부탁드립니다.

The Java Plugin

Java Plugin은 프로젝트에 테스트 및 여러 기능과 함께 자바 컴파일을 추가한다. JVM 언어의 Gradle plugin의 기반이 된다.

Usage

Java Plugin 을 사용하기 위해서는 아래 빌드 스크립트 처럼 작성하면 된다.

build.gradle

plugins {
    id 'java'
}

build.gradle.kts

plugins {
    java
}

Tasks

자바 플러그인은 프로젝트에 다양한 아래 나와있는 task들을 추가할 수 있다.

compileJava — JavaCompile

Depends on: 컴파일 클래스패스의 모든 tasks(프로젝트 종속성을 통한 클래스패스에 있는 프로젝트의 jar task를 포함한 모든)

JDK 컴파일러를 이용하여 프로덕션 자바 소스파일을 컴파일 한다.

processResources — Copy

프로덕션 리소스를 프로덕션 리소스 디렉토리에 복사

classes

Depends on: compileJava, processResources

단순히 다른 태스크에 의존하는 총체적인 태스크다. 다른 플러그인은 추가 컴파일 태스크에 그것을 첨부할 수 있다.(?)

compileTestJava — JavaCompile

Depends on: classes, 테스트 컴파일 클래스 패스에 있는 모든 태스크

JDK 컴파일러를 이용하여 테스트 자바 소스파일을 컴파일 한다.

processTestResources — Copy

테스트 리소스를 테스트 리소스 디렉토리에 복사

testClasses

Depends on: compileTestJava, processTestResources

단순히 다른 태스크에 의존하는 총체적인 태스크다. 다른 플러그인은 추가 테스트 컴파일 태스크에 그것을 첨부할 수 있다.

jar — Jar

Depends on: classes

메인 소스셋에 있는 클래스와 리소스를 기반으로 프로덕션 JAR 파일을 모은다.

javadoc — Javadoc

Depends on: classes

Javadoc을 이용하여 프로덕션 자바소스로부터 API 문서를 생성한다.

test — Test

Depends on: testClasses, 테스트 런타임 클래스패스를 생성하는 모든 태스크

JUnit 이나 TestNG를 사용한 유닛 테스트를 실행한다.

uploadArchives — Upload

Depends on: jar, 아카이브 설정에 첨부된 아티팩트를 생성하는 다른 태스크

Deprecated

clean — Delete

프로젝트 빌드 디렉토리를 지운다.

cleanTaskName — Delete

특정한 태스크로부터 만들어진 파일을 지운다. 예를 들어 cleanJar를 하면 jar task를 통해 만들어진 JAR 파일을 지운다. cleanTest를 하면 test task를 통해 만들어진 테스트 결과를 지운다.

SourceSet Task

프로젝트에 추가하는 각 소스 셋에 대해 자바 플러그인은 다음의 태스크들을 추가한다.

  1. compileSourceSetJava — JavaCompile
    • Depends on: SourceSet의 컴파일 클래스패스에 기여하는 모든 태스크
    • JDK 컴파일러를 사용하여 주어진 SourceSet의 자바 소스파일을 컴파일한다.
  2. processSourceSetResources — Copy
    • 주어진 SourceSet의 리소스를 리소스 디렉토리로 복사한다.
  3. sourceSetClasses — Task
    • Depends on: compileSourceSetJava, processSourceSetResources
    • 주어진 SourceSet의 클래스와 리소스를 패키징과 실행을 위해 준비한다. 어떤 플러그인은 SourceSet을 위한 추가 컴파일 태스크가 추가될 수 있다.

Lifecycle Tasks

Java 플러그인은 Java 플러그인이 자동으로 적용하는 *Base Plugin에서 정의한 라이프사이클 태스크에 해당 태스크의 일부를 첨부하고, 다음에 나오는 몇 가지 다른 라이프사이클 태스크도 추가한다.

  1. assemble
    • Depends on: jar, 아카이브 설정에 첨부된 아티팩트를 만드는 모든 다른 태스크
    • 프로젝트 내의 모든 기록물을 모으는 총체적인 태스크다. 이 태스크는 Base Plugin에 의해 추가된다.
  2. check
    • Depends on: test
    • verification tasks들이 수행하는 총체적인 태스크다.(테스트를 돌리는 것 같은..) 어떤 플러그인은 자체의 검증 태스크를 추가할 수도 있다. 전체 빌드에 커스텀 테스트 태스크를 실행하려면 이 태스크에 연결하면 된다. 이 태스크는 Base Plugin에 의해 추가된다.
  3. build
    • Depends on: check, assemble
    • 프로젝트의 전체 빌드를 수행하는 총체적인 태스크다. Base Plugin에 의해 추가된다.
  4. buildNeeded
    • Depends on: testRuntimeClasspath 설정의 디펜던시가 있는 모든 프로젝트의 build, buildNeeded task
    • 의존하고 있는 모든 프로젝트 빌드를 수행
  5. buildDependents
    • Depends on: 모든 프로젝트 내의 testRuntimeClasspath 설정의 디펜던시에 의해 가지는 모든 프로젝트의 build와 buildDependents
    • 프로젝트와 그것에 의존하는 모든 프로젝트의 풀 빌드 수행.
    • 위에 buildNeeded랑 뭐가 다른건지 잘 모르겠음.
  6. buildConfigName — task rule
    • Depends on: ConfigName으로 첨부된 아티팩트를 생성하는 모든 태스크
    • 특정 설정을 위한 아티팩트를 모은다. Base Plugin에 의해 추가된다.
  7. uploadConfigName — task rule, type: Upload
    • Depends on: ConfigName으로 명명되어 첨부된 아티팩트를 생성하는 모든 태스크
    • 특정 설정을 위한 아티팩트를 모으고 업로드 한다. Base Plugin에 의해 추가된다.

Java Plugin Task

프로젝트 구조

자바 플러그인은 프로젝트의 구조가 아래 나온 것처럼 되어 있다고 가정한다. 이 디렉토리들은 뭘 가지고 있을 필요는 없다. 자바 플러그인은 뭐든 찾으면 컴파일 할 것이고 놓친 것은 모두 처리 할 것이다.

  1. src/main/java
    • 프로덕션 자바 코드
  2. src/main/resources
    • 프로덕션 리소스, xml이나 properties 파일
  3. src/test/java
    • Test 자바 코드
  4. src/test/resources
    • Test 리소스
  5. src/sourceSet/java
    • SourceSet으로 명명된 소스들의 집합을 위한 자바 소스
  6. src/sourceSet/resources
    • SourceSet으로 명명된 소스들의 집합을 위한 리소스

적합한 소스 집합을 설정함으로써 프로젝트 구조를 설정할 수 있다. 이는 아래 섹션에서 좀 더 자세히 다룬다. 메인 자바 소스와 리소스 디렉토리를 변경하기 위한 간단한 예시가 아래에 있다.

build.gradle

sourceSets {
    main {
        java {
            srcDirs = ['src/java']
        }
        resources {
            srcDirs = ['src/resources']
        }
    }
}

build.gradle.kts

sourceSets {
    main {
        java {
            setSrcDirs(listOf("src/java"))
        }
        resources {
            setSrcDirs(listOf("src/resources"))
        }
    }
}

Source sets

플러그인은 다음과 같은 소스 집합들을 추가한다.

  1. main
    • 프로젝트의 프로덕션 소스코드를 포함한다.
  2. test
    • JUnit이나 TestNG를 사용하는 테스트 소스코드를 포함한다. 일반적으로 유닛테스트지만 동일한 컴파일, 런타임 클래스패스를 공유한다면 이 소스셋에는 어떤 테스트도 포함될 수 있다.

Dependency Management

자바 플러그인은 프로젝트에 아래 나온 것처럼 많은 의존성 설정을 추가할 수 있다. compileJava와 test 같은 태스크들은 이 설정들 중 한개 이상을 사용하여 그것들을 사용하면서 적합한 파일을 얻는다. 예를 들어 컴파일, 런타임 클래스 패스에 해당 파일을 배치한다.

  1. compile(Deprecated)
    • 컴파일 타임 의존성, implementation로 대체됨
  2. implementation extends compile
    • 해당 의존성만 implementation
  3. compileOnly
    • 컴파일 타임에만 의존성 사용, 런타임에 사용하지 않음
  4. compileClasspath extends compile, compileOnly, implementation
    • 컴파일 클래스패스, 소스를 컴파일할 때 사용한다. compileJava 태스크에 의해 사용됨.
  5. annotationProcessor
    • 컴파일 중에 사용되는 어노테이션 프로세서
  6. runtime(Deprecated) extends compile
    • 런타임 의존성, runtimeOnly로 대체됨
  7. runtimeOnly
    • 런타임에만 의존성 사용
  8. runtimeClasspath extends runtimeOnly, runtime, implementation
    • 런타임 클래스패스에는 implementation과 runtimeOnly 요소들이 포함되어 있다.
  9. testCompile(Deprecated) extends compile
    • 테스트를 컴파일하기 위한 추가 의존성, testImplementation로 대체됨
  10. testImplementation extends testCompile, implementation
    • 테스트만을 위한 의존성 구현
  11. testCompileOnly
    • 테스트들을 컴파일 하기 위한 추가 의존성, 런타임에 사용되지 않는다.
  12. testCompileClasspath extends testCompile, testCompileOnly, testImplementation
    • 테스트 컴파일 클래스패스, 테스트 소스를 컴파일할 때 사용된다. compileTestJava 태스크에 의해 사용됨.
  13. testRuntime(Deprecated) extends runtime, testCompile
    • 테스트 running을 위한 추가 의존성, testRuntimeOnly로 대체됨
  14. testRuntimeOnly extends runtimeOnly
    • 테스트 러닝을 위한 RuntimeOnly 의존성
  15. testRuntimeClasspath extends testRuntimeOnly, testRuntime, testImplementation
    • 테스트 러닝을 위한 런타임 클래스 패스, test 태스크에 의해 사용됨.
  16. archives
    • 이 프로젝트에 의해 생성되는 아티팩트들(예를 들어 jar), uploadArchives 태스크에 의해 사용됨.
  17. default extends runtimeClasspath
    • 이 프로젝트에 프로젝트 의존성에 의해 사용 된다. 런타임에 이 프로젝트가 필요로 하는 아티팩트와 의존성을 포함한다.

아래 그림은 main과 test의 의존성 설정을 각각 보여준다.

  • 회색 글씨 - deprecated
  • 초록 바탕 - 구성에 대한 의존성 선언 가능
  • 회색-파란색 바탕 — 태스크 별로 각각 따로 사용하기 위해서 있다. 의존성을 선언하기 위한 것이 아님
  • 하늘색 바탕 - 태스크

Java main configuration

Java test configuartion

뒷 부분 내용은 생략합니다. (Incremental Java compilation, Incremental annotation processing, Compilation avoidance)

원본 출처

댓글남기기

참고

Github CLI 사용기

2 분 소요

9월 17일 날짜로 Github CLI 1.0 버전이 릴리즈 되었습니다. Github에 들어가보니 옆에 뭔가 거슬리는 것이 있길래 확인해보고 사용해본 후기를 정리하여 포스팅합니다.

TCP 상태(CLOSE_WAIT, TIME_WAIT)

2 분 소요

트래픽을 만들어내는 어떤 툴을 사용하다가 CLOSE_WAIT 상태로 계속 유지되는 버그를 마주쳤다. 그런 의미에서 TCP 상태에 대해서 공부하고 정리한다.