Gradle 本身只提供基本框架和核心概念，幾乎所有的功能都是以插件的方式提供的。

例如構(gòu)建 Java 應(yīng)用的功能就是通過 Java 插件實(shí)現(xiàn)的。

Gradle 內(nèi)置了很多核心語言插件，基本上能滿足大部分的構(gòu)建工作，但有些插件沒有內(nèi)置或者有些功能沒有提供，我們也可以自定義插件來使用，例如 Android Gradle 插件就是基于 Java 插件擴(kuò)展的。

插件的作用

插件可以封裝一系列任務(wù)，例如 編譯，測(cè)試，打包等。

插進(jìn)可以定義約定，例如 應(yīng)用Java 插件后，約定的源代碼位置就在 src/main/java 目錄下。

插件可以封裝配置，當(dāng)項(xiàng)目應(yīng)用插件時(shí)自動(dòng)應(yīng)用插進(jìn)的配置。

插件可以擴(kuò)展 Gradle 模型，添加可配置的 DSL 元素，例如 Android Gradle 的 android{}

這就是插件，我們只需要按照它的約定的方式，使用它提供的任務(wù)、方法或擴(kuò)展就可以對(duì)我們的項(xiàng)目進(jìn)行構(gòu)建。

使用插件可以將相似的代碼進(jìn)行封裝以提高重用性，使構(gòu)建腳本高度模塊化，增強(qiáng)組織性和可讀性。

插件類型

Gradle 有兩種插件

• 腳本插件
• 二進(jìn)制插件

腳本插件

腳本插件通常是一個(gè)腳本。

腳本插件其實(shí)并不能算是一個(gè)真正的插件，但我們不能忽視它的作用，它是腳本模塊化的基礎(chǔ)。

我們可以把復(fù)雜的腳本文件，進(jìn)行分塊，分段整理，拆分成一個(gè)個(gè)職責(zé)分明的腳本插件。

就像我們平常封裝的 Utils 工具類一樣，封裝一個(gè) utils.gradle 工具腳本

二進(jìn)制插件

二進(jìn)制插件是實(shí)現(xiàn)了Plugin 接口的插件，以編程的方式操縱構(gòu)建。

二進(jìn)制插件一般是打包在一個(gè) jar 里獨(dú)立發(fā)布的。

發(fā)現(xiàn)插件

Gradle 專門有一個(gè)網(wǎng)站可以發(fā)布和尋找插件 https://plugins.gradle.org

當(dāng)然也可以在 Github 上搜索，開源的力量是強(qiáng)大的。

使用插件

要使用一個(gè)插件必選先找到它，然后把它應(yīng)用到我們的項(xiàng)目。

將插件應(yīng)用到我們的項(xiàng)目就可以使用它了。

所以使用一個(gè)插件需要兩步：

1. 找到插件并添加到類路徑
2. 應(yīng)用插件到項(xiàng)目

一旦插件被應(yīng)用就可以使用它的 API 了。

應(yīng)用插件就是在目標(biāo)項(xiàng)目執(zhí)行插件的 Plugin.apply(T) 方法。

插件的應(yīng)用是冪等的，應(yīng)用多次和一次的效果是一樣的。

應(yīng)用腳本插件

前面說過腳本插件其實(shí)就是一個(gè)腳本，應(yīng)用腳本插件其實(shí)就是將這個(gè)腳本加載進(jìn)來。

使用 apply from 將腳本加載進(jìn)來

apply from: 'other.gradle'

腳本可以存在本地，也可以存在網(wǎng)絡(luò)上。

存在本地就使用本項(xiàng)目的相對(duì)路徑。

存在網(wǎng)絡(luò)上就要使用 HTTP URL 。

應(yīng)用二進(jìn)制插件

二進(jìn)制插件應(yīng)用是通過他們的 ID 應(yīng)用的。

插件 ID 是插件的全局唯一標(biāo)識(shí)符或者名字

Gradle 核心插件的特殊之處就在于他們都有一個(gè)簡(jiǎn)短的 ID，例如 Java 插件的是 "java" 。

其他所有的二進(jìn)制插件都必須使用完全限定形式的插件 ID (com.github.foo.bar) 。

插件 ID 在哪用就取決于你是使用 plugins{} 還是 buildscript{} 了。

