Gradle 常用配置總結

来源:https://www.cnblogs.com/leavesC/archive/2018/09/10/9624397.html
-Advertisement-
Play Games

這裡分享下我在日常開發中對 Gradle 的常用配置規則 一、版本號配置 當項目逐漸演進的過程中，主工程依賴的 可能會越來越多，此時就需要統一配置各個 的編譯參數了 在工程的根目錄下新建一個 文件，命名為 ，在此文件中統一聲明工程的編譯屬性和依賴庫的版本號 預設情況下， 的 文件的預設配置如下所示 ...


這裡分享下我在日常開發中對 Gradle 的常用配置規則

一、版本號配置

當項目逐漸演進的過程中，主工程依賴的 Module 可能會越來越多，此時就需要統一配置各個 Module 的編譯參數了

在工程的根目錄下新建一個 gradle 文件，命名為 config.gradle，在此文件中統一聲明工程的編譯屬性和依賴庫的版本號

ext {
    compileSdkVersion = 28
    minSdkVersion = 15
    targetSdkVersion = 28
    versionCode = 1
    versionName = '1.0'

    dependencies = [
            appcompatV7     : 'com.android.support:appcompat-v7:28.0.0-rc02',
            constraintLayout: 'com.android.support.constraint:constraint-layout:1.1.3',
            junit           : 'junit:junit:4.12',
            testRunner      : 'com.android.support.test:runner:1.0.2',
            espressoCore    : 'com.android.support.test.espresso:espresso-core:3.0.2'
    ]

}

預設情況下，App Module 的 build.gradle 文件的預設配置如下所示

apply plugin: 'com.android.application'

