项目中引入自定义Gradle plugin一般有三种方法:
- 直接写在 build.gradle中
- plugin源码放到buildSrc/src/main/groovy目录下
- plugin打包成jar, 发布到maven仓库, 然后项目通过Build Script依赖jar的形式引入
一、直接写在 build.gradle中
这个最简单直接，以它为入口先介绍Plugin的玩法。
app build.gradle中
//应用插件 这里注意直接写类，不用加引号。
apply plugin: TestPlugin
//创建插件类，覆写apply方法（执行调用点）
class TestPlugin implements Plugin<Project>{
@Override
void apply(Project target) {
println ‘hello plugin!'
}
}
Plugin它本质上是对完成特定功能的task的封装，因此业务功能会交给task来处理。
加上Extension和task:
/**
* 插件拓展：为plugin配置各种参数，提供应用程序与Plugin通信
* 也相当于project的ext{}，不过这个是封装在plugin部分。
* project的ext{}更适合配置全局common的东西
*/
class TestExtension {
String msg
}
testExtension.msg = "自定义插件拓展"
class TestPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
//创建Extension类，key-value的形式，外部可使用key的闭包传递信息
def test = project.extensions.create('testExtension', TestExtension)
//依托在build task之后执行
project.getTasks().getByName('build') {
doLast {
println test.msg
}
}
}
}
二、buildSrc方式
新建buildSrc空文件夹，这个目录默认就用来存放自定义插件。重点就是main部分：plugin是.groovy文件格式，resources文件夹也按如图命名方式。test-plugin.properties后者前的名字部分是插件名。
buildSrc工程目录
build.gradle配置：
apply plugin: 'groovy'
dependencies {
implementation gradleApi()
implementation localGroovy()
}
repositories {
jcenter()
}
sourceSets {
main {
groovy {
srcDir 'src/main/groovy'
}
resources {
srcDir 'src/main/resources'
}
}
}
TestPlugin.groovy:
package com.stan.plugin
import org.gradle.api.Plugin
import org.gradle.api.Project
class TestPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
println 'test plugin!!!'
}
}
test-plugin.properties
implementation-class=com.stan.plugin.TestPlugin
app或者其他用到插件的module build.gradle中引入插件
apply plugin: 'test-plugin’
三、plugin打包成jar, 发布到本地或者远程maven仓库
创建android module，保留与buildSrc一致的目录结果，多余的删除。
功能完成后，执行build task，在build/libs目录下会生成.jar文件
在buildSrc的基础上，调整build.gradle
//添加maven plugin, 用于发布我们的jar
apply plugin: 'maven'
repositories {
mavenCentral()
}
//设置maven deployer
uploadArchives {
repositories {
mavenDeployer {
//设置插件的GAV参数
pom.groupId = 'com.stan.plugin'
pom.artifactId = ‘my-plugin'
pom.version = 1.0
//文件发布到下面目录
repository(url: uri('../release'))
}
}
}
运行uploadArchives task，就能在设置的仓库路径中生成 my-plugin了
本地仓库
最后在app或者其他module build.gradle引入
apply plugin: 'my-plugin'
buildscript {
repositories {
maven {
//my-plugin 所在的仓库
//这里是发布在本地文件夹了
url uri('../release')
}
}
dependencies {
//引入my-plugin
classpath 'com.stan.plugin:my-plugin:1.0'
}
}
这里注意：module名、插件名、pom.artifactId保持一致，不然容易报：Plugin with id ‘XXX' not found.
