独自のプロパティファイルを参照する

下記は、Java の Properties クラスを利用して、独自の .properties ファイルを読み込むサンプルです。 例えば、次のような sample.properties をプロジェクトのルートディレクトに置いておきます。

sample.properties

key1=value1
key2=value2

下記のビルドスクリプトの loadProperties メソッドは、指定した .properties ファイルを読み込み、オブジェクトとして返します。

build.gradle

/**
 * Reads properties from the specified .properties file.
 */
def loadProperties(filename) {
    def props = new Properties()
    file(filename).withInputStream {
        props.load(it)
    }
    return props
}

task hello << {
    def props = loadProperties("$rootDir/sample.properties")
    println "props.key1 = ${props.key1}"
    println "props.key2 = ${props.key2}"
}

実行結果

$ gradle -q hello
props.key1 = value1
props.key2 = value2

読み込んだプロパティ設定を、プロジェクト全体から参照できるようにしたいときは、下記のように、プロジェクトの ext プロパティに設定してしまえば OK です。

def loadProperties(filename) {
    def props = new Properties()
    file(filename).withInputStream {
        props.load(it)
    }
    ext.props = props    // ★プロジェクト全体から見えるようにする
}

task hello << {
    loadProperties("$rootDir/sample.properties")
    println "props.key1 = ${props.key1}"
    println "props.key2 = ${props.key2}"
}

gradle.properties を参照する

プロジェクトのディレクトリに配置した gradle.properties に記述した設定内容は、自動的に project オブジェクトのプロパティとして参照できるようになります。

gradle.properties

key1=value1
key2=value2

build.gradle

task hello << {
    println "project.key1 = ${project.key1}"  // project は省略可能
    println "project.key2 = ${project.key2}"
}

実行結果

$ gradle -q hello
project.key1 = value1
project.key2 = value2

ただし、ユーザディレクトリの .gradle/gradle.properties ファイルに、同じキーのプロパティが定義されていると、そちらの値が優先されるので注意しましょう。

＜USER_HOME＞/.gradle/gradle.properties

key2=value2 (overridden)

実行結果

$ gradle -q hello
project.key1 = value1
project.key2 = value2 (overridden)

いずれにしても、gradle.properties はビルド環境に関する設定を記述するためのファイルです。 プロジェクト特有のリソースや設定値などをビルドスクリプトの外で管理したい場合は、独自のプロパティファイルとして作成してしまう方が安全です。

（注意）gradle.properties ファイル内で定義するプロパティのキー名に、ドットやハイフンが含まれている場合は、${xxx.yyy.zzz} の形ではなく、getProperty('xxx.yyy.zzz') のように参照する必要があります。

参考

• The Build Environment - Gradle User Guide