android {
    compileSdkVersion 28
    defaultConfig {
        applicationId "leavesc.hello.gradlesamples"
        minSdkVersion 15
        targetSdkVersion 28
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.support:appcompat-v7:28.0.0-rc02'
    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

這裡將其改為引用 config.gradle 文件的形式

首先，需要在根目錄下的 build.gradle 文件中應用 config.gradle 文件，這樣在 Module 配置文件中才引用得到當中的屬性值

此時就可以修改應用版本號以及依賴庫的聲明方式了

apply plugin: 'com.android.application'

def globalConfiguration = rootProject.ext
def presentationDependencies = globalConfiguration.dependencies

android {
    compileSdkVersion globalConfiguration["compileSdkVersion"]
    defaultConfig {
        applicationId "leavesc.hello.gradlesamples"
        minSdkVersion globalConfiguration["minSdkVersion"]
        targetSdkVersion globalConfiguration["targetSdkVersion"]
        versionCode globalConfiguration["versionCode"]
        versionName globalConfiguration["versionName"]
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    implementation presentationDependencies.appcompatV7
    implementation presentationDependencies.constraintLayout
    testImplementation presentationDependencies.junit
    androidTestImplementation presentationDependencies.testRunner
    androidTestImplementation presentationDependencies.espressoCore
}

這樣，即使以後工程中包含多個 Module ，只要配置的屬性都是來自於 config.gradle 文件，就可以做到統一修改編譯屬性與依賴庫版本了

二、簽名屬性配置

通常，應用的簽名類型會分為 release 和 debug 兩類，並分別使用不同的簽名文件
為了安全考慮以及實現自動化打包，可以通過 gradle 來聲明簽名配置，包括簽名文件路徑、簽名別名、簽名密碼等
在 local.properties 文件中聲明簽名文件路徑以及簽名密碼

sdk.dir=C\:\\Software\\SDK
key.keyStorePath=..\\doc\\key.jks
key.keyAlias=leavesC
key.keyPassword=987654321
key.storePassword=123456789

根據配置可知，簽名文件是放在工程的 doc 文件夾內

通過代碼獲取到簽名的各個配置項

Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
def keyStorePath_ = properties.getProperty("key.keyStorePath")
def storePassword_ = properties.getProperty("key.storePassword")
def keyAlias_ = properties.getProperty("key.keyAlias")
def keyPassword_ = properties.getProperty("key.keyPassword")
def storeFile_ = file(keyStorePath_)

配置不同的簽名屬性以及 build 類型

    signingConfigs {
        release {
            storeFile storeFile_
            storePassword storePassword_
            keyAlias keyAlias_
            keyPassword keyPassword_
            v1SigningEnabled true
            v2SigningEnabled true
        }
        debug {
            storeFile storeFile_
            storePassword storePassword_
            keyAlias keyAlias_
            keyPassword keyPassword_
            v1SigningEnabled true
            v2SigningEnabled true
        }
    }

    buildTypes {
        debug {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.debug
        }
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
    }

此處，我配置了兩種不同的 buildType：debug、release，並對應不同的簽名文件

以後只要選定不同的 Build Variant，即可打包具體簽名的 Apk 文件

而 local.properties 文件可以保存到伺服器來實現遠程打包，從而保證了隱私安全

三、多渠道打包

有時候，為了方便進行精準營銷，會有生成不同渠道包的要求，此時就需要在同個應用上打上不同的渠道ID（channelId），這可以通過 productFlavors 來實現
先在 AndroidManifest.xml 文件中配置占位符，appKey 即對應各個渠道的 ID 值

        <meta-data
            android:name="APP_KEY"
            android:value="${appKey}" />

在 gradle.properties 文件中聲明需要的 ChannelId以及對應的 ApplicationId，在此文件中聲明的屬性可以直接在 build.gradle 中直接獲取到

#預設配置
defaultApplicationId=leavesc.hello.gradlesamples
##各個渠道的配置
#應用寶
yingyongbaoChannelId="yingyongbao"
yingyongbaoApplicationId=leavesc.hello.gradlesamples.yingyongbao
yingyongbaoAppKey=appKey_yingyongbao
#豌豆莢
wandoujiaChannelId="wandoujia"
wandoujiaApplicationId=leavesc.hello.gradlesamples.wandoujia
wandoujiaAppKey=appKey_wandoujia
#小米
xiaomiChannelId="xiaomi"
xiaomiApplicationId=leavesc.hello.gradlesamples.xiaomi
xiaomiAppKey=appKey_xiaomi

productFlavors 可以理解為是對同個產品的不同“風味要求”，可以根據配置項生成特定風味的產品（App）
例如，此處就為不同渠道設定了不同的 applicationId

buildConfigField 屬性則用於在 BuildConfig.java 文件中生成特定類型的欄位，此處就生成了一個類型為 String ，名為 channelId 的欄位，用於方便在應用運行過程中判斷當前應用的渠道類型

manifestPlaceholders 就是用於替換 AndroidManifest.xml 文件中的指定占位符了

    productFlavors {
        yingyongbao {
            applicationId yingyongbaoApplicationId
            buildConfigField "String", "channelId", yingyongbaoChannelId
            manifestPlaceholders = [appKey: yingyongbaoAppKey]
        }
        wandoujia {
            applicationId wandoujiaApplicationId
            buildConfigField "String", "channelId", wandoujiaChannelId
            manifestPlaceholders = [appKey: wandoujiaAppKey]
        }
        xiaomi {
            applicationId xiaomiApplicationId
            buildConfigField "String", "channelId", xiaomiChannelId
            manifestPlaceholders = [appKey: xiaomiAppKey]
        }
    }

在主佈局文件中展示當前應用的各項屬性值

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        StringBuilder sb = new StringBuilder();
        sb.append("ApplicationId: ");
        sb.append(getApplicationInfo().packageName);
        sb.append("\n");
        sb.append("ApplicationName: ");
        sb.append(getString(getApplicationInfo().labelRes));
        sb.append("\n");
        sb.append("ChannelId: ");
        sb.append(BuildConfig.channelId);
        sb.append("\n");
        try {
            ApplicationInfo appInfo = getPackageManager().getApplicationInfo(getPackageName(), PackageManager.GET_META_DATA);
            String appKey = appInfo.metaData.getString("APP_KEY");
            sb.append("AppKey: ");
            sb.append(appKey);
        } catch (PackageManager.NameNotFoundException e) {
            e.printStackTrace();
        }
        TextView tv_appInfo = findViewById(R.id.tv_appInfo);
        tv_appInfo.setText(sb);
        ImageView iv_log = findViewById(R.id.iv_log);
        iv_log.setImageResource(getApplicationInfo().icon);
    }

四、打包時指定 Apk 名字

為了方便標識各個測試包的版本已經打包時間，可以通過 Gradle 來指定生成的 Apk 文件的命名規則

例如，以下配置就根據 buildType、flavorName 和 編譯時間 來命名 Apk 文件

    applicationVariants.all { variant ->
        def buildType = variant.buildType.name
        def flavorName = variant.flavorName
        def createTime = new Date().format("YYYY-MM-dd_hh_mm_ss", TimeZone.getTimeZone("GMT+08:00"))
        variant.outputs.all {
            outputFileName = flavorName + "_" + buildType + "_v" + defaultConfig.versionName + "_" + createTime + ".apk"
        }
    }

五、生成屬性欄位與資源文件值

上邊講過，buildConfigField 屬性可用於在 BuildConfig.java 文件中生成特定類型的欄位，此處可以利用其來記錄應用的編譯時間

此外，也可以利用 resValue 來生成一個 ID 引用類型的 string 字元串

首先，聲明兩個方法，分別用於獲取當前時間以及當前電腦的用戶信息

static def buildTime() {
    return new Date().format("yyyy-MM-dd HH:mm:ss")
}

static def hostName() {
    return System.getProperty("user.name") + "@" + InetAddress.localHost.hostName
}
    defaultConfig {
        applicationId defaultApplicationId
        minSdkVersion globalConfiguration["minSdkVersion"]
        targetSdkVersion globalConfiguration["targetSdkVersion"]
        versionCode globalConfiguration["versionCode"]
        versionName globalConfiguration["versionName"]
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
        flavorDimensions '1'
        resValue "string", "build_host", hostName()
        buildConfigField "String", "build_time", "\"" + buildTime() + "\""
    }

用代碼來獲取這兩個屬性值

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        StringBuilder sb = new StringBuilder();
        sb.append("ApplicationId: ");
        sb.append(getApplicationInfo().packageName);
        sb.append("\n");
        sb.append("ApplicationName: ");
        sb.append(getString(getApplicationInfo().labelRes));
        sb.append("\n");
        sb.append("ChannelId: ");
        sb.append(BuildConfig.channelId);
        sb.append("\n");
        sb.append("BuildTime: ");
        sb.append(BuildConfig.build_time);
        sb.append("\n");
        sb.append("BuildUser: ");
        sb.append(getString(R.string.build_host));
        sb.append("\n");
        try {
            ApplicationInfo appInfo = getPackageManager().getApplicationInfo(getPackageName(), PackageManager.GET_META_DATA);
            String appKey = appInfo.metaData.getString("APP_KEY");
            sb.append("AppKey: ");
            sb.append(appKey);
        } catch (PackageManager.NameNotFoundException e) {
            e.printStackTrace();
        }
        TextView tv_appInfo = findViewById(R.id.tv_appInfo);
        tv_appInfo.setText(sb);
        ImageView iv_log = findViewById(R.id.iv_log);
        iv_log.setImageResource(getApplicationInfo().icon);
    }

六、替換資源文件

在多渠道打包時，除了需要在應用中打上特定的標簽外，也可能需要使之使用不同的資源文件，例如應用圖標和應用名稱

此時可以以各個 productFlavor 的名稱來命名相應的文件夾，併在其中放置相應的圖標文件以及聲明瞭應用名稱的 string.xml 文件，這樣在多渠道打包時，Gradle 就會自動引用相應的資源文件

上述所有的示例代碼可以在這裡獲取：GradleSamples

更多的讀書筆記可以看這裡：一份關於 Java 、Kotlin 、 Android 的學習筆記


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • JVM vs DVM
    JVM vs DVM ...
  • Android architecture
    Android四層架構 ...
  • 支持scrollTo的RecycleView
    RecycleView內部沒有幫我們實現ScrollTo的方法，不過幫我們實現了ScrollBy，我們可以通過ScrollBy自定義一個支持scrollTo的RecycleView。 ...
  • TextView走馬燈
    設置textView走馬燈形式顯示： 給Textview設置以上的屬性，android:ellipsize="marquee"便是指定超出範圍的時候以跑馬的形式顯示（註意上面的屬性是只有在內容超出TextView寬度時候才有效果）。 不能用max_line屬性，要用singleLine屬性。 別忘了 ...
  • 【轉載】Android RecyclerView 使用完全解析 體驗藝術般的控制項
    崇拜下鴻洋大神，原文地址：http://blog.csdn.net/lmj623565791/article/details/45059587 概述 RecyclerView出現已經有一段時間了，相信大家肯定不陌生了，大家可以通過導入support-v7對其進行使用。 據官方的介紹，該控制項用於在有限 ...
  • Picasso源碼解析
    本來這一篇文章，早就應該寫了，但是最近一直在研究項目的安全性，就一直耽擱了。研究了一段時間的安全性，收穫頗豐，下一篇文章，將總結一下最近的收穫。好了，先把Picasso捋一遍。老規矩，先上流程圖。這張圖，從網上找來的。 Picasso的簡單使用 build.gradle依賴 載入圖片 就一句代碼，就 ...
  • 環信easeui集成：坑總結2018（二）
    環信EaseUI 集成，集成不做描述，看文檔即可，下麵主要談一些對easeui的個性化需求修改。 該篇文章將解決的問題： 1、如何發送視頻功能 2、未完待續。。 一、如何發送視頻 1、環信easeui 會話功能預設支持圖片，拍照，位置 三個功能 想支持播放視頻需要自己添加。 官方提供發送視頻方法： ...
  • retrofit框架介面調用時候報Throwing new exception
    最近在開發的時候遇到了一個很坑的問題，在三星6.0手機上請求介面時候報了一個異常：Throwing new exception 'length=1658; index=3248' with unexpected pending exception: java.lang.ArrayIndexOutOf ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類