1.新建module
新建一个名称为plugin的Module,类型选择为Library或下面的Java or Kotlin Library
新建Module之后,会有默认的文件目录,多余的文件都可以删掉的。
我们可以看到main文件夹下有java文件夹,Gradle Plugin可以用java写,也可以用kotlin、groovy来学,喜欢用什么就可以在main文件下新建对应语言的文件夹接口,比如kotlin文件夹。
1.2、新建文件添加依赖
在Gradle 6.4
及以后就不用再添加gradleApi()来配置Plugin的依赖啥的了,直接一个java-gradle-plugin
插件搞定,它会自动把java、gradleApi()
依赖添加到项目中。
并且不需要像以前在src/main/resources/META-INF/gradle-plugins/xxx.properties中来配置你的implementation-class了
,直接一个gradlePlugin{ }
配置搞定,Gradle会自动生成META-INF
描述文件。
在plugin>build.gradle文件中依赖插件:
plugins {
id 'java-gradle-plugin'
}
配置如下:
gradlePlugin{
plugins{
DependenciesPlugin{
id = 'com.taimei.plugin.dependencies'
implementationClass = 'com.taimei.plugin.DependenciesPlugin'
}
}
}
- id:apply时引用的plugin id;
- implementationClass:Plugin路径;
在Gradle 6.4以前:
因为以前这些文件夹、配置全是手动的,很繁琐,相比之下,现在更爽多了。
2.本地发布
本地发布要比远端发布简单多了,虽然远端发布也不难,只是繁琐。
2.1、Maven插件
首先,比较常用的仓库是maven,在plugin>build.gradle文件中先依赖一个maven发布的插件'maven-publish'
plugins {
id 'maven-publish'
}
dependencies {
implementation 'com.android.tools.build:gradle:7.3.0'
}
2.2 发布配置
添加发布配置
group 'com.taimei.plugin'
version '1.0.0'
publishing {
// 配置Plugin GAV
publications {
maven(MavenPublication) {
groupId = group
artifactId = 'dependencies'
version = version
from components.java
}
}
// 配置仓库地址
repositories {
maven {
url layout.buildDirectory.dir("maven-repo")
}
}
}
2.3 执行发布操作
./gradlew publish
或者在Android Studio右边Gradle可视化的面板点击运行publish:
2.4使用
ok,本地发布完了,要想使用这个插件,跟我们正常依赖插件是一样的流程。
三步走:
1.在settings.gradle文件中配置插件仓库地址
pluginManagement {
repositories {
// ...
maven {
url './maven-repo'
}
}
}
2.在project>build.gradle文件中添加插件依赖
buildscript {
dependencies {
classpath('com.taimei.plugin:dependencies:1.0.0')
}
}
3.在app:build.gradle文件中依赖我们的plugin
plugins {
id 'com.yechaoa.plugin.dependencies'
}
以上配置都是在app模块中添加的,即需要使用的模块。
编译看效果:
> Configure project :app
>>>>>>>> com.taimei.plugin.DependenciesPlugin
ok,正确打印出来了,说明我们自定义的plugin已经可以对外提供使用了。
注意:本地依赖使用的时候,要先发布,再依赖插件,否则就会出现cannot found找不到依赖的情况。