Android Gradle 獲取properties文件參數(shù) 解決中文亂碼

一、前言

當(dāng)我們?cè)贏ndroid Studio創(chuàng)建一個(gè)工程的時(shí)候，都會(huì)存在 local.properties 和 gradle.properties 兩個(gè)文件，如下圖

項(xiàng)目結(jié)構(gòu)

Properties其實(shí)是Java項(xiàng)目中的配置文件，不是Gradle獨(dú)創(chuàng)的。因?yàn)镚radle語(yǔ)法可以和Java進(jìn)行混合使用，所以在Java項(xiàng)目上面使用Properties文件的方式，在Gradle上面也可以使用。

獲取 gradle.properties 的內(nèi)容不需要我們額外寫(xiě)任何代碼，可以直接在build.gradle中進(jìn)行調(diào)用。local.properties 是 Android Studio 配置SDK和NDK一些路徑，還不可以直接調(diào)用。

二、Properties

了解Properties，其實(shí)最主要是了解它的數(shù)據(jù)格式。Properties

數(shù)據(jù)格式以鍵值對(duì)的方式：key=value

"#"作為注釋使用

三、Gradle中使用properties

1、gradle.properties

因?yàn)?Gradle 內(nèi)置了對(duì) gradle.properties 的調(diào)用方式，所以 build.gradle 可以直接獲取 gradle.properties 中的內(nèi)容。
需要注意的是 gradle.properties 中的value是都不需要帶 "" ，Gradle 會(huì)先把值轉(zhuǎn)換為String類型。

gradle.properties：

# The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx1536m
# 版本號(hào)
VERSION_CODE=1
# 版本名稱
VERSION_NAME=1.0.0
# 包名
APPLICATION_ID=com.example.properties
# 應(yīng)用名稱
APP_NAME=簡(jiǎn)書(shū)
# 應(yīng)用渠道
APP_CHANNEL=official
# 是否Debug
IS_DEBUG=true

build.gradle：

apply plugin: 'com.android.application'

// 打印日志
println "VERSION_CODE = " + VERSION_CODE.toInteger()
println "VERSION_NAME = " + VERSION_NAME.toString()
println "APPLICATION_ID = " + APPLICATION_ID.toString()
println "APP_NAME = " + APP_NAME.toString()
println "APP_CHANNEL = " + APP_CHANNEL.toString()
if (IS_DEBUG.toBoolean()) {
    println "IS_DEBUG is true"
} else {
    println "IS_DEBUG is false"
}

android {
    compileSdkVersion 28
    buildToolsVersion "28.0.3"

    defaultConfig {
        applicationId APPLICATION_ID.toString()
        minSdkVersion 19
        targetSdkVersion 28
        versionCode VERSION_CODE.toInteger()
        versionName VERSION_NAME.toString()
    }

    productFlavors {
        official {
            manifestPlaceholders = [
                    APP_NAME: APP_NAME.toString()
            ]
        }
    }
}

AndroidManifest：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="${APP_NAME}"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
    </application>
</manifest>

Run：
構(gòu)建APK文件輸出的日志，可以看到輸出的結(jié)果

打印日志

也可以通過(guò)AndroidManifest.xml實(shí)時(shí)查看，點(diǎn)擊Merged Mainfest：

這里可能很多人都不知道，AndroidManifest.xml 中出現(xiàn)Merge錯(cuò)誤也可以從這里定位

AndroidManifest.xml

2、其他 .properties文件

2-1、第一種獲取方式：

config.properties（新建）：

value不需要帶""

VERSION_CODE=1
VERSION_NAME=1.0.0
APPLICATION_ID=com.example.properties
APP_NAME=簡(jiǎn)書(shū)
APP_CHANNEL=official
IS_DEBUG=true

build.gradle：

本文例子config.properties是放在根目錄下，路徑都需要指明，否則編譯會(huì)報(bào)"找不到指定文件"。

// 默認(rèn)方式-寫(xiě)法1
Properties properties = new Properties()
properties.load(new FileInputStream(rootProject.getRootDir().getAbsolutePath() + "/config.properties"))
println "VERSION_CODE = " + properties.getProperty("VERSION_CODE")//也可以properties["VERSION_CODE"]
println "VERSION_NAME = " + properties.getProperty("VERSION_NAME")//也可以properties["VERSION_NAME"]
println "APPLICATION_ID = " + properties.getProperty("APPLICATION_ID")//也可以properties["APPLICATION_ID"]
println "APP_NAME = " + properties.getProperty("APP_NAME")//也可以properties["APP_NAME"]
println "APP_CHANNEL = " + properties.getProperty("APP_CHANNEL")//也可以properties["APP_CHANNEL"]
println "IS_DEBUG = " + properties.getProperty("IS_DEBUG")//也可以properties["IS_DEBUG"]

