深入剖析gradle.properties文件

一、gradle.properties文件在哪

gradle.properties文件是Gradle項目中的一個屬性文件，用於定義Gradle構建文件的屬性。在一個簡單的Gradle項目中，gradle.properties文件應該位於項目根目錄下。如果一個Gradle項目包含多個模塊，每個模塊都可以有一個gradle.properties文件，也可以定義一個位於根目錄的全局gradle.properties文件。

為了在Gradle中引用這些屬性，可以使用project的屬性查找機制，或者使用System.getProperty()方法中的-D參數。

二、gradle.properties文件的作用

gradle.properties文件可以用來定義許多不同的Gradle項目屬性，例如：

– 配置項目版本號和組織ID

– 配置Java源代碼和測試代碼的根路徑

– 配置依賴管理以及存儲庫管理，例如mavenCentral()

– 配置構建項目時使用的插件

– 配置Gradle構建時需要的JVM參數

– 等等……

三、如何在項目中使用gradle.properties文件

以下是在項目中使用gradle.properties文件的步驟：

1. 在項目根目錄下創建一個名為gradle.properties的文件。

2. 打開該文件並添加任何項目屬性，以鍵值對的形式表示。

3. 在一個Gradle構建腳本中，可以使用project對象的屬性訪問這些屬性。

//gradle.properties文件
group=cn.example.project
version=1.0.0

//build.gradle文件
apply plugin: 'java'
description 'Example Java Library'

//組織ID和版本號通過project對象屬性獲取
group = project.group
version = project.version

sourceCompatibility = 1.8
targetCompatibility = 1.8

//聲明使用Maven中心庫
repositories {
    mavenCentral()
}

dependencies {
    //在這裡添加你需要的依賴
}

四、gradle.properties文件的高級用法

1、使用外部文件

在Gradle腳本中引用外部.properties文件的方法非常簡單。可以使用Properties文件類將.properties文件中的文本加載到Java properties對象中。以下是如何實現的示例：

//gradle.properties
prop1=exampleValue
prop2=anotherValue

//build.gradle
Properties props = new Properties()
file("$projectDir/gradle.properties").withInputStream { 
    inputStream -> props.load(inputStream) 
}
def myProp1 = props.getProperty("prop1")
def myProp2 = props.getProperty("prop2")

2、添加系統環境變量

在Gradle腳本中添加系統環境變量非常容易。可以使用System.getenv()方法獲取系統環境變量。以下是如何實現的示例：

//將環境變量賦給一個project屬性
project.ext.absPath = System.getenv("MY_ENV_VAR")

3、使用命令行參數

可以使用-JvmArgs參數在命令行上向Gradle添加JVM參數。Gradle也接受-D參數，該參數會在Gradle啟動時傳遞給JVM。可以使用這些參數向Gradle項目傳遞額外的屬性，例如：

gradle -DmyProp1=exampleValue -DmyProp2=anotherValue build

總結

gradle.properties文件是Gradle項目中一個非常有用的文件，它可以用於定義Gradle構建處理的各種屬性，例如構建版本號，依賴管理等。在Gradle項目中使用它可以使你的項目更加靈活和易於管理。