自定义Gradle插件（十）

1. 脚本插件
2. 对象插件
- 在build.gradle中写Plugin
- 创建单独的 “buildSrc” Module
- 上传远端maven仓库

gradle插件分成脚本插件和对象插件：

脚本插件：一个普通的构建脚本，可以导入到其他的构建脚本中。
对象插件：实现了org.gradle.api.Plugin接口。

1. 脚本插件

假设我们有一个脚本名为 sayhello.gradle ，它里面有一个task：

task sayHello << {println 'hello world'
}

然后我们在build.gradle中依赖这个外部脚本，调用Project的apply方法，apply方法调用时传入from属性。

apply from: 'sayhello.gradle'

此时我们运行gradle sayHello 命令，可以看到sayHello 这个task执行了：

:sayHello
hello world

2. 对象插件

有三种形式可以定义对象插件：

直接在build.gradle中编写Plugin，这种方式这种方法写的Plugin无法被其他 build.gradle 文件引用。
单独的一个Module，这个Module的名称必须为buildSrc，同一个工程中有的构建文件够可以引用这个插件，但是不能被其他工程引用。
在一个项目中自定义插件，然后上传到远端maven库等，其他工程通过添加依赖，引用这个插件。

在build.gradle中写Plugin

apply plugin:UserPlugin// 实现Plugin
class UserPlugin implements Plugin<Project>{@Overridevoid apply(Project project){println "hello"   }
}

创建单独的 "buildSrc" Module

创建一个 Module （Phone&Tablet Module 或 Android Librarty 都可以），Module的名称必须为 buildSrc。
将Module里面的内容删除，只保留build.gradle文件和src/main目录。
我们开发的 gradle 插件相当于一个 groovy 项目。所以需要在 main 目录下新建 groovy 目录。
然后创建一个 Java 文件一样的方式创建一个 groovy 文件，比如包名为 com.android.xx 的 TestPlugin.groovy 文件。

因为gradle插件实际上就是groovy项目，所以需要groovy和gradle的sdk，需要在buildSrc下面的build.gradle修改成：

apply plugin: 'groovy'dependencies {//gradle sdkcompile gradleApi()//groovy sdkcompile localGroovy()
}
repositories {jcenter()
}

使用这个插件，需要在app的build.gradle添加

apply plugin: com.android.hq.testplugin.TestPlugin

输入 ./gradlew tasks，我们可以看到 testPlugin 已经在task列表中。

上传远端maven仓库

创建一个新的 Project。
同样创建一个 Module （Phone&Tablet Module 或 Android Librarty 都可以），Module的名称随意。
将Module里面的内容删除，只保留build.gradle文件和src/main目录。
我们开发的 gradle 插件相当于一个groovy项目。所以需要在main目录下新建groovy目录。
然后创建一个 Java 文件一样的方式创建一个 groovy文件，比如报名为 com.android.xx 的 TestPlugin.groovy 文件。
现在，我们已经定义好了自己的 gradle 插件类，接下来就是告诉 gradle，哪一个是我们自定义的插件类，因此，需要在 main 目录下新建 resources 目录，然后在 resources 目录里面再新建 META-INF 目录，再在 META-INF 里面新建 gradle-plugins 目录。最后在 gradle-plugins 目录里面新建 properties 文件，注意这个文件的命名，你可以随意取名，但是后面使用这个插件的时候，会用到这个名字。比如，取名为
com.android.xx.properties，而在其他 build.gradle 文件中使用自定义的插件时候则需写成：apply plugin: 'com.android.xx'
然后在com.android.hq.testplugin.properties文件里面指明你自定义的类：implementation-class=com.android.hq.testplugin.TestPlugin
修改build.gradle: 因为我们要用到 groovy 以及后面打包要用到 maven ,所以在我们自定义的 Module 下的 build.gradle 需要添加如下代码：

