Gradle学习-----Gradle自定义插件

概述

android项目构建主要由com.android.application及com.android.library两个插件完成,要了解android构建及插

件化,gradle插件学习是必由之路。

Gradle相关语法

在这里不再重复Gradle相关的语法,如果要学习gradle相关的东西,请查看上篇
http://www.jianshu.com/p/57d99c983a7a。官方文档上也有自定义插件的介绍。

插件类型

Gradle的插件一般有这么几种:
一种是直接在项目中的gradle文件里编写,这种方式的缺点是无法复用插件代码,在其他项目中还得复制一遍代码(或者说说复制一遍文件)
另一种是在独立的项目里编写插件,然后发布到中央仓库,之后直接引用就可以了,优点就是可复用(重点学习这种)。

Gradle插件开发

Gradle插件是使用Groovy进行开发的,而Groovy其实是可以兼容Java的。AndroidStudio其实除了开发androidApp外,完全可以胜任开发Gradle插件这一工作,下面来讲讲具体如何开发。

1:首先,新建一个Android项目。

2:之后,新建一个Android Module项目,类型选择Android Library。(AndroidStudio中是没有新建类似Gradle Plugin这样的选项的,那我们如何在AndroidStudio中编写Gradle插件)

3:将新建的Module中除了build.gradle文件外的其余文件全都删除,然后删除build.gradle文件中的所有内容后改为如下。

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

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

4:在新建的module中新建文件夹src,接着在src文件目录下新建main文件夹,在main目录下新建groovy目录,这时候groovy文件夹会被Android识别为groovy源码目录(由于gradle是基于groovy,因此,我们开发的gradle插件相当于一个groovy项目)。

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目录会被自动识别为资源文件夹。在groovy
目录下新建项目包名,就像Java包名那样。resources目录下新建文件夹META-INF,META-INF文件夹下新建gradle-plugins文件夹。然后在
resources/META-INF/gradle-plugins目录下新建一个properties文件,注意该文件的命名就是你只有使用插件的名字,这里命名为com.peyton.testplugin.properties,在里面输入

implementation-class=com.peyton.test.PluginImpl(指向项目groovy目录下Plugin子实现类)

目前,项目的结构是这样的。


QQ图片20170825155855.png

6:上传maven,将项目写好的上传gradle脚本(主要配置了uploadArchives中需要用到的groupId,artifactId及version),复制到项目下然后执行uploadArchives task,即上传到maven。
也可以先上传到本地的maven,方法如下:
6.1:在插件module的build.gradle中

//group和version在后面使用自定义插件的时候会用到
group='com.tc.plugin'
version='1.0.0'


uploadArchives {
    repositories {
        mavenDeployer {
            //提交到远程服务器:
           // repository(url: "http://****/repos") {
            //    authentication(userName: "***", password: "***")
           // }
           //本地的Maven地址设置为D:/repos
            repository(url: uri('../repo'))
        }
    }
}

6.2 在使用的module的build.gradle中

buildscript {
    repositories {
        maven {//本地Maven仓库地址
            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:项目中使用:在项目中需要用到插件的地方引入插件,如app目录下build.gradle

buildscript {
    repositories {
        maven {//本地Maven仓库地址
            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'

以上就完成了最简单的插件

简单自定义配置并读取build.gradle值

根据Gradle官网的介绍,Project是你与Gradle交互的主接口,故将Project作为自定义Plugin的泛型传入

implements Plugin<Project>

通过Project访问的使用场景:Extension。先看一个熟悉的内容:

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 {}等等这些设置就是通过Extension。下面我们自定义一个Extension。首先,定义两个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

        }
    }
}

接下来就是使用插件(即build.gradle 中):

apply plugin 'com.peyton.testplugin'

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

    myName "Peyton"

}

com.peyton.testplugin这一行会导致直接执行PluginImpl 类的apply方法。所以,tc{}这个块必须放在com.peyton.testplugin之后,因为在没有执行project.extensions.create('tc',TestExtension);之前,使用tc{}会报错!address{}也是同理。另外,补充一下:project.extensions相当于project.getExtensions()即返回的是ExtensionContainer对象(上一篇groovy语法特性中有讲到)而ExtensionContainer对象的create方法就是把tc{}TestExtension对应起来。其他通过project.的方式也是同样的道理。再看看project.task('readExtension'),这是创建一个task。相当于在build.gradle文件中的task xxx <<{}只不过这里是通过代码的方式动态创建.接下来只需要在命令行中运行readExtension 任务即可看下如下信息

:testmodule:readExtension
Peyton
Fujian Xiamen
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,319评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,801评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,567评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,156评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,019评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,090评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,500评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,192评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,474评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,566评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,338评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,212评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,572评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,890评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,169评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,478评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,661评论 2 335

推荐阅读更多精彩内容