Gradle 奇技淫巧
Gradle 現在已經是 Android 開發必備的建構工具了。本文總結了一些在日常開發過程中會遇到的各種小技巧。
Android Gradle Plugin 的參考文檔在這里 http://google.github.io/android-gradle-dsl/current/index.html
buildTypes 和 productFlavors
buildTypes 是指建構的類型,一般只用兩種默認類型 debug 和 release ,顧名思義 debug 用來配置開發過程中的一些內容;release 用來配置正式發布版本的內容;這里面可以設置 applicationIdSuffix 、minifyEnabled 、name 等屬性,所有的可配置屬性參考這里 — BuildType 和 ProductFlavor 。
productFlavors 指各種產品分類,比如免費版本和收費版本。有些定制軟件可能會出很多版本,通過 productFlavors 就非常方便, 比如某某輸入法就經常出各種定制版,這樣以后管理代碼和發版就方便多了。
例如:
Java
defaultConfig { applicationId "org.goodev.material" // 配置生成的 BuildConfig 文件中的常量 buildConfigField "String", "CHANNEL", '"PLAY_STORE"' } buildTypes { debug { buildConfigField "String", "API_URL", '"http://dev.goodev.org/"' buildConfigField "boolean"?, "SHOW_LOG"?, "true" } release { buildConfigField "String", "API_URL", '"http://api.goodev.org/"' buildConfigField "boolean"?, "SHOW_LOG"?, "false" signingConfig signingConfigs.release } } productFlavors { youmi { applicationId = "org.goodev.material.youmi" buildConfigField "String", "CHANNEL", '"YOUMI"' resValue "string", "app_name", "Material free" } pro { applicationId = "org.goodev.material.pro" buildConfigField "String", "CHANNEL", '"OTHER"' resValue "string", "app_name", "Material pro" } } signingConfigs { release { storeFile "${System.env.PRIVATE_KEY}" keyAlias "${System.env.ALIAS}" storePassword "${System.env.STORE_PW}" keyPassword "${System.env.APP_PW}" } }
defaultConfig { applicationId "org.goodev.material" // 配置生成的 BuildConfig 文件中的常量 buildConfigField "String", "CHANNEL", '"PLAY_STORE"' } buildTypes { debug { buildConfigField "String", "API_URL", '"http://dev.goodev.org/"' buildConfigField "boolean"?, "SHOW_LOG"?, "true" } release { buildConfigField "String", "API_URL", '"http://api.goodev.org/"' buildConfigField "boolean"?, "SHOW_LOG"?, "false" signingConfigsigningConfigs.release } } productFlavors { youmi { applicationId = "org.goodev.material.youmi" buildConfigField "String", "CHANNEL", '"YOUMI"' resValue "string", "app_name", "Material free" } pro { applicationId = "org.goodev.material.pro" buildConfigField "String", "CHANNEL", '"OTHER"' resValue "string", "app_name", "Material pro" } } signingConfigs { release { storeFile "${System.env.PRIVATE_KEY}" keyAlias "${System.env.ALIAS}" storePassword "${System.env.STORE_PW}" keyPassword "${System.env.APP_PW}" } }
保護私有數據
上面示例中還演示了如何通過 System.env 來訪問系統環境變量中的值,這樣你就可以把一些私有的內容排除在代碼外,這樣當你提交代碼的時候,就不會泄露這些內容。還可以把私有數據放到local.properties 文件中:
Java
signingConfigs { release { def Properties localProps = new Properties() localProps.load(new FileInputStream(file('local.properties'))) def Properties keyProps = new Properties() if (localProps['keystore.props.file'] != null) { keyProps.load(new FileInputStream(file(localProps['keystore.props.file']))) } storeFile keyProps["store"] != null ? file(keyProps["store"]) : null keyAlias keyProps["alias"] ?: "" storePassword keyProps["storePass"] ?: "" keyPassword keyProps["pass"] ?: "" } }
signingConfigs { release { defPropertieslocalProps = new Properties() localProps.load(new FileInputStream(file('local.properties'))) defPropertieskeyProps = new Properties() if (localProps['keystore.props.file'] != null) { keyProps.load(new FileInputStream(file(localProps['keystore.props.file']))) } storeFilekeyProps["store"] != null ? file(keyProps["store"]) : null keyAliaskeyProps["alias"] ?: "" storePasswordkeyProps["storePass"] ?: "" keyPasswordkeyProps["pass"] ?: "" } }
使用 Git tag 或者 hash 作為版本號
Java
// query git for the SHA, Tag and commit count. Use these to automate versioning. def gitSha = 'git rev-parse --short HEAD'.execute([], project.rootDir).text.trim() def gitTag = 'git describe --tags'.execute([], project.rootDir).text.trim() def gitCommitCount = 100 + Integer.parseInt('git rev-list --count HEAD'.execute([], project.rootDir).text.trim()) defaultConfig { versionCode gitCommitCount versionName gitTag archivesBaseName = "material-${versionName}" buildConfigField "String", "GIT_SHA", "\"${gitSha}\"" }
// query git for the SHA, Tag and commit count. Use these to automate versioning. defgitSha = 'git rev-parse --short HEAD'.execute([], project.rootDir).text.trim() defgitTag = 'git describe --tags'.execute([], project.rootDir).text.trim() defgitCommitCount = 100 + Integer.parseInt('git rev-list --count HEAD'.execute([], project.rootDir).text.trim()) defaultConfig { versionCodegitCommitCount versionNamegitTag archivesBaseName = "material-${versionName}" buildConfigField "String", "GIT_SHA", "\"${gitSha}\"" }
使用建構的時間
Java
def buildTime = new Date().format("yyyy-MM-dd'T'HH:mm:ss'Z'", TimeZone.getTimeZone("UTC")) defaultConfig { buildConfigField "String", "BUILD_TIME", "\"${buildTime}\"" // 還可以這樣 buildConfigField "long", "BUILD_TIME_LONG", "${System.currentTimeMillis()}L" }
defbuildTime = new Date().format("yyyy-MM-dd'T'HH:mm:ss'Z'", TimeZone.getTimeZone("UTC")) defaultConfig { buildConfigField "String", "BUILD_TIME", "\"${buildTime}\"" // 還可以這樣 buildConfigField "long", "BUILD_TIME_LONG", "${System.currentTimeMillis()}L" }
動態生成 Android Manifest 中的內容
為了讓所有的 productFlavors 都可以安裝到同一個手機上, 安卓系統要求不同的應用具有不同的 provider 等內容,如果沖突則其他應用無法安裝,可以通過如下方式來解決該問題
XHTML
<permission android:name="${applicationId}.permission.XX" android:protectionLevel="signature" /> <uses-permission android:name="${applicationId}.permission.XX" /> <provider android:name=".MyProvider" android:authorities="${applicationId}.provider" … />
<permissionandroid:name="${applicationId}.permission.XX" android:protectionLevel="signature"/> <uses-permissionandroid:name="${applicationId}.permission.XX"/> <provider android:name=".MyProvider" android:authorities="${applicationId}.provider" …/>
不同的 productFlavors 具有不同的 permission
有的應用,不同的版本可能要求的權限不一樣,也就是不同的 productFlavors 所對應的 Manifest 文件內容是不同的,除了通過上面的方式替代部分內容外,就要用到Manifest 文件合并功能了。
比如可以分別創建所有 productFlavors 對應的 AndroidManifest 文件:
app/src/free/AndroidManifest.xml
app/src/pro/AndroidManifest.xml
app/src/adsfree/AndroidManifest.xml
然后在默認的 Manifest 文件中寫上所有的內容, 如果那個里面不需要某個 XML 屬性,可以通過 tools:node=”remove” 來刪除:
XHTML
<permission android:name="com.android.vending.CHECK_LICENSE" tools:node="remove"/>
<permission android:name="com.android.vending.CHECK_LICENSE" tools:node="remove"/>
另外還有一種方式就是,默認的 Manifest 文件中值寫上共同的內容, 不同的內容分別寫到對應的 productFlavors 的 Manifest 文件中。