概述

android項(xiàng)目構(gòu)建主要由com.android.application及com.android.library兩個(gè)插件完成，要了解android構(gòu)建及插

件化，gradle插件學(xué)習(xí)是必由之路。

Gradle相關(guān)語(yǔ)法

在這里不再重復(fù)Gradle相關(guān)的語(yǔ)法，如果要學(xué)習(xí)gradle相關(guān)的東西，請(qǐng)查看上篇
http://www.itdecent.cn/p/57d99c983a7a。官方文檔上也有自定義插件的介紹。

插件類型

Gradle的插件一般有這么幾種：
一種是直接在項(xiàng)目中的gradle文件里編寫，這種方式的缺點(diǎn)是無(wú)法復(fù)用插件代碼，在其他項(xiàng)目中還得復(fù)制一遍代碼（或者說(shuō)說(shuō)復(fù)制一遍文件）
另一種是在獨(dú)立的項(xiàng)目里編寫插件，然后發(fā)布到中央倉(cāng)庫(kù)，之后直接引用就可以了，優(yōu)點(diǎn)就是可復(fù)用（重點(diǎn)學(xué)習(xí)這種）。

Gradle插件開發(fā)

Gradle插件是使用Groovy進(jìn)行開發(fā)的，而Groovy其實(shí)是可以兼容Java的。AndroidStudio其實(shí)除了開發(fā)androidApp外，完全可以勝任開發(fā)Gradle插件這一工作，下面來(lái)講講具體如何開發(fā)。

1：首先，新建一個(gè)Android項(xiàng)目。

2：之后，新建一個(gè)Android Module項(xiàng)目，類型選擇Android Library。（AndroidStudio中是沒有新建類似Gradle Plugin這樣的選項(xiàng)的，那我們?nèi)绾卧贏ndroidStudio中編寫Gradle插件）

3：將新建的Module中除了build.gradle文件外的其余文件全都刪除，然后刪除build.gradle文件中的所有內(nèi)容后改為如下。

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

dependencies {
//gradle sdk
    compile gradleApi()
//groovy sdk
    compile localGroovy()
}
repositories {
    url ***
}

4:在新建的module中新建文件夾src，接著在src文件目錄下新建main文件夾，在main目錄下新建groovy目錄，這時(shí)候groovy文件夾會(huì)被Android識(shí)別為groovy源碼目錄（由于gradle是基于groovy，因此，我們開發(fā)的gradle插件相當(dāng)于一個(gè)groovy項(xiàng)目）。

package  com.peyton.test

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

public class PluginImpl implements Plugin<Project> {

    void apply(Project project) {
        System.out.println("========================");
        System.out.println("hello gradle plugin!");
        System.out.println("========================");
    }
}

5：除了在main目錄下新建groovy目錄外，你還要在main目錄下新建resources目錄，同理resources目錄會(huì)被自動(dòng)識(shí)別為資源文件夾。在groovy
目錄下新建項(xiàng)目包名，就像Java包名那樣。resources目錄下新建文件夾META-INF，META-INF文件夾下新建gradle-plugins文件夾。然后在
resources/META-INF/gradle-plugins目錄下新建一個(gè)properties文件，注意該文件的命名就是你只有使用插件的名字，這里命名為com.peyton.testplugin.properties，在里面輸入

implementation-class=com.peyton.test.PluginImpl(指向項(xiàng)目groovy目錄下Plugin子實(shí)現(xiàn)類)

目前，項(xiàng)目的結(jié)構(gòu)是這樣的。

QQ圖片20170825155855.png

6：上傳maven，將項(xiàng)目寫好的上傳gradle腳本（主要配置了uploadArchives中需要用到的groupId，artifactId及version），復(fù)制到項(xiàng)目下然后執(zhí)行uploadArchives task，即上傳到maven。
也可以先上傳到本地的maven，方法如下：
6.1：在插件module的build.gradle中

//group和version在后面使用自定義插件的時(shí)候會(huì)用到
group='com.tc.plugin'
version='1.0.0'