核心插件是作為 Gardle 的一部分在應(yīng)用時(shí)是由 Gradle 分發(fā)并自動(dòng)解析的。

而其他的二進(jìn)制插件則必須在應(yīng)用前被找到并解析。

Gradle 通常是在下面這個(gè)幾個(gè)地方去尋找

• 在上述提到的 Plugins 網(wǎng)站上或者自定義的倉(cāng)庫里
• 在指定的外部依賴 jar
• 在項(xiàng)目的 buildSrc 目錄下尋找源文件
• 聲明在腳本里的插件

目前有兩種方式使用插件，一種是使用新推出的 plugins{} 應(yīng)用插件，另一種是使用 buildscript{} 應(yīng)用插件。

目前 Gradle 推薦使用 plugins{} 。

下面是兩個(gè)方式的使用方法。

使用 buildscript{} 應(yīng)用二進(jìn)制插件

使用 buildscript{} 塊應(yīng)用的二進(jìn)制插件都是通過 Project.apply() 方法完成的。

應(yīng)用 Java 插件: build.gradle

apply plugin: 'java'

這里的 "java" 就是 Java 插件的 ID，它對(duì)應(yīng)的類型是 org.gradle.api.plugins.JavaPlugin

也可以通過類型應(yīng)用插件：build.gradle

apply org.gradle.api.plugins.JavaPlugin

因?yàn)?org.gradle.api.plugins 是默認(rèn)導(dǎo)入的，所以也可以直接去掉包名稱直接寫為

apply plugin:JavaPlugin

要使用第三方的插件就必須先在 buildscript{} 配置 類路徑才可以使用。

這個(gè)不像 Gradle 的內(nèi)置插件，是由 Gradle 負(fù)責(zé)分發(fā)的。

例如我們的 Android Gradle 插進(jìn)，就屬于 Android 發(fā)布的第三方插件，如果要使用就先要進(jìn)行配置

buildscript {
    repositories {
        mavenCentral()
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.2.0'
    }
}

因?yàn)?Android Gradle 插進(jìn)是托管在 jcenter 倉(cāng)庫上，所以必須在 repositories{} 添加 jcenter 倉(cāng)庫。

buildscript{} 塊是一個(gè)在構(gòu)建項(xiàng)目之前，為項(xiàng)目進(jìn)行前期準(zhǔn)備和初始化相關(guān)配置依賴的地方，配置好所需的依賴，就可以應(yīng)用插件了：

apply plugin: 'com.android.application'

如果沒有提前在 buildscript{} 里配置依賴的類路徑，會(huì)提示找不到這個(gè)插件。

使用 plugins DSL 應(yīng)用二進(jìn)制插件

plugins DSL 配置可以很方便的訪問 Gradle 插件網(wǎng)站上的插件。

這個(gè)配置塊配置的是一個(gè)PluginDependenciesSpec 實(shí)例

應(yīng)用核心插件

plugins {
    id 'java'
}

使用插件 ID （必須是完全限定形式）應(yīng)用第三方插件

plugins {
    id 'com.jfrog.bintray' version '0.4.1'
}

使用 plugins{} 應(yīng)用插件就不用先配置依賴然后再使用 apply 方法了，只需要在 plugins{} 里配置就可以了。

plugins DSL 的限制

雖然 plugins DSL 將使用插件的步驟精簡(jiǎn)了，但還是有一些限制的，它的語法被固定了，不能改變

plugins {
    id ?plugin id?                                            // (1)
    id ?plugin id? version ?plugin version? [apply ?false?]   // (2)
}

1. 適用于有簡(jiǎn)寫名字的核心插件或者已經(jīng)加載過的第三方插件
2. 適用于需要被解析的第三方插件

plugin id 和 plugin version 是必需的 且必須是常量,字面量,字符串.其他語句都是不允許的

apply 是可選的，默認(rèn)是 true；它是控制在應(yīng)用插件的時(shí)候是否立刻使用插件的默認(rèn)行為。

這個(gè) plugins{} 塊 是不能嵌套在別的配置塊里的，必須是腳本的頂級(jí)模塊。

在目前的 5.6.2 版本里 plugins{} 只能在項(xiàng)目的構(gòu)建腳本里使用，不能在腳本插件里，settings.gradle 以及 init.gradle 腳本里。

