自定义Gradle Plugin

1,Environment

2,创建项目

  • Create New Project

    《自定义Gradle Plugin》 gradle0.png

    NOTE:Groovy确保勾上

  • 点击Next,填写GroupId和ArtifactId

    《自定义Gradle Plugin》 gradle1.png

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

    《自定义Gradle Plugin》 gradle2.png

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

    《自定义Gradle Plugin》 gradle3.png

3,项目结构

3.1,初始项目结构

《自定义Gradle Plugin》 gradle4.png

3.2, 项目结构调整

  • 项目根目录下new directory

    《自定义Gradle Plugin》 gradle5.png

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

    《自定义Gradle Plugin》 gradle6.png

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

  • create package and class

    《自定义Gradle Plugin》 gradle7.png

《自定义Gradle Plugin》 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

    《自定义Gradle Plugin》 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

《自定义Gradle Plugin》 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:

《自定义Gradle Plugin》 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列表

《自定义Gradle Plugin》 gradle12.png

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

4, task执行

执行./gradlew showDevices

《自定义Gradle Plugin》 gradle13.png

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

    原文作者:比目鱼26
    原文地址: https://www.jianshu.com/p/4b1e4982159c
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