2016년 4월 8일 금요일

Build Script Basics

Build Script Basics

Hello world

당신은 gradle 커맨드를 통해 build를 실행시킬 수 있다.
gradle 커맨드는 현재 directory의 build.gradle 파일을 호출한다.
우리는 이 build.gradle 파일을 build script라고 부른다. (엄밀히 말하면 build configuration script 이긴 하지만).
build script는 project와 이것의 task를 정의한다.

이제 아래처럼 build.gradle을 작성해보자.

build.gradle

task hello {
    doLast {
        println 'Hello world!'
    }
}

A shortcut task definition

위를 아래처럼 간결하게 표현하는 방식이 있다.

build.gradle

task hello << {
    println 'Hello world!'
}
Build scripts are code
Gradle의 build script는 Groovy의 풀 파워를 당신에게 준다.
맛보기로 아래 예제를 보자.

build.gradle

task upper << {
    String someString = 'mY_nAmE'
    println "Original: " + someString 
    println "Upper case: " + someString.toUpperCase()
}

gradle -q upper 의 결과


> gradle -q upper
Original: mY_nAmE
Upper case: MY_NAME

혹은

build.gradle

task count << {
    4.times { print "$it " }
}

gradle count 의 결과

> gradle -q count
0 1 2 3 

Task dependencies

당신이 추측한대로, 다른 task에 dependency를 가지고 있는 task를 선언하는 것도 가능하다.

build.gradle

task hello << {
    println 'Hello world!'
}
task intro(dependsOn: hello) << {
    println "I'm Gradle"
}

gradle -q intro 의 결과

> gradle -q intro
Hello world!
I'm Gradle

dependency를 추가하기 위해, 해당 dependency가 보다 더 위에 선언될 필요는 없다.

Lazy dependsOn - the other task does not exist (yet)

build.gradle

task taskX(dependsOn: 'taskY') << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}

gradle -q taskX 의 실행 결과

> gradle -q taskX
taskY
taskX

Dynamic tasks

Groovy의 파워는 단순히 task를 정의하는데에만 쓰는 것보다 더 크다.
예를 들어 동적인 task를 만들 수 있다.

4.times { counter ->
    task "task$counter" << {
        println "I'm task number $counter"
    }
}

gradle -q task1 의 실행 결과

> gradle -q task1
I'm task number 1

Manipulating existing tasks

task를 만들면 이 task는 API를 통해 접근이 가능하다.
예를 들어, 당신은 task에 dependency를 추가할 수 있다.
심지어 runtime에도. Ant는 이러한 것들을 허용해주지 않는다.

4.times { counter ->
    task "task$counter" << {
        println "I'm task number $counter"
    }
}
task0.dependsOn task2, task3

gradle -q task0 의 실행 결과

> gradle -q task0
I'm task number 2
I'm task number 3
I'm task number 0

혹은 이미 존재하는 task의 행위를 추가할 수 있다.

task hello << {
    println 'Hello Earth'
}
hello.doFirst {
    println 'Hello Venus'
}
hello.doLast {
    println 'Hello Mars'
}
hello << {
    println 'Hello Jupiter'
}

gradle -q hello 의 실행 결과

> gradle -q hello
Hello Venus
Hello Earth
Hello Mars
Hello Jupiter

doFirst 와 doLas는 여러 번 실행될 수 있다.
그 것들은 task action list의 처음이나 마지막에 액션을 추가한다.
task가 실행될 때, action list의 action들은 순서에 따라 실행된다.
<< operator는 doLast 의 약어이다.

Shortcut notations

위의 예제에 나왔듯이 이미 존재하는 task에 접근하기 위한 간단한 표기법이 있다.
각각의 task는 build script의 property로써 사용 가능하다.

Accessing task as a property of the build script

build.gradle

task hello << {
    println 'Hello world!'
}
hello.doLast {
    println "Greetings from the $hello.name task."
}

gradle -q hello 의 실행 결과

> gradle -q hello
Hello world!
Greetings from the hello task.

이 것은 매우 읽기 좋은 코드를 만들기 좋게 해준다.
특히 compile task 같은 plugin으로부터 제공되는 task를 사용할 때 유용하다.

