gradle编译工具,参数传递

gradle编译工具,参数传递

gradle props

Gradle supports both project properties and system properties/enviroment properties).

The main difference between the two that is of interest in this post is how each is accessed.

Project properties are more conducive to direct access by name while system properties are accessed via normal Java/Groovy system properties
access methods.

Passing Project Properties from Command-Line with -P

One of the easiest approaches for passing properties to a Gradle build is to specify project properties with -Pfrom the command line.
Properties passed into the build with -P are readily accessible in the build as project properties and, if their naming structure allows, can be accessed directly like variables.

Passing System Properties from Command-Line with -D

As is the case with other Java applications, one can pass system properties to Gradle builds with -D.

Although these system properties provided to the Gradle build via the -D option are always available to the Gradle build via the normal Java mechanism for obtaining system properties,System.getProperty("xxxx")

Gradle makes it possible to specify Project Properties as system properties. This is done by placing the prefix org.gradle.project. before the name of the property desired in the build.

For example, if one wanted to specify a system property namedname.first with -D that would be available to the Gradle build as if it was provided with -P,
the person could provide it to the Gradle build on the command line as org.gradle.project.name.first
and the Gradle build would see it as a project property named name.first.

Passing System Properties via Environmental Variable

Any Java or Groovy application (including a Gradle build) can access environmental variables via System.getenv(String).

However, Gradle allows environment variables to be accessed within the build like other project properties if the environmental variable is prefixed with ORG_GRADLE_PROJECT_.

For example, if one wanted a project property in the Gradle build to be called name.last and wanted to supply it to the build via environment variable, that person could declare the environment variableORG_GRADLE_PROJECT_name.last and its value would be available to the Gradle build as a project property with name name.last.

gradle.properties

Properties can also be provided to a Gradle build via a properties file named gradle.properties. Any properties specified with systemProp. at the beginning of their property name are seen as system properties in the Gradle build and other properties (without their names beginning with "systemProp.") are seen as Gradle project properties. For example, if my gradle.properties file had a property name.last=Marx and a propertysystemPropr.name.first=Dustin, the name.last property would be seen and accessed in the Gradle build like any project property while the name.first property would be seen and accessed in the Gradle build like any system property.

The screen snapshot indicates how properties are seen/accessed in the Gradle build depending on their source and naming convention. In short, the output demonstrates the following "rules" of property availability in a Gradle build:

demo buid.gralde

apply plugin: 'groovy'

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.3.11'
    testCompile group: 'junit', name: 'junit', version: '4.12'
}


task mkdir {
    doLast {
        mkdir("src/main/groovy")
        mkdir("src/main/resources")
        mkdir("src/test/groovy")
        mkdir("src/test/resources")
    }
}


task displayProperties {
    doLast {
        printSystemProps()
        printProjectProps()
    }
}

def printSystemProps() {
    println "\n=== System Properties ==="
//    println "systemProp_environmental_variable: ${System.properties['systemPropA']}"   //need to change to below line,env variable
    //in linux:             export systemProp_environmentalVariable='systemProp from environmentalVariable'
    println "systemProp_environmentalVariable: ${System.getenv('systemProp_environmentalVariable')}"
    //in gradle.properties file , make sure the prop starts with systemProp.,that is
    //systemProp.systemProp_propertyFile=systemProp from propertyFile
    println "systemProp_propertyFile: ${System.properties['systemProp_propertyFile']}"

    //gradle :gradlePropertiesStudy:displayProperties -DsystemProp_dashD='systemProp from -D'
    println "systemProp_dashD: ${System.properties['systemProp_dashD']}"
}

def printProjectProps() {
    println "\n=== Gradle Project Properties ==="

    //in linux:             export ORG_GRADLE_PROJECT_projectProp_environmentalVariable='projectProp from environmentalVariable'
    println "projectProp_environmentalVariable: ${getProjectProp('projectProp_environmentalVariable')}"
    println "projectProp_propertyFile: ${getProjectProp('projectProp_propertyFile')}"
    //gradle :gradlePropertiesStudy:displayProperties -PprojectProp_dashP='projectProp from -P'
    println "projectProp_dashP: ${getProjectProp('projectProp_dashP')}"

    //gradle :gradlePropertiesStudy:displayProperties -Dorg.gradle.project.projectProp_dashD='projectProp from -D'
    //make sure it starts with org.gradle.project.
    println "projectProp_dashD: ${getProjectProp('projectProp_dashD')}"

}

def String getProjectProp(String propertyName) {
    if (hasProperty(propertyName)) {
        return this.properties[propertyName]
    }
    return "N/A"
}

demo gradle.properties

projectProp_propertyFile=projectProp from propertyFile
systemProp.systemProp_propertyFile=systemProp from propertyFile

demo cli command

hunter@hunter-ubu:~/workspaces/groovy$ gradle -q :gradlePropertiesStudy:displayProperties -PprojectProp_dashP='projectProp from -P' -DsystemProp_dashD='systemProp from -D' -Dorg.gradle.project.projectProp_dashD='projectProp from -D'

=== System Properties ===
systemProp_environmentalVariable: systemProp from environmentalVariable
systemProp_propertyFile: systemProp from propertyFile
systemProp_dashD: systemProp from -D

=== Gradle Project Properties ===
projectProp_environmentalVariable: projectProp from environmentalVariable
projectProp_propertyFile: projectProp from propertyFile
projectProp_dashP: projectProp from -P
projectProp_dashD: projectProp from -D

主要还是参考下我提供的这个例子,里面列举了所有传递参数的方式。

总结

Command-line -P properties are "project properties"
Command-line -D properties are, with one exception, "system properties",use System.getProperty("xxxx")
Command-line -D properties that begin with org.gradle.project. are "project properties"
Properties specified in gradle.properties are, with one exception, "project properties"
Properties specified in gradle.properties that begin with systemProp. are "system properties",use System.getProperty("xxxx")
Properties specified via environment variable are, with one exception, "enviroment properties",use system.getenv("xxxx")
Properties specified via environment variables that begin with ORG_GRADLE_PROJECT_ are "project properties"
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容