Gradle自定義插件介紹1

前言

前面幾篇文章筆者對Gradle的一些基礎(chǔ)認(rèn)知，groovy基礎(chǔ)語法，以及Gradle 項目中常用的一些api進(jìn)行了講解。

今天筆者再來講解一些關(guān)于复制Gradle插件的使用

1.定義

首先來講下复制Gradle和复制Gradle插件有啥區(qū)別？

复制Gradle是一套構(gòu)建工具，其內(nèi)部構(gòu)建過程主要是以复制Project組成一個樹形的生態(tài)系統(tǒng)，整個構(gòu)建流程有自己的生命周期。每個Project又是由若干個Task組成。

复制Gradle插件你可以理解為是運行在复制Gradle這套構(gòu)建系統(tǒng)上的單個复制task,

如 執(zhí)行腳本的編寫 ，字節(jié)碼插莊等，都可以依靠复制Gradle插件實現(xiàn)。

我們常用的复制Android Gradle Plugin也是一個Gradle插件模塊：

复制應(yīng)用插件的ID：‘com.android.application’
或者lib庫：‘com.android.library’

2.有哪些優(yōu)勢

• 1.邏輯復(fù)用 :Gradle插件將一個公共模塊單獨的抽離出來，然后上傳到共享平臺，供其他項目使用
• 2.插件配置擴展 ：Gradle插件聲明插件擴展，將插件內(nèi)部參數(shù)暴露給對應(yīng)的Project進(jìn)行配置，大大提高了插件的可擴展性。

3.插件的形式

• 1. build script ：直接在build.gradle構(gòu)建腳本中創(chuàng)建對應(yīng)的插件，這種方式只對當(dāng)前Project有效，不支持對外提供調(diào)用，無復(fù)用性，一般不推薦使用
• 2. buildSrc模塊 ：這種方式是編譯器提供的特殊模塊，編譯器可以自動識別該模塊的，對所有的Project可見。但是在項目外不可見，無法給其他工程使用，復(fù)用性差。
• 3. 獨立插件項目 ：替插件創(chuàng)建一個單獨的項目，這個項目可以單獨的打包成一個jar包，然后發(fā)布到企業(yè)服務(wù)器上供其他項目使用，通常這個插件中包含了一個或多個任務(wù)的組合，實現(xiàn)具體的插件功能

4.自定義插件复制實戰(zhàn)

下面我會以第三種形式來大家實現(xiàn)一個簡單的Gradle插件功能：

需求如下：

在編譯過程中實現(xiàn)：將當(dāng)前編譯的版本信息發(fā)布到公司服務(wù)器上，可以在本地服務(wù)器上實時查看編譯的版本日志,通過日志的分析可以對當(dāng)前編譯版本進(jìn)行優(yōu)化。

步驟如下 ：

• 1.初始化插件模塊目錄結(jié)構(gòu)
• 2.創(chuàng)建插件實現(xiàn)類
• 3.創(chuàng)建插件擴展Bean
• 4.創(chuàng)建插件實現(xiàn)的任務(wù):上傳版本信息
• 5.將插件擴展和插件任務(wù)集成到Project生命周期中
• 6.插件發(fā)布
• 7.插件引入

步驟1.初始化插件模塊目錄結(jié)構(gòu)

首先創(chuàng)建一個复制Java or Kotlin Library的模塊，

步驟1創(chuàng)建.png

在創(chuàng)建的模塊复制build.gradle中引入:

复制plugins {
    id 'groovy' // Groovy Language
    //id 'org.jetbrains.kotlin.jvm' // Kotlin 
    id 'java-gradle-plugin' // Java Gradle Plugin
}

• groovy :使用groovy語言開發(fā)
• org.jetbrains.kotlin.jvm ：使用kotlin開發(fā)引入kotlin核心插件庫
• java-gradle-plugin ：Gradle插件的一個輔助插件，可以在我們build目錄下自動生成資源屬性

設(shè)置复制sourceSets：

复制sourceSets {
    main {
        groovy {
            srcDir 'src/main/groovy'
        }
        resources {
            srcDir 'src/main/resources'
        }
    }
}

工程目錄結(jié)構(gòu)如下：

插件目錄結(jié)構(gòu).png

步驟2.創(chuàng)建插件實現(xiàn)類

复制class UploadVersionPlugin implements Plugin<Project>{
    @Override
    void apply(Project project) {
            println "begin:now this is a ${project.name} 's upload plugin"
    }
}

步驟3.創(chuàng)建插件擴展Bean

复制class VersionInfo {
    //版本名稱
    String versionName
    //版本代碼
    int versionCode
    //版本更新信息
    String versionUpdateInfo
}