// 默認(rèn)方式-寫(xiě)法2
Properties properties = new Properties()
new File(rootProject.getRootDir().getAbsolutePath() + "/config.properties").withInputStream {
    stream -> properties.load(stream)
}
println "VERSION_CODE = " + properties.getProperty("VERSION_CODE")//也可以properties["VERSION_CODE"]
println "VERSION_NAME = " + properties.getProperty("VERSION_NAME")//也可以properties["VERSION_NAME"]
println "APPLICATION_ID = " + properties.getProperty("APPLICATION_ID")//也可以properties["APPLICATION_ID"]
println "APP_NAME = " + properties.getProperty("APP_NAME")//也可以properties["APP_NAME"]
println "APP_CHANNEL = " + properties.getProperty("APP_CHANNEL")//也可以properties["APP_CHANNEL"]
println "IS_DEBUG = " + properties.getProperty("IS_DEBUG")//也可以properties["IS_DEBUG"]

Run：
構(gòu)建APK文件輸出的日志，可以看到輸出的結(jié)果

打印日志

2-2、第二種獲取方式：

config.properties（新建）：

value需要帶""，否則獲取不了

VERSION_CODE=1
VERSION_NAME="1.0.0"
APPLICATION_ID="com.example.properties"
APP_NAME="簡(jiǎn)書(shū)"
APP_CHANNEL="official"
IS_DEBUG=true

build.gradle：

本文例子config.properties是放在根目錄下，路徑都需要指明，否則編譯會(huì)報(bào)"找不到指定文件"。

def configSlurper = new ConfigSlurper().parse(new File(rootProject.getRootDir().getAbsolutePath() + "/config.properties").toURL())
println "VERSION_CODE = " + configSlurper.VERSION_CODE
println "VERSION_NAME = " + configSlurper.VERSION_NAME
println "APPLICATION_ID = " + configSlurper.APPLICATION_ID
println "APP_NAME = " + configSlurper.APP_NAME
println "APP_CHANNEL = " + configSlurper.APP_CHANNEL
if (configSlurper.IS_DEBUG) {
    println "IS_DEBUG is true"
} else {
    println "IS_DEBUG is false"
}

Run：
構(gòu)建APK文件輸出的日志，可以看到輸出的結(jié)果

image.png

四、解決中文亂碼

以上匯總情況

情況1：gradle.properties獲取數(shù)據(jù)，會(huì)出現(xiàn)中文亂碼。
情況2：其他 .properties文件第一種獲取方式，會(huì)出現(xiàn)中文亂碼。（原理其實(shí)和1是一致的）
情況3：其他 .properties文件第二種獲取方式，沒(méi)有出現(xiàn)中文亂碼。

情況1和情況2的方式，試了UTF-8編碼解碼之后，得到的還是亂碼的，原因就是出在獲取的時(shí)候就是亂碼的，你再怎么編碼解碼都沒(méi)用。

因?yàn)榍闆r1和情況2都是通過(guò)字節(jié)流來(lái)獲取，所以中文都亂碼了。。。java基礎(chǔ)問(wèn)題呀?。?！

解決方式1（情況1）：

如果你的項(xiàng)目一定要使用 gradle.properties，因?yàn)?strong>情況1字節(jié)流的方式不能改，所以可以通過(guò)URL編碼/解碼來(lái)實(shí)現(xiàn)。

簡(jiǎn)書(shū) ==>%e7%ae%80%e4%b9%a6【通過(guò)UrlEncode編碼之后得到】

image.png

gradle.properties：

# The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx1536m
# 版本號(hào)
VERSION_CODE=1
# 版本名稱
VERSION_NAME=1.0.0
# 包名
APPLICATION_ID=com.example.properties
# 應(yīng)用名稱
APP_NAME=%e7%ae%80%e4%b9%a6
# 應(yīng)用渠道
APP_CHANNEL=official
# 是否Debug
IS_DEBUG=true

build.gradle：

最后再通過(guò)UrlDecode解碼就可以得到：URLDecoder.decode(APP_NAME.toString(), "UTF-8")

println "APP_NAME = " + URLDecoder.decode(APP_NAME.toString(), "UTF-8")

解決方式2（情況2）：

如果你的項(xiàng)目使用新建.properties文件，可以把情況2字節(jié)流讀取改成字符流讀取

config.properties（和之前一樣）：

VERSION_CODE=1
VERSION_NAME=1.0.0
APPLICATION_ID=com.example.properties
APP_NAME=簡(jiǎn)書(shū)
APP_CHANNEL=official
IS_DEBUG=true

build.gradle：

// 默認(rèn)方式-寫(xiě)法1
Properties properties = new Properties()
properties.load(new InputStreamReader(new FileInputStream(rootProject.getRootDir().getAbsolutePath() + "/config.properties")))
println "VERSION_NAME = " + properties.getProperty("VERSION_NAME")

解決方式3：

情況3就是無(wú)亂碼

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容