apply plugin: 'groovy'
apply plugin: 'maven'dependencies {//gradle sdkcompile gradleApi()//groovy sdkcompile localGroovy()
}
repositories {mavenCentral()
}

前面我们已经自定义好了插件，接下来就是要打包到Maven库里面去了，你可以选择打包到本地，或者是远程服务器中。

//group和version在后面使用自定义插件的时候会用到
group='com.android.xx'
version='1.0.0'uploadArchives {repositories {mavenDeployer {//提交到远程服务器：//repository(url: "http://www.xxx.com/repos") {//    authentication(userName: "admin", password: "admin")//}//本地的Maven地址设置为/mnt/TestRepos/repository(url: uri('/mnt/TestRepos/'))}}
}

然后通过gradle的uploadArchives就可以执行打包上传下载了。我们可以在对应的文件目录下可以看到对应的jar包。
我们可以在Module的build的gradle文件中指定Mavne的地址，自定义插件的名称和依赖包名。


//com.android.hq.testplugin.TestPlugin为resources/META-INF/gradle-plugins 下的properties文件名称
apply plugin: 'com.android.xx'buildscript {repositories {maven {//本地Maven仓库地址url uri('/mnt/TestRepos/')}}dependencies {//格式为-->group:module:versionclasspath 'com.android.hq.testplugin:testplugin:1.0.0'}
}

自定义Gradle插件（十）相关推荐

使用AndroidStudio创建自定义gradle插件并被引用实战例子
项目中引入自定义Gradle plugin一般有三种方法: 直接写在 build.gradle中. plugin源码放到rootProjectDir/buildSrc/src/main/groovy目 ...
Android如何自定义Gradle插件
Android-如何自定义gradle插件自定义gradle插件可以实现定制自己的构建流程,以达到复用目的: ##1. 自定义插件方式自定义插件有三种方式添加脚步在你的app项目的build. ...
Android组件化开发实践（九）：自定义Gradle插件
本文紧接着前一章Android组件化开发实践(八):组件生命周期如何实现自动注册管理,主要讲解怎么通过自定义插件来实现组件生命周期的自动注册管理. 1. 采用groovy创建插件新建一个Java L ...
创建第一个适用于Android的自定义Gradle插件-第2部分：在构建时生成资源
A hands on tutorial to get started with adding custom functionality to your Android builds using Kot ...
【Android Gradle 插件】自定义 Gradle 插件优化图片 ① ( Android 中的 WebP 图片格式使用 | WebP 格式转换 | WebP 参考文档 )
文章目录一.Android 中的 WebP 图片格式使用二.WebP 格式转换三.WebP 参考文档 Android Plugin DSL Reference 参考文档 : Android St ...
通过自定义Gradle插件修改编译后的class文件
我的简书同步发布:通过自定义Gradle插件修改编译后的class文件转载请注明出处:[huachao1001的专栏:http://blog.csdn.net/huachao1001] 或许你会觉得 ...
自定义Gradle插件之Hello World
自定义Gradle插件之"Hello World" 0.新建一个用于开发这个插件的文件夹 1.确定Plugin id Plugin id一般定义为java 包名. 由字母和数字及& ...
Gradle学习第一篇——自定义Gradle插件
纸上得来终觉浅,绝知此事要躬行. 自定义Gradle插件有三种方法,各有优劣处,同类博客文章很多但是有的语法已经过时了,笔者运行环境 Android Studio Dolphin && ...
【错误记录】自定义 Gradle 插件报错 ( Could not find implementation class x for plugin x specified in jar:file )
文章目录一.报错信息二.解决方案一.报错信息参考 [Android Gradle 插件]自定义 Gradle 插件模块 ④ ( META-INF 中声明自定义插件的核心类 | 在应用中依赖本地 ...
Android 自定义gradle插件
android自定义gradle插件的步骤 1.首先我们新建一个android项目 2.然后新建一个android module a.删除一些不需要的文件目录,然后新建groovy,resources ...