uploadArchives {
    repositories {
        mavenDeployer {
            //提交到遠(yuǎn)程服務(wù)器：
           // repository(url: "http://****/repos") {
            //    authentication(userName: "***", password: "***")
           // }
           //本地的Maven地址設(shè)置為D:/repos
            repository(url: uri('../repo'))
        }
    }
}

6.2 在使用的module的build.gradle中

buildscript {
    repositories {
        maven {//本地Maven倉(cāng)庫(kù)地址
            url uri('../repo')
        }
    }
    dependencies {
        //格式為-->group:module:version
        classpath 'com.tc.plugin:myplugin:1.0.0'
    }
}
//com.hc.gradle為resources/META-INF/gradle-plugins
//下的properties文件名稱
apply plugin: 'com.peyton.testplugin'

7：項(xiàng)目中使用：在項(xiàng)目中需要用到插件的地方引入插件，如app目錄下build.gradle

buildscript {
    repositories {
        maven {//本地Maven倉(cāng)庫(kù)地址
            url ***********
        }
    }
    dependencies {
        //格式為-->groupId:artifactId:version
        classpath 'com.plugin.test:myplugin:1.0.0'
    }
}
//com.peyton.testplugin為resources/META-INF/gradle-plugins
//下的properties文件名稱
apply plugin: 'com.peyton.testplugin'

以上就完成了最簡(jiǎn)單的插件

簡(jiǎn)單自定義配置并讀取build.gradle值

根據(jù)Gradle官網(wǎng)的介紹，Project是你與Gradle交互的主接口，故將Project作為自定義Plugin的泛型傳入

implements Plugin<Project>

通過(guò)Project訪問的使用場(chǎng)景：Extension。先看一個(gè)熟悉的內(nèi)容：

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.0"

    defaultConfig {
        applicationId "com.peyton.test"
        minSdkVersion 15
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

上面的android{}、compileSdkVersion、defaultConfig {}等等這些設(shè)置就是通過(guò)Extension。下面我們自定義一個(gè)Extension。首先，定義兩個(gè)Groovy類：Address和TestExtension.

class Address{
    String province=null
    String city=null
}
class TestExtension{
    String myName = null;

}

再自定義Plugin：

class PluginImpl implements Plugin<Project> {

    @Override
    void apply(Project project) {

        project.extensions.create('tc',TestExtension);
        project.extensions.create('address', Address);


        project.task('readExtension') << {
            def address=project['address']

            println project['tc'].myName
            println address.province+" "+address.city

        }
    }
}

接下來(lái)就是使用插件（即build.gradle 中）：

apply plugin 'com.peyton.testplugin'

tc {
    address{
       province "Fujian"
        city "Xiamen"
    }

    myName "Peyton"

}

com.peyton.testplugin這一行會(huì)導(dǎo)致直接執(zhí)行PluginImpl 類的apply方法。所以，tc{}這個(gè)塊必須放在com.peyton.testplugin之后，因?yàn)樵跊]有執(zhí)行project.extensions.create('tc',TestExtension);之前，使用tc{}會(huì)報(bào)錯(cuò)！address{}也是同理。另外，補(bǔ)充一下：project.extensions相當(dāng)于project.getExtensions()即返回的是ExtensionContainer對(duì)象(上一篇groovy語(yǔ)法特性中有講到)而ExtensionContainer對(duì)象的create方法就是把tc{}與TestExtension對(duì)應(yīng)起來(lái)。其他通過(guò)project.的方式也是同樣的道理。再看看project.task('readExtension')，這是創(chuàng)建一個(gè)task。相當(dāng)于在build.gradle文件中的task xxx <<{}只不過(guò)這里是通過(guò)代碼的方式動(dòng)態(tài)創(chuàng)建.接下來(lái)只需要在命令行中運(yùn)行readExtension 任務(wù)即可看下如下信息

:testmodule:readExtension
Peyton
Fujian Xiamen