Gradle学习-自定义一个Gradle插件Plugin

Gradle项目构建工具,使用的Groovy语言。我们自定义一个plugin插件,也需要使用Groovy语言,同是代码需要在buildSrc目录下进行编写。
1.首先我们创建一个Android项目,然后选择File -> New Module-> Java or Kotlin Library,创建一个lib库,库名称就是buildSrc

image.png

新建buildSrc库会遇到错误'buildSrc' cannot be used as a project name as it is a reserved name原因是这个名字被官方保留了。解决:在settings.gradle中把include ':buildSrc'去掉即可

image.png

2.先看一线我们在项目中如何引用我们定义的plugin插件。

MyPlugin是Plugin插件名称
myplugin是Plugin的扩展
name具体的变量

apply plugin: 'com.android.application'
apply plugin: 'MyPlugin'//MyPlugin就是MyPlugin.properties的文件名,比如我们改成com.zh.MyPlugin.properties的话,引入方式就是 apply plugin: 'com.zh.MyPlugin'

myplugin{
    name '在调用的时候,换了个新名字,小丽' //实际作用是setUser('在调用的时候,换了个新名字,小丽')
}
android {
    compileSdkVersion 30
    buildToolsVersion "30.0.2"

    defaultConfig {
        applicationId "com.zhboy.gradle_plugin"
        minSdkVersion 21
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: "libs", include: ["*.jar"])
    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'

}

3.接下来创建插件类 MyPlugin

package com.zhboy.plugin

import com.android.build.gradle.BaseExtension
import org.gradle.api.Plugin
import org.gradle.api.Project

/**
 * @author zhou_hao
 * @date 2020/12/10
 * @description: 创建一个plugin插件
 */
class MyPlugin implements Plugin<Project> {

    @Override
    void apply(Project project) {

        //创建一个新的扩展 myplugin,会在被调用的地方只用MyPluginExtension的方法
        def extension = project.extensions.create("myplugin", MyPluginExtension)

        //afterEvaluate表示全片代码执行完毕或者说初始化完成之后,才会来执行
        project.afterEvaluate{
            println("my name is ${extension.name}")
        }

        def myPluginTransform = new MyPluginTransform()
        //获取到最外层的扩展 这里对应的就是myplugin
        def baseExtension = project.extensions.getByType(BaseExtension)
        //将myplugin这个扩展插件跟myPluginTransform进行关联
        baseExtension.registerTransform(myPluginTransform)
    }
}

4.创建扩展类,一些配置的初始化就在这里

package com.zhboy.plugin

/**
 * @author zhou_hao
 * @date 2020/12/10
 * @description: 我的插件对应的扩展
 */
class MyPluginExtension {
    def name = "小明同学"
}

5.创建MyPlugin.properties,作用时外部项目可以找到我们的插件
resources ->META-INF->gradle-plugins是固定的文件命名

image.png

MyPlugin.properties文件中指定插件plugin的目录即可

implementation-class = com.zhboy.plugin.MyPlugin

6.创建Transform类,android项目打包之前,对编译好的文件进行处理

package com.zhboy.plugin

import com.android.build.api.transform.Format;
import com.android.build.api.transform.QualifiedContent;
import com.android.build.api.transform.Transform
import com.android.build.api.transform.TransformException
import com.android.build.api.transform.TransformInvocation
import com.android.build.gradle.internal.pipeline.TransformManager
import com.android.utils.FileUtils;

/**
 * @author: zhou_hao* @date: 2020/12/10
 * @description: Transform面向切面AOP编程。 的作用是在,android项目打包之前,对编译好的文件进行处理
 * */
class MyPluginTransform extends Transform {

    //返回的任务  名字 会放到任务列表里
    @Override
    String getName() {
        return "myplugin"
    }

    //告诉Transform你要处理那些类型的文件(这些文件都是编译好的)
    @Override
    Set<QualifiedContent.ContentType> getInputTypes() {
        //表示处理编译好的class文件
        return TransformManager.CONTENT_CLASS
    }
    //过滤器,标明你要处理的范围。是整个项目 或者某一个子项目 或者某几个子项目 ,也可以自己去定义Scope
    @Override
    Set<? super QualifiedContent.Scope> getScopes() {
        return TransformManager.SCOPE_FULL_PROJECT
    }

    @Override
    boolean isIncremental() {
        return false
    }

    //这里需要将打包需要的依赖jar包和我们自己的文件,复制到对应的打包的目录下build-intermediates-transforms-myplugin-debug
    @Override
    void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
        //项目打包所依赖的所有Jar包
        def inputs = transformInvocation.inputs
        //项目打包存放需要jar包和class文件的位置
        def outputProvider = transformInvocation.outputProvider
        inputs.each {
            it.jarInputs.each {
                //将项目打包所依赖的所有Jar包,一个一个copy到项目打包存放需要jar包和class文件的位置
                File dest = outputProvider.getContentLocation(it.name, it.contentTypes, it.scopes, Format.JAR)
                FileUtils.copyFile(it.file, dest)
            }
            //将所有class文件,一个一个copy到项目打包存放需要jar包和class文件的位置
            it.directoryInputs.each {
                File dest = outputProvider.getContentLocation(it.name, it.contentTypes, it.scopes, Format.DIRECTORY)
                FileUtils.copyDirectory(it.file,dest)
            }
        }

    }
}

最后附上项目地址:https://github.com/ZHBoy/Gradle-Plugin/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容