Gradle Property 使用详解

发表于   |   分类于   |  

Gradle支持很多种方式去设置Property，方式太多了，我们有必要了解一下每种方式的使用

Property 分类

Property 可以分为3类：

  • Gradle Property
  • System Property
  • 自定义Property

Gradle Property

通过命令行定义

通过命令行定义的Gradle Property，格式必须为 -Pxxx，其中xxx为对应的Property名字

1
gradle -q showGradleProperty -PmyProperty=myPropertyFromGradleCMD

build.gradle:

1
2
3
task showGradleProperty << {
    println myProperty 
}

通过gradle.properties定义

gradle.properties:

1
myProperty=myPropertyFromGradleProperties

build.gradle:

1
2
3
task showGradleProperty << {
    println myProperty 
}

System Property

通过命令行定义

我们可以通过-D参数定义JVM的系统参数，格式必须为 -Dorg.gradle.project.xxx，其中xxx为对应的Property名字

1
gradle -q showSystemProperty -Dorg.gradle.project.myProperty=myPropertyFromSystemPropertyCMD

build.gradle:

1
2
3
task showSystemProperty << {
    println System.properties['myProperty']
}

通过gradle.properties定义

通过gradle.properties定义的SystemProperty，格式必须为 systemProp.xxx，其中xxx为对应的Property名字

gradle.properties：

1
systemProp.myPropert=myPropertyFromGradlePropertiesSystemProp

build.gradle:

1
2
3
task showSystemProperty << {
    println System.properties['myProperty']
}

通过系统环境变量设置

在环境变量中定义的SystemProperty，格式必须为 ORG_GRADLE_PROJECT_xxx，其中xx为对应的Property名字

1
export ORG_GRADLE_PROJECT_myProperty=myPropertyFromEnv

build.gradle:

1
2
3
task showSystemPropertyFromEnv << {
    println myProperty 
}

自定义Property

通过ext定义

build.gradle:

1
2
3
4
5
6
7
8
9
10
11
12

ext.myProperty = "myProperty from ext"

// or

// ext {
//     myProperty = "myProperty from ext"
// }

task showProperty << {
    println myProperty 
}

优先级

从Property的传入方式，我们大致分为

  • 命令行传入Property
  • 在gradle.properties传入Property
  • 在系统环境变量中传入Property

如果在多个地方设置了同一个Property，那么优先采用次序依次为：

命令行传入Property > 在gradle.properties传入Property > 在系统环境变量中传入Property

参考资料