7 個你應該知道的Gradle 實用技巧

2022-01-10 程式設計師的那些事

Gradle在android開發中應用地十分廣泛，但相信有很多同學並不很了解gradle
本文主要介紹了使用gradle的一些實用技巧，幫助讀者增進對這個熟悉的陌生人的了解
主要包括以下內容

1.Gradle依賴樹查詢

有時我們在分析依賴衝突時，需要查看依賴樹，我們常用的查看依賴樹的命令為

gradlew app:dependencies
不過這種命令行方式查看依賴樹出來的信息太多，看的有些費勁
所以官方又推出了Scan工具來幫助我們更加方便地查看依賴樹
在項目根目錄位置下運行gradle build \--scan即可，然後會生成 HTML 格式的分析文件的分析文件
分析文件會直接上傳到Scan官網，命令行最後會給出遠程地址
第一次跑會讓你在 Scan 官網註冊一下，郵件確認後就能看了
scan 工具是按照依賴變體挨個分類的，debugCompileClassPath 就是 dedug 打包中的依賴包了
 如上，使用這種方式分析依賴樹更加方便簡潔
2.使用循環優化Gradle依賴管理
如下所示，我們常常使用ext來管理依賴
    dependencies {
        implementation fileTree(include: ['*.jar'], dir: 'libs')
        implementation rootProject.ext.dependencies["appcompat-v7"]
        implementation rootProject.ext.dependencies["cardview-v7"]
        implementation rootProject.ext.dependencies["design"]
        implementation rootProject.ext.dependencies["constraint-layout"]
        annotationProcessor rootProject.ext.dependencies["glide_compiler"]
        ...
    }
這樣雖然實現了依賴的統一管理，但是隨著項目越來越大，依賴也會越來越多，常常會有幾十甚至上百行，導致build.gradle越來越長
有沒有一種好的方式不在 build.gradle 中寫這麼多的依賴配置？
有，就是使用循環遍歷依賴。
示例如下，首先添加config.gradle
ext{
 dependencies = [
            // base
            "appcompat-v7"                      : "com.android.support:appcompat-v7:${version["supportLibraryVersion"]}"，
            ...
    ]
    
    annotationProcessor = [
            "glide_compiler"                    : "com.github.bumptech.glide:compiler:${version["glideVersion"]}",
            ...
    ]
    
    apiFileDependencies = [
            "launchstarter"                                   :"libs/launchstarter-release-1.0.0.aar"
    ]
    
    debugImplementationDependencies = [
            "MethodTraceMan"                                  : "com.github.zhengcx:MethodTraceMan:1.0.7"
    ]
    
    ...
    
    implementationExcludes = [
            "com.android.support.test.espresso:espresso-idling-resource:3.0.2" : [
                    'com.android.support' : 'support-annotations'
            ]
    ]
    
    ...
}
然後在build.gradle中配置如下：
apply from config.gradle
...

def implementationDependencies = project.ext.dependencies
def processors = project.ext.annotationProcesso
def implementationExcludes = project.ext.implementationExcludes
dependencies{
    // 處理所有的 xxximplementation 依賴
    implementationDependencies.each { k, v -> implementation v }   
    // 處理 annotationProcessor 依賴
    processors.each { k, v -> annotationProcessor v }
    // 處理所有包含 exclude 的依賴
    implementationExcludes.each { entry ->
        implementation(entry.key) {
            entry.value.each { childEntry ->
                exclude(group: childEntry)
            }
        }
    }
    ...

}
這樣做的優點在於
1.後續添加依賴不需要改動build.gradle,直接在config.gradle中添加即可
2.精簡了build.gradle的長度
3.支持代碼提示的Gradle依賴管理
上面介紹了通過config.gradle管理依賴的方法
在我們添加Gradle依賴時，還有一些痛點
1.不支持代碼提示
2.不支持單擊跳轉
3.多模塊開發時，不同模塊相同的依賴需要複製粘貼
使用buildSrc+kotlin可以解決這個問題
效果如下：

由於buildSrc是對全局的所有module的配置,所以可以在所有module中直接使用
這裡就不多介紹了，詳細開發及引入buildSrc的過程可見:
[譯]Kotlin + buildSrc：更好的管理Gadle依賴
buildSrc vs includeBuild
上面介紹的方法使用的是buildSrc,使用起來比較方便
不過它的缺點在於構建速度上會慢一些，使用includeBuild可以實現同樣的效果
兩者實現的最終效果是差不多的
詳細實現可見:【奇技淫巧】除了 buildSrc 還能這樣統一配置依賴版本？巧用 includeBuild
4.Gradle模塊化
我們在開發中，引入一些插件時，有時需要在build.gradle中引入一些配置，比如greendao,推送,tinker等
這些其實是可以封裝在相應gradle文件中，然後通過apply from引入
舉個例子，例如在我們使用greendao資料庫時，需要在build.gradle中指定版本
這種時候應該新建一個greendao-config.gradle
apply plugin: 'org.greenrobot.greendao'

