Gradle自定义插件
目录
自定义脚本插件
自定义一个脚本插件比较简单，直接在build.gradle中定义即可
首先需要在dependencies中加入依赖
dependencies {
compile gradleApi()
compile localGroovy()
}
然后创建Plugin
class ScriptPlugin implements Plugin<Project>{
@Override
void apply(Project project) {
project.task("ScriptTask"){
doLast {
println("我是脚本插件")
}
}
}
}
//应用Plugin
apply plugin:ScriptPlugin
完整代码如下
plugins {
id 'groovy'
id 'java'
}
group 'com.itfitness'
version '1.0'
archivesBaseName = 'test-plugin'
repositories {
mavenCentral()
}
dependencies {
compile gradleApi()
compile localGroovy()
}
class ScriptPlugin implements Plugin<Project>{
@Override
void apply(Project project) {
project.task("ScriptTask"){
doLast {
println("我是脚本插件")
}
}
}
}
//应用Plugin
apply plugin:ScriptPlugin
执行ScriptTask结果如下
自定义buildSrc插件
这种方式需要在项目中新建一个module名字就叫buildSrc，创建后可能有如下报错
这个时候需要找到项目的setting.build文件，将里面的include 'buildSrc'删除
然后我们调整buildSrc目录下的build.gradle文件如下所示
plugins {
id 'groovy'
id 'java'
}
dependencies {
compile gradleApi()
compile localGroovy()
}
然后我们在buildSrc下新建src/main/grovvy和src/main/resources目录
然后我们在groovy目录中创建自己的包目录和Plugin文件
BuildSrcPlugin如下所示
package com.itfitness.plugin
import org.gradle.api.Plugin
import org.gradle.api.Project
class BuildSrcPlugin implements Plugin<Project>{
@Override
void apply(Project project) {
project.task("BuildSrcTask"){
doLast {
println("我是buildSrc插件")
}
}
}
}
然后我们可以在项目的build.gradle中引用
//应用buildSrc插件
apply plugin: BuildSrcPlugin
执行插件中定义的BuildSrcTask任务结果如下
此外还有可以通过配置Plugin的id来引用插件的方式，如下在resources文件夹下建立META-INF/gradle-plugins目录并在里面新建<plugin的id>.properties文件（我这里的plugin的id设置为了com.itfitness.plugin）：
然后在文件里配置好Plugin所在的类
implementation-class=com.itfitness.plugin.BuildSrcPlugin
这样就可以通过id来引入Plugin了
plugins {
id 'groovy'
id 'java'
////应用buildSrc插件(通过id)
id 'com.itfitness.plugin'
}
这时我们同步下gradle可能会发现如下报错
这个错误我也是查了好久才明白怎么回事，原因就是你新建META-INF/gradle-plugins文件夹的时候IDE把文件夹合并了
这个需要我们给他手动分开，分开后再同步就OK了，执行结果与上面的一致
自定义独立插件
独立插件有个好处就是可以打包给别人使用，首先也是需要建立一个module，然后调整build.gradle文件
plugins {
id 'groovy'
id 'java'
id 'maven'
}
repositories {
mavenCentral()
}
dependencies {
compile gradleApi()
compile localGroovy()
}
group='com.itfitness.moduleplugin' //组名
version='1.0.0' //版本号
archivesBaseName='module-plugin' //工程名
//生成本地库
uploadArchives{
repositories {
mavenDeployer{
repository(url: uri('../ModulePlugin'))
}
}
}
接下来src中创建Plugin文件和配置文件与buildSrc的一样，如下所示
ModulePlugin文件：
package com.itfitness.plugin
import org.gradle.api.Plugin
import org.gradle.api.Project
class ModulePlugin implements Plugin<Project>{
@Override
void apply(Project project) {
project.task("ModuleTask"){
doLast {
println("我是独立插件")
}
}
}
}
com.itfitness.moduleplugin.properties文件：
implementation-class=com.itfitness.plugin.ModulePlugin
然后我们打开右侧的gradle视图找到uploadArchives任务双击执行
或者直接在Module的build.gradle文件中执行uploadArchives任务
执行成功后，当前项目下就生成了ModulePlugin目录，里面就是生成的可以供别人使用的插件
使用方式如下，在项目的build.gradle文件中配置buildscript
buildscript {
repositories {
maven {
url uri('./ModulePlugin')
}
}
dependencies {
//与插件module中的build.gradle配置的要一一对应
classpath 'com.itfitness.moduleplugin:module-plugin:1.0.0'
}
}
然后在Module中引入插件（注意不能直接在项目的build.gradle中引入，会提示错误），我这里在plugin的build.gradle文件中引入插件
plugins {
id 'groovy'
id 'java'
id 'maven'
//应用独立插件
id 'com.itfitness.moduleplugin'
}
执行插件中创建的ModuleTask结果如下
