自定义Gradle插件

  最近在学习字节码插桩技术,利用字节码插桩技术,我们可以在编译时期对字节码进行修改,达到完成一些特殊需求,比如埋点(可以声明一个BaseActivity,在onCreate和onDestory中进行埋点);统计函数执行时间;热修复,ButterKnief、Dagger等也用到了字节码插桩技术。
  在Android中要使用字节码插桩技术需要完成三步:

  • 自定义Gradle插件 :自定义插件,重写apply方法,注册自定义Transform
  • Transform Api使用:自定义Ttransform,在transform方法中实现处理逻辑
  • Asm的使用: 在transform中使用Asm插入字节码
      本文是实现第一步,自定义Gradle。
      实现自定义Gradle插件主要有三种方式:
    1.在build.gradle中定义,直接在module的build.gradle中实现,缺点:只能在本项目中使用,不好复用。
    2.buildSrc中使用。这种方式需要在项目中新建一个model命名为buildSrc,这个目录就用来存放自定义插件,缺点:只能在本项目中使用,不好复用。
    3.独立Module中使用。这种方式就是完全独立开发一个Module,并且可以上传至maven库,可以随便用。
    由于三种方式实现都差不多,前两种局限性比较大,所以本文只对第三种进行记录。
    1、新建Android Module选择Android Library类型即可
      除去src/main和build.gradle其余文件都删除,并清除build.gradle内容,将以下内容填入build.gradle,并同步gradle
apply plugin: 'groovy'

dependencies {
    //gradle sdk
    implementation gradleApi()
    //groovy sdk
    implementation localGroovy()
}

2、新建groovy文件,实现插件逻辑
  在src/main目录下新建groovy目录,在groovy目录下新建com.example.clean目录(名字自取即可),在该目录下新建CleanPlugin.groovy文件,文件有一个绿色的G标记,表示系统识别为groovy文件,可以导入gradle api。如果没有出现绿色标志,可以将文件名改为小写试试。

新建插件文件

  这个cleanplugin.groovy就是我们要实现插件的主要逻辑,我们需要声明一个类来实现Plugin<Project>接口,在apply中实现主要逻辑。

package com.example.clean
import org.gradle.api.Plugin
import org.gradle.api.Project;

class cleanplugin implements Plugin<Project> {
    @Override
    void apply(Project project) {
        println("clean plugin")
    }
}


  注意记得导入包目录,否则会导致找不到插件实现类
3、声明插件
  在src/main目录下新建resource目录,接着新建META-INF目录,继续新建gradle-plugins目录,再新建com.example.firstplugin.properties文件(名字自取),注意文件名即为到时候其他项目中引用的插件名,在该文件中写入如下内容

//插件实现类
implementation-class=com.example.clean.cleanplugin

4、将插件上传至maven库
  在插件的build.gradle文件中添加插件groupid、version等参数和上传maven地址

apply plugin: 'maven-publish'
publishing {
    publications {
        mavenJava(MavenPublication) {

            //其他项目使用插件时的方式:classpath 'com.example.clean:firstplug:1.0.0'
            //三个参数
            groupId 'com.example.clean'
            artifactId 'firstplug'
            version '1.0.0'

            from components.java

        }
    }
}

publishing {
    repositories {
        maven {
            // maven地址,可以是本地地址也可以是远程地址
            url uri('C:/Android/repos')
        }
    }
}

最终build.gradle文件内容如下:

apply plugin: 'groovy'
apply plugin: 'maven-publish'

dependencies {
    //gradle sdk
    implementation gradleApi()
    //groovy sdk
    implementation localGroovy()
}

publishing {
    publications {
        mavenJava(MavenPublication) {

            //其他项目使用插件时的方式:classpath 'com.example.clean:firstplug:1.0.0'
            //三个参数
            groupId 'com.example.clean'
            artifactId 'firstplug'
            version '1.0.0'

            from components.java

        }
    }
}

publishing {
    repositories {
        maven {
            // maven地址,可以是本地地址也可以是远程地址
            url uri('C:/Android/repos')
        }
    }
}

  同步gradle,在右侧的gradle目录中,找到clean下的publish任务,并运行publish,将插件上传至maven库。


运行publish任务,上传插件至maven库

  运行成功后,在本地的repos目录下可以找到上传的插件


本地maven库的插件

5、引用插件
  在项目的根build.gradle文件中,添加插件引用和maven库地址,最终build.gradle文件内容如下:

buildscript {
   
   repositories {
       google()
       jcenter()
       maven {//local maven repo path
           url uri('C:/Android/repos')
       }
   }
   dependencies {
       classpath 'com.android.tools.build:gradle:3.6.1'
       classpath 'com.example.clean:firstplug:1.0.0'
       

       // NOTE: Do not place your application dependencies here; they belong
       // in the individual module build.gradle files
   }
}

同步gradle,在app module的build.gradle文件中添加插件,如下:

//原文件的android插件
apply plugin: 'com.android.application'
//添加自定义插件,插件名即为com.example.firstplugin.properties文件名
apply plugin: 'com.example.firstplugin'

自定义插件名即为com.example.firstplugin.properties文件名,同步build.gradle,运行app下的bulid任务


插件运行成功

出现"clean plugin",即自定义插件中apply方法中输出的日志,表示插件运行成功。

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

推荐阅读更多精彩内容