Gradle 本身只提供基本框架和核心概念，幾乎所有的功能都是以插件的方式提供的。例如構建 Java 應用的功能就是通過 Java 插件實現的。 ...

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

例如構建 Java 應用的功能就是通過 Java 插件實現的。

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

插件的作用

插件可以封裝一系列任務，例如編譯，測試，打包等。

插進可以定義約定，例如應用Java 插件後，約定的源代碼位置就在 src/main/java 目錄下。

插件可以封裝配置，當項目應用插件時自動應用插進的配置。

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

這就是插件，我們只需要按照它的約定的方式，使用它提供的任務、方法或擴展就可以對我們的項目進行構建。

使用插件可以將相似的代碼進行封裝以提高重用性，使構建腳本高度模塊化，增強組織性和可讀性。

插件類型

Gradle 有兩種插件

腳本插件
二進位插件

腳本插件

腳本插件通常是一個腳本。

腳本插件其實並不能算是一個真正的插件，但我們不能忽視它的作用，它是腳本模塊化的基礎。

我們可以把複雜的腳本文件，進行分塊，分段整理，拆分成一個個職責分明的腳本插件。

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

二進位插件

二進位插件是實現了Plugin 介面的插件，以編程的方式操縱構建。

二進位插件一般是打包在一個 jar 里獨立發佈的。

發現插件

Gradle 專門有一個網站可以發佈和尋找插件 https://plugins.gradle.org

當然也可以在 Github 上搜索，開源的力量是強大的。

使用插件

要使用一個插件必選先找到它，然後把它應用到我們的項目。

將插件應用到我們的項目就可以使用它了。

所以使用一個插件需要兩步：

找到插件並添加到類路徑
應用插件到項目

一旦插件被應用就可以使用它的 API 了。

應用插件就是在目標項目執行插件的 Plugin.apply(T) 方法。

插件的應用是冪等的，應用多次和一次的效果是一樣的。

應用腳本插件

前面說過腳本插件其實就是一個腳本，應用腳本插件其實就是將這個腳本載入進來。

使用 apply from 將腳本載入進來

apply from: 'other.gradle'

腳本可以存在本地，也可以存在網路上。

存在本地就使用本項目的相對路徑。

存在網路上就要使用 HTTP URL 。

應用二進位插件

二進位插件應用是通過他們的 ID 應用的。

插件 ID 是插件的全局唯一標識符或者名字

Gradle 核心插件的特殊之處就在於他們都有一個簡短的 ID，例如 Java 插件的是 "java" 。

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

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

核心插件是作為 Gardle 的一部分在應用時是由 Gradle 分發並自動解析的。

而其他的二進位插件則必須在應用前被找到並解析。

Gradle 通常是在下麵這個幾個地方去尋找

在上述提到的 Plugins 網站上或者自定義的倉庫里
在指定的外部依賴 jar
在項目的 buildSrc 目錄下尋找源文件
聲明在腳本里的插件

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

目前 Gradle 推薦使用 plugins{} 。

下麵是兩個方式的使用方法。

使用 buildscript{} 應用二進位插件

使用 buildscript{} 塊應用的二進位插件都是通過 Project.apply() 方法完成的。

應用 Java 插件: build.gradle

apply plugin: 'java'

這裡的 "java" 就是 Java 插件的 ID，它對應的類型是 org.gradle.api.plugins.JavaPlugin

也可以通過類型應用插件：build.gradle

apply org.gradle.api.plugins.JavaPlugin

因為 org.gradle.api.plugins 是預設導入的，所以也可以直接去掉包名稱直接寫為

apply plugin:JavaPlugin

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

這個不像 Gradle 的內置插件，是由 Gradle 負責分發的。

例如我們的 Android Gradle 插進，就屬於 Android 發佈的第三方插件，如果要使用就先要進行配置

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

因為 Android Gradle 插進是托管在 jcenter 倉庫上，所以必須在 repositories{} 添加 jcenter 倉庫。

buildscript{} 塊是一個在構建項目之前，為項目進行前期準備和初始化相關配置依賴的地方，配置好所需的依賴，就可以應用插件了：

apply plugin: 'com.android.application'

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

使用 plugins DSL 應用二進位插件

plugins DSL 配置可以很方便的訪問 Gradle 插件網站上的插件。

