背景
入职新公司后，发现项目中有用到python脚本根据自定义配置文件生成Java代码的部分，而且脚本与配置文件以及生成的java代码最终都上传到代码仓库，因为没有在编译时生成代码！！！可能写这部分的人员并没有去接触gradle插件的方法吧，笔者之见也没有接触过gradle插件开发，不过在使用一些第三方库比如room，dagger时对编译时自动生成代码有认知。
如用闲余时间研习了一下如何自定义gradle插件，接下来就进入正题
自定义插件方式
自定义gradle有以下几种方式：
1.Build script
这种方式是直接在module的build.gradle中自定义，只在当前模块使用。实际上的效果跟在gradle中自定义一个task区别不大
2. buildSrc project
这种插件脚本要求源码放置在 rootProjectDir/buildSrc/src/main/groovy目录内（工程根目录下创建 buildSrc 目录），Gralde 会自动编译和测试这个插件。这种方式创建的插件可在项目的所有模块中使用
3.独立的project
这种方式创建的插件可以发布到maven库，可供第三方使用
本文只针对第三种方法简单介绍
自定义独立project的gradle插件
大致按照分为以下几个步骤
1.新建一个android module，删除除了res/main目录和build.gradle之外的文件，删除build.gradle中的内容
2.新建res/main/groovy和res/main/resources文件夹。后面会在groovy文件夹中编写gradle插件代码，resources文件夹中再创建META-IFN文件夹，再在该文件夹中创建gradle-plugins文件夹，创建好之后应该是这样的结构：
3.在groovy中创建包名目录后，然后创建插件入口类
package com.sven.demo.gradle
import org.gradle.api.Plugin
import org.gradle.api.Project
class SvenGradlePlugin implements Plugin<Project> {
@Override
void apply(Project project) {
project.logger.quiet "* Sven gradle plugin loaded."
}
}
这个插件什么都没做，只是打印了一行log
4.修改build.gradle脚本内容如下：
apply plugin: 'groovy'
apply plugin: 'maven'
repositories {
mavenLocal()
jcenter()
}
dependencies {
compile gradleApi()
}
///////////////////////////////
// 发布到本地的maven仓库
///////////////////////////////
// 插件版本号
def versionName = "1.0.0"
// 插件groupId
group "com.sven.plugin"
version versionName
uploadArchives{ //当前项目可以发布到本地文件夹中
repositories {
mavenDeployer {
// 定义本地maven仓库的地址
// 这里指定为项目根目录的repo文件夹
repository(url: uri('../repo'))
}
}
}
该文件内容说明看注释
5.在META-INF.gradle-plugins文件夹中新建custom-gradle.properties文件，文件内容为：
implementation-class=com.sven.demo.gradle.SvenGradlePlugin
其中custom-gradle为插件使用时apply的名称，即：
apply plugin: "custom-gradle"
implementation-class指定对应插件实现，这里即为SvenGradlePlugin
-
发布到本地仓库，上面的步骤都没问题的情况下执行插件项目的task: uploadArchives就可以发布到项目根目录的repo文件夹中
uploadArchives.png
repo.png 成功上传到本地maven库后，就可以像使用第三方插件一样使用我们的自定义插件了
根目录的build.gradle中：
buildscript {
repositories {
google()
jcenter()
maven {
url uri('./repo')
}
}
dependencies {
classpath 'com.android.tools.build:gradle:3.4.2'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
classpath 'com.sven.plugin:plugin:1.0.0'
}
}
app目录的build.gradle中：
apply plugin: 'com.android.application'
apply plugin: 'custom-gradle'
android {
compileSdkVersion 28
defaultConfig {
applicationId "com.sven.demo.gradleplugin"
minSdkVersion 21
targetSdkVersion 28
versionCode 1
versionName "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
}
-
配置完后，sync或者编译时会看到如下输出：
gradle-log.png
我们打印的日志会在gradle插件加载时输出
结语
至此我们自定义插件的第一步已经完成，后续会继续研究gradle插件自定义属性以及如何使用JavaPoet生成代码
