学习本系列前可以下载相关的github项目gradleLearnDemo。
地址:https://github.com/sososeen09/gradleLearnDemo
读取和设置Project和Task的属性是很重要的一块内容,每个Project和Task实例都提供了可以通过getter和setter方法访问的属性。一个属性可能是一个任务的描述或者项目的版本。你也可以定义自己的属性。Gradle允许用户通过扩展属性自定义一些变量。还有,很多Plugin都会加入扩展属性,可以通过设置属性来控制使用Pulgin。
1 Project自带的属性
Gradle在默认情况下已经为Project定义了很多属性,其中比较常用的有:
project:Project本身对象
name:Project的名字
path:Project的绝对路径
description:Project的描述信息
buildDir:Project构建结果存放目录
version:Project的版本号
属性都可以通过getter和setter方法来访问,也可以直接使用点好的形式来访问,例如:
setDescription('myProject')
println "Description of project $name: "+project.description
当在build.gradle中访问属性和方法的时候,不需要使用project变量,它会假设你使用的是project实例。但是有一些情况需要注意,例如:
version = 'this is the project version'
description = 'this is the project description'
task showProjectProperties << {
println version
println project.description
println description
}
由于Task本身也有description属性,所以当在Task中,如果不显式的指定project,就会打印的是Task的description。这是因为定义Task的闭包将delegate设置成了当前的Task。有关delegate的介绍,我们可以看前一篇文章。
Gradle还为我们提供了多种方法来自定义Project的Property。
2 额外属性
Gradle的很多领域模型类提供了特别的属性支持。在内部,这些属性以简直对的形式存储。为了添加属性,你需要使用ext命名空间。
// 只在初始声明额外属性时需要使用ext命名空间
project.ext.myProp='myValue'
ext{
someOtherProp=123
}
// 使用ext命名空间访问属性是可选的
assert myProp=='myValue'
println project.someOtherProp
ext.someOtherProp=567
类似的,额外的属性也可以通过属性文件来提供。
3 Gradle属性
Gradle属性可以通过在gradle.properties文件中声明直接添加到项目中,这个文件位于<USER_HOME>/.gradle目录或者项目的根目录下。这些属性可以通过项目实例访问。即使有多个项目,每个用户也只有能一个Gradle属性文件在xx/.gradle目录下,这是目前Gradle对它的限制。
在这个属性文件中声明的属性对所有的项目可用。
我们假设在gradle.properties文件中声明的:
exampleProp=myValue
someOtherProp=455
可以按照如下方式访问项目中的这两个变量
assert project.exampleProp=='myValue'
task printGradleProperties <<{
println "Second property :$someOtherProp"
}
4 声明属性的其他方式
前面两种方式,我们大多用来声明自定义变量及其值。Gradle也提供了很多其他方式为构建提供属性。
4.1 项目属性通过 -P命令行选项提供
对于下面的例子,
task printMyProperties <<{
println myProperties
}
如果我们直接执行 gradle -q printMyProperties
命令,会报错:
* What went wrong:
Execution failed for task ':printMyProperties'.
> Could not get unknown property 'myProperties' for task ':printMyProperties' of type org.gradle.api.DefaultTask.
这是因为myProperties属性没有定义,所以我们在调用gradle命令的时候可以通过 -P 命令来传参数,就可以把这个属性打印出来。
gradle -q -P myProperties='this is -P params' printMyProperties
4.2 系统属性通过 -D命令行选项提供
与在Java中类似的,我们在Gradle中也可以通过-D来定义JVM的系统参数,只是需要增加一些约定,每个通过-D 方式声明的属性前面都要以“org.gradle.project”为前缀,例如:
gradle -q -D org.gradle.project.myProperties='this is -D params' printMyProperties
4.3 环境属性模式提供
我们可以通过设置环境变量的形式来设置Project的属性。但是也要增加一些约定,例如每个属性前面都要加上一个ORG_GRADLE_PROJECT_
的前缀,例如:
ORG_GRADLE_PROJECT_propertyName=someValue
当你再去执行printMyProperties这个task的时候就不用传参数了。
下一篇,我们会开始探索task的依赖,构建的生命周期等内容。