[Gradle] Gradle의 구성요소(Project, Task, Plugin)와 시작해보기

 

 

 

 

 

🧐 Project

모든 Gradle의 build는 하나 이상의 project로 구성됩니다.

 

project가 나타내는 것은 Gradle을 사용하여 수행하는 작업에 따라 달라집니다.

 

예를 들어 project는 library JAR 혹은 웹 애플리케이션을 나타내거나,

다른 projects로부터 생성된 JAR들을 합쳐서 배포된 ZIP을 나타낼 수 있습니다.

 

또한 staging 혹은 production 환경에 배포하는 등의 수행해야 할 작업을 나타낼 수 있습니다.

 

 

 

 

 

 

 

🧐 Task

project에서 수행할 수 있는 작업은 하나 이상의 task에 의해 정의됩니다.

Tasks는 빌드시 수행하는 원자적(atomic)인 작업을 나타냅니다.

 

예를 들어 작업은 일부 클래스들을 컴파일하거나, JAR을 생성하거나, Javadoc을 생성하거나, 일부 archives를 repository에 게시하는 등의 작업일 수 있습니다.

 

 

 

 

 

 

 

 

🧐 Plugin

일반적으로 사용되는 task들은 사용자가 직접 정의할 필요가 없도록 plugin을 통해 제공됩니다.

(예를 들어 자바를 컴파일하는 등의 작업은 java plugin에서 제공됩니다.)

 

project에 plugin을 적용하면, project에서는 해당 plugin이 제공하는 기능들을 사용할 수 있습니다.

 

더욱 자세한 정보는 다음 링크를 참고해주세요.

 

 

 

 

 

 

 

🧐 사용해보기

Gradle project를 만들기 위해서는 다음 명령어를 실행하여야 합니다.

gradle init

gradle command not found 오류가 발생한다면? 
> brew install gradle

 

 

위 명령어를 실행하면 다음과 같은 메세지가 나옵니다.

Select type of project to generate:
  1: basic
  2: application
  3: library
  4: Gradle plugin
Enter selection (default: basic) [1..4]

각각의 종류에 따른 설명은 다음 링크를 참고해주세요.

 

gradle의 구성요소를 간단히 살펴볼 것이므로 아무것도 없는 basic을 선택하겠습니다.

 

 

다음으로 빌드 스크립드를 작성할 언어를 선택하여야 합니다.

Select build script DSL:
  1: Groovy
  2: Kotlin
Enter selection (default: Groovy) [1..2]

저는 groovy를 선택하겠습니다.

 

 

다음으로는 project의 이름 설정입니다.

Project name (default: gradle-study):

임의로 지어주세요.

 

 

그러면 다음과 같이 5개의 파일이 생성되는데, 이들 각각에 대해서는 다음 글에서 알아보겠습니다.

 

 

 

gradle 명령을 통해 gradle의 빌드를 실행할 수 있습니다.

 

gradle 명령은 현재 경로에서 build.gradle 파일을 찾습니다.

build.gradle 파일은 빌드 스크립트(build script)라고 불립니다.

저희는 빌드 스크립트에 project와, 해당 project의 task들을 정의할 수 있습니다.

 

 

우선 build.gradle에 다음과 같이 작성합니다.

tasks.register('hello') {
    doLast {
        println 'Hello world!'
    }
}

 

Gradle에서 Task를 실행하는 명령어는 다음과 같습니다.

gradle [태스크 이름]

 

즉 위의 hello라는 Task를 실행하려면 다음과 같이 입력합니다.

gradle hello

 

 

결과는 다음과 같습니다.

> Task :hello
Hello world!

BUILD SUCCESSFUL in 369ms
1 actionable task: 1 executed

 

 

 

 

🌱 여러 task 실행하기

여러개의 task를 실행할 수도 있습니다.

gradle [태스크1 이름] [태스크2 이름] [태스크3 이름]

 

예를 들어 다음과 같이 3개의 작업을 실행해보도록 하겠습니다.

tasks.register('hello') {
    println 'hello'
}

tasks.register('my') {
    println 'my'
}

tasks.register('name is') {
    println 'name is'
}

 

다음과 같이 입력할 수 있습니다.

gradle hello my 'name is'

 

 

 

 

 

 

 

 

 

🧐 일반 Task

기본적으로 제공되거나, 혹은 대부분의 Gradle plugin에서 제공되는 task들에 대해 알아보겠습니다.

 

 

💻 build

build 작업은 모든 생성물들을 조립(assembing)하고, 검사(check)를 실행하는 것이 일반적입니다.

 

 

 

💻 run

일반적으로 애플리케이션을 실행하는 것이 일반적입니다.

 

 

 

💻 check

테스트와 린팅(linting, 소스코드 분석) 등을 포함하여 모든 검증(verification) 작업을 실행하는 것이 일반적입니다.

 

 

 

💻 clean

build directory에 존재하는 내용을 삭제하는 것이 일반적입니다.

 

 

 

이외에도 더 있으나, 추가적인 내용은 공식문서를 참고해주세요.

 

 

 

 

 

🧐 Task Dependencies(의존성)

다른 Task에 의존하는 Task를 작성하는 것도 가능합니다.

 

다음과 같이 의존성을 추가할 수 있습니다.

dependsOn '테스크 이름'

 

예시는 다음과 같습니다.

tasks.register('hello') {
    doLast {
        println 'Hello world!'
    }
}
tasks.register('intro') {
    dependsOn tasks.hello
    doLast {
        println "I'm Gradle"
    }
}

 

 

intro 작업을 실행(gradle intro)한 결과는 다음과 같습니다.

> Task :hello
Hello world!

> Task :intro
I'm Gradle

BUILD SUCCESSFUL in 401ms
2 actionable tasks: 2 executed

 

 

의존성을 추가할 때에는 해당 작업이 위에서 정의되어 있을 필요가 없습니다.

 

즉 다음도 가능합니다.

tasks.register('intro') {
    dependsOn tasks.hello
    doLast {
        println "I'm Gradle"
    }
}
tasks.register('hello') {
    doLast {
        println 'Hello world!'
    }
}

 

 

 

이미 존재하는 task를 조작하는 것도 가능합니다.

tasks.register('hello') {
    doLast {
        println 'original do Last'
    }
}
tasks.named('hello') {
    doLast {
        println 'add do last 1'
    }
}
tasks.named('hello') {
    doLast {
        println 'add do last 2'
    }
}
tasks.named('hello') {
    doFirst {
        println 'add do first 1'
    }
}

 

 

위와 같이 작성한 후, hello를 실행하면 결과는 다음과 같습니다.

> Task :hello
add do first 1
original do Last
add do last 1
add do last 2

BUILD SUCCESSFUL in 451ms
1 actionable task: 1 executed

 

 

 

다음과 같이 함수를 정의하고 사용할 수도 있습니다.

tasks.register('hello') {
    doLast {
        println decorate('hello world')
    }
}

private String decorate(String message) {
    return "**" + message + "**"
}

 

결과는 다음과 같습니다.

tasks.register('hello') {
    doLast {
        println decorate('hello world')
    }
}

private String decorate(String message) {
    return "**" + message + "**"
}

 

 

 

 

 

 

 

 

 

🔎 Reference

https://docs.gradle.org/current/userguide/tutorial_using_tasks.html#sec:projects_and_tasks

Build Script Basics

 

 

https://docs.gradle.org/current/userguide/command_line_interface.html

Command-Line Interface