Extra task properties

당신은 당신만의 property를 task에 추가할 수 있다.
이름이 myProperty 인 property를 추가하기 위해서, ext.myProperty 를 초기값으로 설정하면 된다.
property는 task property가 정의되기 전에 읽거나 정해질 수 있다.

Adding extra properties to a task

build.gradle

task myTask {
    ext.myProperty = "myValue"
}

task printTaskProperties << {
    println myTask.myProperty
}

gradle -q printTaskProperties 의 실행 결과

> gradle -q printTaskProperties
myValue

Using Ant Tasks

Ant task는 Gradle의 일등석 손님이다.
Gradle은 Ant task에 대한 탁월한 integration 을 Groovy를 통해 제공한다.
Gradle로부터 Ant task를 사용하는 것은 Ant task를 build.xml 파일로부터 사용하는 것보다 편리하고 강력하다.
아래 예를 보면 Ant properties와 task 를 어떻게 실행하는 지 알 수 있다.

Using AntBuilder to execute ant.loadfile target

build.gradle

task loadfile << {
    def files = file('../antLoadfileResources').listFiles().sort()
    files.each { File file ->
        if (file.isFile()) {
            ant.loadfile(srcFile: file, property: file.name)
            println " *** $file.name ***"
            println "${ant.properties[file.name]}"
        }
    }
}

gradle -q loadfile 의 실행 결과

> gradle -q loadfile
 *** agile.manifesto.txt ***
Individuals and interactions over processes and tools
Working software over comprehensive documentation
Customer collaboration  over contract negotiation
Responding to change over following a plan
 *** gradle.manifesto.txt ***
Make the impossible possible, make the possible easy and make the easy elegant.
(inspired by Moshe Feldenkrais)

Using methods Using methods to organize your build logic

build.gradle

task checksum << {
    fileList('../antLoadfileResources').each {File file ->
        ant.checksum(file: file, property: "cs_$file.name")
        println "$file.name Checksum: ${ant.properties["cs_$file.name"]}"
    }
}

task loadfile << {
    fileList('../antLoadfileResources').each {File file ->
        ant.loadfile(srcFile: file, property: file.name)
        println "I'm fond of $file.name"
    }
}

File[] fileList(String dir) {
    file(dir).listFiles({file -> file.isFile() } as FileFilter).sort()
}

gradle -q loadFile 의 실행 결과

> gradle -q loadfile
I'm fond of agile.manifesto.txt
I'm fond of gradle.manifesto.txt

Default tasks

Gradle은 당신이 특정 task를 명시하지 않았을 때, 기본적으로 실행될 task를 지정할 수 있다.

defaultTasks 'clean', 'run'

task clean << {
    println 'Default Cleaning!'
}

task run << {
    println 'Default Running!'
}

task other << {
    println "I'm not a default task!"
}

gradle -q 의 실행 결과

> gradle -q
Default Cleaning!
Default Running!

이 것은 gradle clean run 과 동일하다.
multi-project build에서 모든 subproject는 스스로의 특정한 default task를 가질 수 있다.
만약 subproject가 특정한 default task를 가지고 있지않다면, parent project의 default task가 사용될 것이다.

Configure by DAG

Gradle은 configuration 단계와 execution 단계를 가진다.
configuration 단계 이후, Gradle은 모든 task들이 실행되어야 할 것을 알 수 있다.
Gradle은 이러한 정보를 사용할 수 있게 제공해 준다.

build.gradle

task distribution << {
    println "We build the zip with version=$version"
}

task release(dependsOn: 'distribution') << {
    println 'We release now'
}

gradle.taskGraph.whenReady {taskGraph ->
    if (taskGraph.hasTask(release)) {
        version = '1.0'
    } else {
        version = '1.0-SNAPSHOT'
    }
}

gradle -q distribution 의 실행 결과

> gradle -q distribution
We build the zip with version=1.0-SNAPSHOT

gradle -q release 의 실행 결과

> gradle -q release
We build the zip with version=1.0
We release now

원본 출처 : https://docs.gradle.org/current/userguide/tutorial_using_tasks.html

댓글 없음 :

댓글 쓰기