Gradle学习5——Gradle增量式构建

学习本系列前可以下载相关的github项目gradleLearnDemo。
地址：https://github.com/sososeen09/gradleLearnDemo

Gradle的增量式构建特性紧紧的与生命周期相结合。Gradle的增量式构建支持自动鉴别不需要被运行的任务。这些任务会被标记为 UP-TO-DATE。特别是在大型的企业级项目，这个特性是节约时间的好帮手。

Gradle通过比较两次构建task的inputs和outputs来决定task是否是最新的。自从最后一次task执行以来，如果inputs和outputs没有发生变化，则认为task是最新的。

输入可以是一个目录、一个或多个文件，或者是一个任意属性。
一个task的输出是通过一个目录或1~n个文件来定义的。
inputs和outputs在DefaultTask类中被定义为属性或者有一个直接类来表示。对应的是TaskInputs和TaskOutputs。

TaskInputs和TaskOutputs.png

为了便于表述，我们还是接着上一篇的那个例子，从配置文件version.properties中读取参数，并打印出版本号：

version=new ProjectVersion(0,1)

class ProjectVersion{
    Integer major
    Integer minor
    Boolean release

    ProjectVersion(Integer major, Integer minor){
       this.major=major
       this.minor=minor
       this.release=Boolean.FALSE
    }

    ProjectVersion(Integer major, Integer minor, Boolean release){
       this.major=major
       this.minor=minor
       this.release=release
    }

    @Override
    String toString(){
      "$major.$minor${release?'': '-SNAPSHOT'}"
    }
}

task printVersion << {
  logger.quiet "Version: $version"
}

// Project接口提供了file方法，它会创建一个相对于项目目录的java.io.File实例
ext.versionFile=file('version.properties')

task loadVersion{
    project.version=readVersion()
}

//readVersion方法，与task是不同的
ProjectVersion readVersion(){
    logger.quiet 'Reading the version file'
    if(!versionFile.exists()){
        throw new GradleException ("Required version file dose not exist:$versionFile.canonicalPath " )
    }

    //Groovy的文件实现通过添加新的方法来读取InputStream
    Properties versionProps=new Properties()
    versionFile.withInputStream{stream->
        versionProps.load(stream)
    }
    // 在Groovy中，如果return是方法中的最后一条语句的话，则可以将它省略
    new ProjectVersion(versionProps.major.toInteger(),versionProps.minor.toInteger(),versionProps.release.toBoolean())
}

配置文件中的初始参数是这样的：

major=0
minor=1
release=false

现在，我们要增加一个新的任务：新建一个名为makeReleaseVersion的task来将配置文件中的release属性改为true。

task makeReleaseVersion(group :'versioning',description :'Makes project a release version.' )<< {
    version.release=true
// Ant task 的propertyfile 提供了一种便利的方式来修改属性文件
    ant.propertyfile(file:versionFile){
        entry(key:'release',type:'string',operation:'=',value: 'true')
    }
}

执行gradle makeReleaseVersion
之后打开配置文件 version.properties 就可以看到文件中的release属性已经变为true了。

执行 gradle printVersion 命令，可以看到结果

:printVersion
Version: 0.1

注意，虽然我们将配置文件中的release标记为true，但是Gradle并不知道。当我们再次执行makeReleaseVersion这个task的时候，doLast这个闭包中的代码还是会执行，会花多余的时间。为了解决这个问题，需要声明它的inputs和outputs。

task makeReleaseVersion(group :'versioning',description :'Makes project a release version.' ){
    //在配置阶段声明inputs/outputs
    //声明版本的release属性作为输入
    inputs.property('release',version.release)
    //由于版本文件被修改了，所以它被声明作为输出文件属性
    outputs.file versionFile
    doLast{
        version.release=true
// Ant task 的propertyfile 提供了一种便利的方式来修改属性文件
        ant.propertyfile(file:versionFile){
            entry(key:'release',type:'string',operation:'=',value: 'true')
        }
    }
}

记住：task的inputs和outputs属性是在配置阶段执行的用来连接task的依赖。这就是他们需要在配置块中被定义的原因。为了避免出现所不期望出现的行为，请确保赋给inputs和outputs的值在配置阶段是可访问的。如果需要通过编程获得输出，可以通过TaskOutputs上的upToDateWhen（Closure）方法来实现。与常规的inputs和outputs相比，这个方法是在执行期间执行的。如果闭包返回true，这个task则会被认为是最新的。

如果执行两次makeReleaseVersion任务，会发现Gradle已经知道配置文件中的release 已经变为true，会自动跳过第二次执行。

:makeReleaseVersion UP-TO-DATE

实际上，我们在apk打包过程中经常看到的UP-TO-DATE 就是因为输入输出没有发生变化，Gradle跳过了这个task的执行。

下一篇，我们开始学习Gradle中如何挂接到构建生命周期。