//greenDao指定版本和路勁等
greendao {
    //資料庫的schema版本，也可以理解為資料庫版本號
    schemaVersion 1
    //設置DaoMaster、DaoSession、Dao包名，也就是要放置這些類的包的全路徑。
    daoPackage 'com.example.ausu.big_progect.dao'
    //設置DaoMaster、DaoSession、Dao目錄
    targetGenDir 'src/main/java'
}
然後再在build.gradle中引入
apply from 'greendao-config.gradle'
這樣做主要有2個優點
1.單一職責原則，將greendao的相關配置封裝在一個文件裡，不與其他文件混淆
2.精簡了build.gradle的代碼，同時後續修改資料庫相關時不需要修改build.gradle的代碼
5.Library模塊Gradle代碼復用
隨著我們項目的越來越大，Library Module也越建越多，每個Module都有自己的build.gradle
但其實每個build.gradle的內容都差不多，我們能不能將重複的部分封裝起來復用？
我們可以做一個 basic 抽取，同樣將共有參數/信息提取到 basic.gradle 中，每個 module apply，這樣就是減少了不少代碼量
apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'

android {
    // 指定用於編譯項目的 API 級別
    compileSdkVersion Versions.compileSDK
    // 指定在生成項目時要使用的 SDK 工具的版本，Android Studio 3.0 後不需要手動配置。
    buildToolsVersion Versions.buildTools

    // 指定 Android 插件適用於所有構建版本的版本屬性的默認值
    defaultConfig {
        minSdkVersion Versions.minSDK
        targetSdkVersion Versions.targetSDK
        versionCode 1
        versionName "1.0"
    }

    // 配置 Java 編譯(編碼格式、編譯級別、生成字節碼版本)
    compileOptions {
        encoding = 'utf-8'
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    kotlinOptions {
        jvmTarget = JavaVersion.VERSION_1_8.toString()
    }

    lintOptions {
        // lint 異常後繼續執行
        abortOnError false
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    ...
}
然後在相應的模塊的build.gradle中引入即可
apply from:"../basic.gradle"

dependencies {
    api Deps.constraintLayout
    api Deps.retrofit
}
這樣是不是簡潔很多？讀者可根據項目實際情況判斷是否適合抽取basic.gradle使用
6.資源文件分包
隨著項目越來越大，項目中的資源文件也越來越大，比如layout與drawable文件夾下的文件數量常常可達幾百甚至上千個
我們能不能像代碼一樣，對資源文件進行分包呢？
答案是可以的，主要是利用gradle的sourceSets屬性
我們可以將資源文件像代碼一樣按業務分包,具體操作如下
1.新建res_xxx目錄

在 main 目錄下新建 res_core, res_feed（根據業務模塊命名）等目錄，在res_core中新建res目錄中相同的文件夾如：layout、drawable-xxhdpi、values等。
2.在gradle中配置res_xx目錄
android {
    //...
    sourceSets {
        main {
            res.srcDirs(
                    'src/main/res',
                    'src/main/res_core',
                    'src/main/res_feed',
            )
        }
    }
}
以上就完成了資源文件分包,這樣做主要有幾點好處
1.按業務分包查找方便，結構清晰
2.strings.xml等key-value型文件多人修改可以減少衝突
3.當刪除模塊或做組件化改造時資源文件刪除或遷移方便，不必像以前一樣一個個去找
7.AAR依賴與源碼依賴快速切換
當我們的項目中Module越來越多，為了加快編譯速度，常常把Module發布成AAR，然後在項目中直接依賴AAR
但是我們有時候又需要修改AAR，就需要依賴於源碼
所以我們需要一個可以快速地切換依賴AAR與依賴源碼的方式
我們下面舉個例子，以retrofit為例
假如我們要修改retrofit的源碼，修改步驟如下：
1.首先下載retrofit，可以放到和項目同級的目錄,並修改目錄名為retrofit-source,以便區分
2.在settings.gradle文件中添加需要修改的aar庫的源碼project
include ':retrofit-source'
project(':retrofit-source').projectDir = new File("../retrofit-source")
3.替換aar為源碼
build.gradle(android) 腳本中添加替換策略
allprojects {
    repositories {
...
    }
 
    configurations.all {
        resolutionStrategy {
            dependencySubstitution {
                substitute module( "com.squareup.retrofit2:retrofit") with project(':retofit-source')
            }
        }
    }
}
如上幾步，就可以比較方便地實現aar依賴與源碼依賴間的互換了
這樣做的主要優點在於
1.不需要修改原有的依賴配置，而是通過全局的配置，利用本地的源碼替換掉aar，侵入性低
2.如果有多個Module依賴於同一個aar，不需要重複修改，只需在根目錄build.gradle中修改一處
總結
本文主要介紹了幾個實用的Gradle技巧，如果覺得有所幫助，可以幫忙點讚
如果發現本文還有什麼不足，歡迎在評論區指出~
參考資料
Gradle Scan使用介紹
使用循環進行依賴優化
Android 重構 ｜ 持續優化統一管理 Gradle
Android res 資源 分包

相關焦點

  • 分享 7個 Gradle 實用小技巧
    前言Gradle在android開發中應用地十分廣泛，但相信有很多同學並不很了解gradle。本文主要介紹了使用gradle的一些實用技巧，幫助讀者增進對這個熟悉的陌生人的了解。主要包括以下內容：1.Gradle依賴樹查詢。2.使用循環優化Gradle依賴管理。
  • Android產品研發-->Android實用調試技巧
    Android的調試技巧包括熟練使用Android中的日誌API，自定義Android日誌框架，通過gradle配置調試日誌，Android studio的調試技巧等等。通過對本文的學習我們能夠對Android中調試技巧有一個大概的了解。
  • Gradle基礎知識點總結
    字符串與閉包相結合2.4.3 閉包的委託策略閉包有三個重要屬性：this，owner，delegate。指的就是當你在閉包內調用方法時，由它們來確定使用哪個對象來處理。Gradle的生命周期可以分為三個階段，分別為init初始化階段、Configuration配置階段和Execution執行階段。init初始化階段：解析整個工程中所有的Project，構建所有的Project對應的Project對象（執行setting.gradle文件）。
  • 擁抱Android Studio(二):Android Studio與Gradle深入
    基礎的功能我就不講了，下面列舉一些較為深入又比較實用的功能。Android Studio 相關功能介紹文件夾組織視圖最常用的有 Project 和 Android 視圖，前者按照項目文件樹進行組織，後者是以 Gradle 構建文件作為核心進行組織：
  • 3種方法帶你玩自定義Android Gradle插件
    gradle插件可以幫助我們幹很多事情，類似一個工具，可以根據你自己想要的效果去定製自己的插件，本文就講解一下怎麼去實現自己的一個插件。    }}我們build一下： 可以看到輸出了裡面的內容，這樣就完成了一個最簡單的插件開發，當然這裡沒有去做任何事情，只是列印一句話，後續我們會去開發一個比較實用的打包加固籤名apk的插件，這裡只是學會怎麼去做插件，但是這是插件只能在這個文件內引用，這樣局限性就比較大了，所以一般不採用此方式。
  • Gradle 與 Android 構建入門
    我們知道，一個 APK 包其實是一個 zip 包，包含代碼和資源。最常見的一個應用就是點擊 sync 後，AS 會在每個工程下生成 .iml 文件，他們與 .gradle、.idea 配合為我們提供了代碼提示等常見功能。所以如果你的代碼飄紅而你確認依賴沒有問題，可以嘗試下面步驟清除 AS 緩存：1. 刪.idea 刪.gradle 文件2. 命令行執行 ./gradlew clean3.
  • 原創 | 看完此文,你對Gradle的理解又升級了!
    但隨著團隊人數的增多，這樣做的風險會越來越大，因為籤名信息是重要的資源，這樣就不能將籤名上傳到github上，也就不應該在build.gradle中直接配置籤名。現在再舉個例子，拿我們熟悉的retrofit舉例，在模塊build.gradle中引入retrofit：implementation 'com.squareup.retrofit2:retrofit:2.6.0'執行依賴檢查命令，列印的關於retrofit的日誌如下：+|    \|         \
  • 掌控 Android Gradle
    例如我們新建一個 Android 工程，在其根目錄中輸入：gradle tasks -q可以看到如下輸出（你可能需要事先配置gradle的環境變量，或也可使用./gradlew替代）：根據上圖可以看到當前工程中的每條task都已羅列出，並且有黃色的輸出表示當前task的描述。
  • 【實戰】Android工程gradle詳解
    assembleBlue 會生成debug和release兩個版本gradle assembleDebug 會生成blue yellow red三個版本gradle assembleBlueDebug 會生成bluedebug一個版本這裡還有一個用處需要提一下：Gradle在打包android應用之前會將所有的代碼，資源文件，包括manifest進行結合，當然library
  • 給 Android 開發者的 Gradle 入門指南
    基礎知識為了解決這個問題，讓我們先弄清楚一些事情：Android Studio 不知道如何將 Java＆Kotlin 代碼編譯成 APK 文件。Gradle 不知道如何將 Java＆Kotlin 代碼編譯成 APK 文件。是的，你沒看錯。
  • 這一次,徹底了解 Gradle 吧!
    7. Gradle--官方文檔http://www.groovy-lang.org/api.html管方文檔最後還是推薦大家看看的，結合 Google 瀏覽器的自動翻譯插件，還是能看的，完全沒問題，剩下的就是 Gradle 插件的應用了，這塊大家自行查閱 掘金--android--gradle 板塊內的文章即可。
  • 寫給Android開發的Gradle知識體系
    前言老讀者都知道，我的技術博客從2016年開始就沒寫過不成系列的文章，這些系列文章組成了目前Android領域最全面深入的原創知識體系，更恐怖的是這個體系還在不斷的成長，關於這個知識體系可以點擊 閱讀原文 了解。
  • 翻譯自國外大牛總結的各種Android開發經驗和實用技巧
    靜態代碼審查工具也是個代碼審查工具，檢查可能出現的bug代碼風格管理的插件增加了例如卸載，重啟App的功能這個玩意挺NB的輸入個大概就能幫你寫代碼。其中的bind view 挺好用的。/gradlew clean build -x javaDoc為每個子項目的腳本配置同名 gradle 構建文件settings.gradle 中設置rootProject.children.each{  it.buildFileName = it.name + '.gradle'}更多的Gradle技巧記住 DRY
  • Gradle 創建java項目詳細步驟
    輕鬆遷移：gradle適用於任何結構的工程，你可以在同一個開發平臺平行構建原工程和gradle工程。通常要求寫相關測試，以保證開發的插件的相似性，這種遷移可以減少破壞性，儘可能的可靠。這也是重構的最佳實踐。gradle的整體設計是以作為一種語言為導向的，而非成為一個嚴格死板的框架。免費開源安裝之前需要什麼?
  • Gradle 實現 Android 多渠道定製化打包
    而現在你通過 Gradle，你可以輕鬆構建多個不同版本的應用，並且在同一設備上安裝使用。這裡要用到 productFlavors ，productFlavors 可以用來自定義應用構建版本，我們可以用其 applicationId 屬性來實現多個 Apk 安裝在同一設備上。
  • 9種實用的辦事技巧你應該知道
    9種實用的版式技巧你應該知道如何讓版面更有特色?如果想要讓版面富有特色，最常使用的基本手法之—就是採用倒三角形或倒金字塔的構圖方式，在版面上半部分放置表現力較強的圖片圖形，下半部分逐漸減少信息重要度，這樣做的好處可以使讀者的閱讀順序從上而下，有效的區分層級。
  • 技巧:華為手機隱藏的7大實用技巧 不知道你就吃大虧了
    點評：快來瞧瞧，這些年你用的是不是假華為手機！現在買華為手機的人越來越多，可你真的懂華為手機嗎？之所以這麼問，是因為它的很多功能都是隱藏起來的，別說新手了，就是用了幾年的人都可能不知道。今天，小編就跟大家分享一下華為手機的超實用小技巧，絕對是你之前沒有注意到的。
  • Flutter Running Gradle task 'assembleDebug'解決方法
    前言最近用flutter做個app,當運行flutter run的時候，一直卡在這個地方動不了，如下圖：運行時會卡在Running 'gradle assembleDebug, 因為Gradle的Maven倉庫在國外， 可以使用阿里雲的鏡像地址。
  • 架構設計-從零開始搭建gradle多模塊項目
    開頭說兩句小小刀博客: https://www.lixiang.red小小刀公眾號: 程式設計師心情站原創不易,轉載請註明出處#項目背景讀過小刀以前文章的小夥伴應該還記得gradle 簡介為什麼選gradle沒有用maven呢 ,gradle做為新一代的構建工具,說實話,構建速度,我還真沒對比過,但就方便省事而言,gradle還是挺省事的,寫的代碼變少了,也清晰了不少,而且迭代升級超快,去年第一次接觸gradle的時候還是4.x的版本,現在都5.x了gradle 配置多模塊項目想要學習gradle多模塊最好的方式,就是看看spring源碼
  • Android Gradle 使用大全
    項目結構中的每個build.gradle文件代表一個project，在這編譯腳本文件中可以定義一系列的task；task 本質上又是由一組被順序執行的Action`對象構成，Action其實是一段代碼塊，類似於Java中的方法Android Gradle 構建生命周期每次構建的執行本質上執行一系列的Task。