自定义Gradle Plugin

1,Environment

2,创建项目

  • Create New Project


    gradle0.png

    NOTE:Groovy确保勾上

  • 点击Next,填写GroupId和ArtifactId


    gradle1.png
  • 确认Gradle使用方式,使用recommend的方式即可,直接点击下一步


    gradle2.png
  • 确认项目的名字和路径,然后Finish就完成了项目的创建


    gradle3.png

3,项目结构

3.1,初始项目结构

gradle4.png

3.2, 项目结构调整

  • 项目根目录下new directory


    gradle5.png
  • 输入src/main/groovy,点击确定后项目结构如下


    gradle6.png

    NOTE:�IntelliJ自动识别groovy,颜色为绿色

  • create package and class


    gradle7.png
gradle8.png

NOTE:create class的时候选择groovy class

4,编写插件

  • 修改groovy代码
class BlogPlugin implements Plugin<Project> {
}

NOTE:ide会提示找不到Project类,不要慌,继续下面的操作

  • 导入依赖
    修改根目录下build.gradle,添加如下代码
dependencies {
    compile gradleApi()
    compile localGroovy()
}
  • sync项目的依赖
    View->Tool Windows->Gradle,或者点击ide右上角的Gradle


    gradle9.png

    点击Refresh all Gradle projects按钮,就完成了刷新操作

  • 解决Plugin<Project>的依赖问题

package com.wsl.plugin
import org.gradle.api.Plugin
import org.gradle.api.Project
class MyPlugin implements Plugin<Project> {
}

NOTE:注意import的命名空间,因为有其他同名的Plugin和Project类,这个地方是org.gradle.api

  • Implements interface
@Override
void apply(Project target) {
    def showDevicesTask = target.tasks.create("showDevices") << {
        def adbExe = target.android.getAdbExe().toString()
        println "${adbExe} devices".execute().text
    }
    showDevicesTask.group = "blogplugin"
    showDevicesTask.description = "Runs adb devices command"
}

NOTE:创建了名为showDevices的task,实际上是执行了adb devices

  • 上传mavenCentral或者jcenter,这里上传到本地maven仓库
    在build.gradle中添加如下代码
apply plugin: 'maven'
uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: uri('/Users/wushuanglong/workspace/repo'))
        }
    }
}

NOTE:这个地方可以是绝对路径,也可以是相对路径

添加完后在gradle task列表里就会多一个uploadArchives的task


gradle10.png

执行uploadArchives task,这里有2种方式:1,在项目目录下./gradlew uploadArchives;2,双击uploadArchives。
这里推荐使用第一种,可以看一些错误的日志输出。
这里执行./gradlew uploadArchives 可能会遇到2个问题。
问题1:Unindexed maven repositories error in IntelliJ IDEA 2016.1.3
问题2:

gradle11.png

使用./gradlew uploadArchives --stacktrace查看堆栈信息,发现原因如下:

Caused by: groovy.lang.GroovyRuntimeException: Conflicting module versions. Module [groovy-all is loaded in version 2.4.7 and you are trying to load version 2.3.11
... 10 more

很明显groovy 的版本冲突了,在build.gradle中注释掉如下代码就解决了

compile 'org.codehaus.groovy:groovy-all:2.3.11'

成功上传后,在本地仓库会生成如下文件

wushuanglongdeMac-mini:repo wushuanglong$ ll com/wsl/android/plugin/test/1.0-SNAPSHOT/
total 72
-rw-r--r-- 1 wushuanglong staff 360 2 19 16:11 maven-metadata.xml
-rw-r--r-- 1 wushuanglong staff 32 2 19 16:11 maven-metadata.xml.md5
-rw-r--r-- 1 wushuanglong staff 40 2 19 16:11 maven-metadata.xml.sha1
-rw-r--r-- 1 wushuanglong staff 3808 2 19 16:11 test-1.0-20170219.081155-1.jar
-rw-r--r-- 1 wushuanglong staff 32 2 19 16:11 test-1.0-20170219.081155-1.jar.md5
-rw-r--r-- 1 wushuanglong staff 40 2 19 16:11 test-1.0-20170219.081155-1.jar.sha1
-rw-r--r-- 1 wushuanglong staff 600 2 19 16:11 test-1.0-20170219.081155-1.pom
-rw-r--r-- 1 wushuanglong staff 32 2 19 16:11 test-1.0-20170219.081155-1.pom.md5
-rw-r--r-- 1 wushuanglong staff 40 2 19 16:11 test-1.0-20170219.081155-1.pom.sha1

  • Searching for plugins
    告诉gradle我们用到了哪些插件class,右键 "main" and create a directory resources/META-INF/gradle-plugins,在里面建一个properties文件,比如就叫com.wsl.properties,那么在Android app里引入插件的代码就是
apply plugin: 'com.wsl'

com.wsl.properties添加插件关联的groove类

implementation-class=com.wsl.plugin.MyPlugin

再次执行./gradlew uploadArchives,上传插件到本地repo后就可以在Android Application中使用了

Android Application集成插件

1, project build.gradle配置

buildscript {
    repositories {
        jcenter()
        //增加代码1
        maven {
            //这里填写plugin项目里指定的本地repo路径
            url uri('/Users/wushuanglong/workspace/repo')
        }
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.3'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
        //增加代码2, 格式为'&{GroupId}:&{ArtifactId}:&{Version}' 
        classpath 'com.wsl.android.plugin:test:1.0-SNAPSHOT'
    }
}
allprojects {
    repositories {
        jcenter()
    }
}

2, module build.gradle配置

apply自定义的插件,注意这里填写的是PluginId,由.properties文件的前缀来指定,这里就PluginId就是com.wsl

apply plugin: 'com.android.application'
apply plugin: 'com.wsl'

3, sync以及插件确认

./gradlew task或者android studio右上角Gradle按钮可以查看当前Android项目的task列表


gradle12.png

这里在myplugin下就可以看到多了个showDevices的task

4, task执行

执行./gradlew showDevices


gradle13.png

成功的显示了device 列表,到此为止插件就成功了

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

推荐阅读更多精彩内容