應(yīng)用插件到子項(xiàng)目

可以利用 plugins {} 的 apply 選項(xiàng)將插件應(yīng)用到某些項(xiàng)目而不是所有項(xiàng)目里。

默認(rèn) plugins {} 的插件是立即被解析并應(yīng)用的。

可以使用 apply false 告訴 Gradle 不應(yīng)用到當(dāng)前項(xiàng)目,
然后在子項(xiàng)目的腳本中使用 apply plugin <<plugin id>> 或者 plugins{} 應(yīng)用插件

settings.gradle

include 'helloA'
include 'helloB'
include 'goodbyeC'

build.gradle

plugins {
    id 'org.gradle.sample.hello' version '1.0.0' apply false
    id 'org.gradle.sample.goodbye' version '1.0.0' apply false
}



subprojects {
    if (name.startsWith('hello')) {
        apply plugin: 'org.gradle.sample.hello'
    }
}

goodbyeC/build.gradle

plugins {
    id 'org.gradle.sample.goodbye'
}

上面的示例演示了如何給多個(gè)子項(xiàng)目分別應(yīng)用不同的插件。

使用 buildSrc 目錄下的插件

項(xiàng)目的 buildSrc 目錄下的插件也是可以使用的，但必須定義插件 ID 。

下面是一個(gè)使用 buildSrc 目錄下的插件的示例

這個(gè)插件 ID 是 my-plugin 實(shí)現(xiàn)的插件類是 my.MyPlugin
buildSrc/build.gradle

plugins {
    id 'java'
    id 'java-gradle-plugin'
}

gradlePlugin {
    plugins {
        myPlugins {
            id = 'my-plugin'
            implementationClass = 'my.MyPlugin'
        }
    }
}

dependencies {
    compileOnly gradleApi()
}

使用插件

plugins {
    id 'my-plugin'
}

Plugin Management

這個(gè) pluginManagement DSL 是用來管理插件的，它可以配置插件，自定義倉(cāng)庫，自定義解析規(guī)則等。

pluginManagement{} 只能定義在兩個(gè)地方：

• settings.gradle 里，并且必須是第一個(gè)模塊
• init.gradle 里

settings.gradle

pluginManagement {
    plugins {
    }
    resolutionStrategy {
    }
    repositories {
    }
}

init.gradle

settingsEvaluated { settings ->
    settings.pluginManagement {
        plugins {
        }
        resolutionStrategy {
        }
        repositories {
        }
    }
}

自定義倉(cāng)庫

plugins 默認(rèn)是在 Gradle 的插件網(wǎng)站尋找插件的

我們可以在 pluginManagement{} 里的 repositories{} 里配置自己的倉(cāng)庫

Gradle 會(huì)按照配置的倉(cāng)庫順序依次尋找插件

settings.gradle

pluginManagement {
    repositories {
        maven {
            url '../maven-repo'
        }
        gradlePluginPortal()
        ivy {
            url '../ivy-repo'
        }
    }
}

首先在位于 ../maven-repo 的Maven 倉(cāng)庫找，找不到再去 Gradle 的插件網(wǎng)站 ，最后是位于 ../ivy-repo 的 ivy 倉(cāng)庫。

插件版本管理

在 pluginManagement{} 里的 plugins{} 里配置插件是沒有固定語法限制的。

可以把所有的版本都放在一個(gè)單獨(dú)的腳本里，或者是使用 gradle.properties 文件配置屬性

settings.gradle

pluginManagement {
  plugins {
        id 'org.gradle.sample.hello' version "${helloPluginVersion}"
    }
}

build.gradle

plugins {
    id 'org.gradle.sample.hello'
}

gradle.properties

helloPluginVersion=1.0.0

解析規(guī)則

解析規(guī)則就是解析插件的規(guī)則，通過自定義插件規(guī)則可以更改 plugins{} 塊中的插件請(qǐng)求，例如更改請(qǐng)求的版本或顯式指定實(shí)現(xiàn)工件坐標(biāo)。

解析規(guī)則是在 pluginManagement{} 里的 resolutionStrategy{} 里配置的。

插件解析策略：