這個配置塊配置的是一個PluginDependenciesSpec 實例

應用核心插件

plugins {
    id 'java'
}

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

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

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

plugins DSL 的限制

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

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

適用於有簡寫名字的核心插件或者已經載入過的第三方插件
適用於需要被解析的第三方插件

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

apply 是可選的，預設是 true；它是控制在應用插件的時候是否立刻使用插件的預設行為。

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

在目前的 5.6.2 版本里 plugins{} 只能在項目的構建腳本里使用，不能在腳本插件里，settings.gradle 以及 init.gradle 腳本里。

應用插件到子項目

可以利用 plugins {} 的 apply 選項將插件應用到某些項目而不是所有項目里。

預設 plugins {} 的插件是立即被解析並應用的。

可以使用 apply false 告訴 Gradle 不應用到當前項目,
然後在子項目的腳本中使用 apply plugin <> 或者 plugins{} 應用插件

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'
}

上面的示例演示瞭如何給多個子項目分別應用不同的插件。

使用 buildSrc 目錄下的插件

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

下麵是一個使用 buildSrc 目錄下的插件的示例

這個插件 ID 是 my-plugin 實現的插件類是 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

這個 pluginManagement DSL 是用來管理插件的，它可以配置插件，自定義倉庫，自定義解析規則等。

pluginManagement{} 只能定義在兩個地方：

settings.gradle 里，並且必須是第一個模塊
init.gradle 里

settings.gradle

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

init.gradle

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

自定義倉庫

plugins 預設是在 Gradle 的插件網站尋找插件的

我們可以在 pluginManagement{} 里的 repositories{} 里配置自己的倉庫

Gradle 會按照配置的倉庫順序依次尋找插件

settings.gradle

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

首先在位於 ../maven-repo 的Maven 倉庫找，找不到再去 Gradle 的插件網站，最後是位於 ../ivy-repo 的 ivy 倉庫。

插件版本管理

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

可以把所有的版本都放在一個單獨的腳本里，或者是使用 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

解析規則

解析規則就是解析插件的規則，通過自定義插件規則可以更改 plugins{} 塊中的插件請求，例如更改請求的版本或顯式指定實現工件坐標。

解析規則是在 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 使用指定的插件實現工件，而不是使用從插件 ID 到 Maven / lvy 坐標的內置預設映射。

除了實際實現插件的工件之外，自定義 Maven 和 lvy 插件倉庫必需包含插件標記工件。

關於將插件發佈到自定義的倉庫的可以查看 Gradle 插件開發：
傳送門

Plugin Marker Artifacts (插件標記工件)

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

Artifact 的概念比較抽象，它是 Maven 項目將要產生的文件。
一個Maven 項目可能會產生多個 Artifact ，可能是 jar 文件，源文件，二進位文件，war 文件，甚至是 pom 文件。
每一個 artifact 都有一個 group ID (通常是反轉的功能變數名稱，就像包名)，一個 artifact ID （一個名字）以及一個版本號，
這三個組合在一個表示一個 artifact 的坐標：groupId:artifiactId:version

由於 plugins DSL 塊只允許通過全局唯一的插件 id 和 version 屬性聲明插件，因此 Gradle 需要一種方法來查找插件實現工件的坐標。
為此，Gradle 將使用坐標查找插件標記工件 plugin.id:plugin.id.gradle.plugin:plugin.version 。
此標記需要依賴於實際的插件實現。java-gradle-plugin 會自動發佈這些標記。

例如，下麵的完整示例 sample-plugins 演示瞭如何使用 java-gradle-plugin，maven-publish 插件和 ivy-publish 插件的組合將 org.gradle.sample.hello 插件和 org.gradle.sample.goodbye 插件發佈到 Ivy 和 Maven 倉庫。

完整插件發佈示例

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'
        }
    }
}

運行 gradle publish 將會產生如下結構
publish 結果

就像前面提到的插件標記工件的坐標和插件 id 的映射關係。

下麵以 hello 插件舉例

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

位於 Maven 倉庫的 artifact 坐標就是 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

對應的就是上面說到的 plugin.id: plugin.id.gradle.plugin:plugin.version

如果我描述的不好或者不太詳細，可以查看《Android Gradle 權威指南》和 Gradle 用戶手冊。