Gradle本身定義插件

Gradle本身定義插件

在Gradle中建立本身定義插件，Gradle提供了三種方式：

• 在build.gradle腳本中直接使用
• 在buildSrc中使用
• 在獨立Module中使用

開發Gradle插件可以在IDEA中進行開發。也可以在Android Studio中進行開發，它們惟一的不一樣，就是IDEA提供了Gradle開發的插件，比較方便建立文件和文件夾，而Android Studio中，開發人員需要手動建立（但實際上。這些文件夾並很少，也不復雜，全然可以手動建立）。

在項目中使用

在Android Studio中建立一個標準的Android項目，整個文件夾結構例如如下所看到的：

├── app
│   ├── build.gradle
│   ├── libs
│   └── src
│       ├── androidTest
│       │   └── java
│       ├── main
│       │   ├── AndroidManifest.xml
│       │   ├── java
│       │   └── res
│       └── test
├── build.gradle
├── buildSrc
│   ├── build.gradle            ---1
│   └── src
│       └── main
│           ├── groovy          ---2
│           └── resources       ---3
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties
└── settings.gradle

當中。除了buildSrc文件夾之外，都是標準的Android文件夾，而buildSrc就是Gradle提供的在項目中配置本身定義插件的默認文件夾。開發Gradle要建立的文件夾，也就是RootProject/src/main/groovy和RootProject/src/main/resources兩個文件夾。

在配置完畢後，假設配置正確，相應的文件夾將被IDE所識別，成爲相應類別的文件夾。

建立buildSrc/build.gradle—1

首先，先來配置buildSrc文件夾下的build.gradle文件。這個配置比較固定。腳本例如如下所看到的：

apply plugin: 'groovy'

dependencies { compile gradleApi() compile localGroovy() }

建立Groovy腳本—2

接下來，在groovy文件夾下，建立一個Groovy類（與Java類似，可以帶包名，但Groovy類以.grovvy結尾）。如圖所看到的：

在腳本中經過實現gradle的Plugin接口，實現apply方法就能夠，腳本例如如下所看到的：

package com.xys

import org.gradle.api.Plugin
import org.gradle.api.Project

public class MainPluginForBuildSrc implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.task('testPlugin') << {
            println "Hello gradle plugin in src"
        }
    }
}

在如上所看到的的腳本的apply方法中。筆者簡單的實現了一個task，命名爲testPlugin。運行該Task。會輸出一行日誌。

建立Groovy腳本的Extension

所謂Groovy腳本的Extension。實際上就是類似於Gradle的配置信息，在主項目使用本身定義的Gradle插件時。可以在主項目的build.gradle腳本中經過Extension來傳遞一些配置、參數。

建立一個Extension，僅僅需要建立一個Groovy類就能夠。如圖所看到的：

如上所看到的。筆者命名了一個叫MyExtension的groovy類，其腳本例如如下所看到的：

package com.xys;

class MyExtension {
    String message
}

MyExtension代碼很easy，就是定義了要配置的參數變量。後面筆者將詳細演示怎樣使用。

在Groovy腳本中使用Extension

在建立了Extension以後，需要改動下以前建立的Groovy類來載入Extension。改動後的腳本例如如下所看到的：

package com.xys

import org.gradle.api.Plugin
import org.gradle.api.Project

public class MainPluginForBuildSrc implements Plugin<Project> {

    @Override
    void apply(Project project) {

        project.extensions.create('pluginsrc', MyExtension)

        project.task('testPlugin') << {
            println project.pluginsrc.message
        }
    }
}

經過project.extensions.create方法，來將一個Extension配置給Gradle就能夠。

建立resources—3

resources文件夾是標識整個插件的文件夾。其文件夾下的結構例如如下所看到的：

└── resources
└── META-INF
└── gradle-plugins

該文件夾結構與buildSrc同樣，是Gradle插件的默認文件夾，不能有不論什麼改動。建立好這些文件夾後，在gradle-plugins文件夾下建立——插件名.properties文件，如圖所看到的：

如上所看到的。這裏筆者命名爲pluginsrc.properties。在該文件裏。代碼例如如下所看到的：

implementation-class=com.xys.MainPluginForBuildSrc

經過上面的代碼指定最開始建立的Groovy類就能夠。

在主項目中使用插件

在主項目的build.gradle文件裏，經過apply指令來載入本身定義的插件。腳本例如如下所看到的：

apply plugin: 'pluginsrc'

當中plugin的名字。就是前面建立pluginsrc.properties中的名字——pluginsrc，經過這樣的方式。就載入了本身定義的插件。

配置Extension

在主項目的build.gradle文件裏，經過例如如下所看到的的代碼來載入Extension：

pluginsrc{ message = 'hello gradle plugin' }

相同，領域名爲插件名，配置的參數就是在Extension中定義的參數名。

配置完畢後，就可以在主項目中使用本身定義的插件了，在終端運行gradle testPlugin指令，結果例如如下所看到的：

:app:testPlugin
hello gradle plugin

在本地Repo中使用

在buildSrc中建立本身定義Gradle插件僅僅能在當前項目中使用，所以，對於具備廣泛性的插件來講。通常是創建一個獨立的Module來建立本身定義Gradle插件。

建立Android Library Module

首先。在主項目的工程中，建立一個普通的Android Library Module，並刪除其默認建立的文件夾。改動爲Gradle插件所需要的文件夾，即在buildSrc文件夾中的所有文件夾，如圖所看到的：

如上圖所看到的。建立的文件與在buildSrc文件夾中建立的文件都是如出一轍的，僅僅是這裏在一個本身定義的Module中建立插件而不是在默認的buildSrc文件夾中建立。

部署到本地Repo

因爲是經過本身定義Module來建立插件的。所以。不能讓Gradle來本身主動完畢插件的載入。需要手動進行部署，因此，需要在插件的build.gradle腳本中添加Maven的配置，腳本例如如下所看到的：

apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

repositories {
    mavenCentral()
}

group='com.xys.plugin'
version='2.0.0'
uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: uri('../repo'))
        }
    }
}

相比buildSrc中的build.gradle腳本，這裏添加了Maven的支持和uploadArchives這樣一個Task，這個Task的做用就是將該Module部署到本地的repo文件夾下。

在終端中運行gradle uploadArchives指令，將插件部署到repo文件夾下，如圖所看到的：

當插件部署到本地後，就可以在主項目中引用插件了。

當插件正式公佈後，可以把插件像其餘module同樣公佈到中央庫，這樣就可以像使用中央庫的庫項目同樣來使用插件了。

引用插件

在buildSrc中。系統本身主動幫開發人員本身定義的插件提供了引用支持。但本身定義Module的插件中。開發人員就需要本身來加入本身定義插件的引用支持。

在主項目的build.gradle文件裏。加入例如如下所看到的的腳本：

apply plugin: 'com.xys.plugin'

buildscript { repositories { maven { url uri('../repo') }
    }
    dependencies { classpath 'com.xys.plugin:plugin:2.0.0' }
}

當中。classpath指定的路徑，就是類似compile引用的方式。即——插件名:group:version
配置完畢後，就可以在主項目中使用本身定義的插件了，在終端運行gradle testPlugin指令，結果例如如下所看到的：

:app:testPlugin
Hello gradle plugin

假設不使用本地Maven Repo來部署，也可以拿到生成的插件jar文件。拷貝到libs文件夾下，經過例如如下所看到的的代碼來引用：

classpath fileTree(dir: 'libs', include: '\*.jar') // 使用jar

參考：https://docs.gradle.org/current/userguide/custom_plugins.html