pluginManagement {
    resolutionStrategy {
        eachPlugin {
            if (requested.id.namespace == 'org.gradle.sample') {
                useModule('org.gradle.sample:sample-plugins:1.0.0')
            }
        }
    }
    repositories {
        maven {
            url '../maven-repo'
        }
        gradlePluginPortal()
        ivy {
            url '../ivy-repo'
        }
    }
}

這告訴 Gradle 使用指定的插件實(shí)現(xiàn)工件，而不是使用從插件 ID 到 Maven / lvy 坐標(biāo)的內(nèi)置默認(rèn)映射。

除了實(shí)際實(shí)現(xiàn)插件的工件之外，自定義 Maven 和 lvy 插件倉(cāng)庫必需包含 插件標(biāo)記工件。

關(guān)于將插件發(fā)布到自定義的倉(cāng)庫的可以查看 Gradle 插件開發(fā)：
傳送門

Plugin Marker Artifacts (插件標(biāo)記工件)

這里插入一個(gè) Maven 中的概念：Artifact (工件)

Artifact 的概念比較抽象，它是 Maven 項(xiàng)目將要產(chǎn)生的文件。
一個(gè)Maven 項(xiàng)目可能會(huì)產(chǎn)生多個(gè) Artifact ，可能是 jar 文件，源文件，二進(jìn)制文件，war 文件，甚至是 pom 文件。
每一個(gè) artifact 都有一個(gè) group ID (通常是反轉(zhuǎn)的域名，就像包名)，一個(gè) artifact ID （一個(gè)名字）以及一個(gè)版本號(hào)，
這三個(gè)組合在一個(gè)表示一個(gè) artifact 的坐標(biāo)：groupId:artifiactId:version

由于 plugins DSL 塊只允許通過全局唯一的插件 id 和 version 屬性聲明插件，因此 Gradle 需要一種方法來查找 插件實(shí)現(xiàn)工件 的坐標(biāo)。
為此，Gradle 將使用坐標(biāo)查找 插件標(biāo)記工件 plugin.id:plugin.id.gradle.plugin:plugin.version 。
此標(biāo)記需要依賴于實(shí)際的插件實(shí)現(xiàn)。java-gradle-plugin 會(huì)自動(dòng)發(fā)布這些標(biāo)記。

例如，下面的完整示例 sample-plugins 演示了如何使用 java-gradle-plugin，maven-publish 插件和 ivy-publish 插件的組合將 org.gradle.sample.hello 插件和 org.gradle.sample.goodbye 插件發(fā)布到 Ivy 和 Maven 倉(cāng)庫。

完整插件發(fā)布示例

plugins {
    id 'java-gradle-plugin'
    id 'maven-publish'
    id 'ivy-publish'
}

group 'org.gradle.sample'
version '1.0.0'

gradlePlugin {
    plugins {
        hello {
            id = 'org.gradle.sample.hello'
            implementationClass = 'org.gradle.sample.hello.HelloPlugin'
        }
        goodbye {
            id = 'org.gradle.sample.goodbye'
            implementationClass = 'org.gradle.sample.goodbye.GoodbyePlugin'
        }
    }
}

publishing {
    repositories {
        maven {
            url '../../consuming/maven-repo'
        }
        ivy {
            url '../../consuming/ivy-repo'
        }
    }
}

運(yùn)行 gradle publish 將會(huì)產(chǎn)生如下結(jié)構(gòu)

pluginMarker.png

就像前面提到的 插件標(biāo)記工件 的坐標(biāo)和插件 id 的映射關(guān)系。

下面以 hello 插件舉例

• id 是 org.gradle.sample.hello
• 版本是 1.0.0

位于 Maven 倉(cāng)庫的 artifact 坐標(biāo)就是 org.gradle.sample.hello:org.gradle.sample.gradle.plugin:1.0.0

• groupId: org.gradle.sample
• artifactId: org.gradle.sample.gradle.plugin
• version: 1.0.0

對(duì)應(yīng)的就是上面說到的 plugin.id: plugin.id.gradle.plugin:plugin.version

如果我描述的不好或者不太詳細(xì)，可以查看 《Android Gradle 權(quán)威指南》 和 Gradle 用戶手冊(cè)。

微信掃一掃，關(guān)注我的公眾號(hào)