Gradle系列 (下篇) —在Android Library中依赖自定义Gradle插件并往class中注入代码

在上一篇【Gradle系列(中篇)】中,我们已经完成了在自定义插件中对class文件代码的注入功能,只不过是在主项目app中使用自定义插件的,那么能不能在library中使用自定义插件呢?当然可以,这不是废话么,OK,那我们就来试一下,看看会不会踩坑~

首先,我们先来在项目中新建一个Android Library,名称暂且叫做“mylibrary”,如下:

这里我新建了一个类叫做“ToastUtils”,包含了一个空方法showToasShort,后面我们就在showToasShort方法中注入一行代码,来弹出一个Toast提示。

Android Library已经创建好了,然后我们在app中去引用这个module,代码如下:

dependencies {
    ···
    implementation project(':mylibrary')
    ···
}

之前我们依赖插件和传值是在app中进行的,也就是下面这段代码,现在我们从app的build.gradle中移除,然后放到mylibrary的build.gradle中(传值要对应修改)。

apply plugin: 'custom-gradle-plugin'

InjectCodeToClass {
    className = "ToastUtils"//类名
    packageName = "com.zhuyong.mylibrary"//类所在包名
    methodName = "showToasShort"//方法名
    injectCode = "android.widget.Toast.makeText(context,\"这是我在Library中插入的代码\",android.widget.Toast.LENGTH_SHORT).show();"//要注入的代码
}

接下来Sync一下,Build过程直接报错了,报错信息如下:

我们重点看这几句:

Caused by: org.gradle.api.UnknownDomainObjectException: Extension of type 'AppExtension' does not exist. Currently registered extension types: [ExtraPropertiesExtension, DefaultArtifactPublicationSet, ReportingExtension, SourceSetContainer, JavaPluginExtension, NamedDomainObjectContainer<BaseVariantOutput>, LibraryExtension]

其中 Extension of type 'AppExtension' does not exist.这句就是AppExtension类型不存在,后面的意思是当前可注册的extension types有哪些。没错,我们这是在library中使用插件而不是app中,所以不可以使用AppExtension,从报错信息的最后我们看到有一个Extension类型是LibraryExtension,就是它没错了,现修改MyPlugin类如下:

def android = project.extensions.getByType(AppExtension.class)
修改为如下(import同时修改):
def android = project.extensions.getByType(LibraryExtension.class)

重新执行uploadArchives生成新的maven包(如果报错则要先注释掉apply的引用和InjectCodeToClass的传值,uploadArchives执行完成后再放开)。此时,我们再执行clean会发现又报错了,报错信息如下:

* What went wrong:
A problem occurred configuring project ':mylibrary'.
> Transforms with scopes '[SUB_PROJECTS, EXTERNAL_LIBRARIES]' cannot be applied to library projects.

也就是说在Transforms中[SUB_PROJECTS, EXTERNAL_LIBRARIES]这两个作用范围的类型不能应用在library中,我们把这两个类型去掉试试看,在作如下修改

    static {
        SCOPES.add(QualifiedContent.Scope.PROJECT);
//        SCOPES.add(QualifiedContent.Scope.SUB_PROJECTS);
//        SCOPES.add(QualifiedContent.Scope.EXTERNAL_LIBRARIES);
    }

重复刚才的动作,重新执行uploadArchives生成新的maven包。clean之后发现已经没有报错了。OK,那接下来我们来执行make project看一下代码能不能注入进去。

Executing tasks: [:myplugin:assemble, :myplugin:testClasses, :app:assembleDebug] in project /Users/zhuyong/Desktop/Android Demo/JetPackDemo/GradleDemo


> Configure project :mylibrary
=================================
======这是我的自定义Gradle插件======
=================================

> Task :myplugin:compileJava NO-SOURCE
> Task :myplugin:compileGroovy
> Task :myplugin:processResources
> Task :myplugin:classes
> Task :myplugin:jar
> Task :myplugin:assemble
> Task :myplugin:compileTestJava NO-SOURCE
> Task :myplugin:compileTestGroovy NO-SOURCE
> Task :myplugin:processTestResources NO-SOURCE
> Task :myplugin:testClasses UP-TO-DATE
> Task :app:preBuild UP-TO-DATE
> Task :app:preDebugBuild UP-TO-DATE
> Task :mylibrary:preBuild UP-TO-DATE
> Task :mylibrary:preDebugBuild UP-TO-DATE
> Task :mylibrary:packageDebugRenderscript NO-SOURCE
> Task :app:generateDebugBuildConfig
> Task :mylibrary:generateDebugBuildConfig
> Task :mylibrary:generateDebugResValues
> Task :mylibrary:compileDebugAidl NO-SOURCE
> Task :app:compileDebugAidl NO-SOURCE
> Task :app:compileDebugRenderscript NO-SOURCE
> Task :mylibrary:compileDebugRenderscript NO-SOURCE
> Task :mylibrary:generateDebugResources
> Task :mylibrary:packageDebugResources
> Task :mylibrary:processDebugManifest
> Task :mylibrary:parseDebugLocalResources
> Task :mylibrary:javaPreCompileDebug
> Task :app:mainApkListPersistenceDebug
> Task :app:generateDebugResValues
> Task :app:generateDebugResources
> Task :mylibrary:generateDebugRFile
> Task :mylibrary:compileDebugJavaWithJavac
> Task :app:mergeDebugResources
> Task :mylibrary:bundleLibCompileDebug
> Task :app:createDebugCompatibleScreenManifests
> Task :app:extractDeepLinksDebug
> Task :mylibrary:extractDeepLinksDebug
> Task :app:processDebugManifest
> Task :app:javaPreCompileDebug
> Task :mylibrary:compileDebugLibraryResources
> Task :app:processDebugResources
> Task :app:compileDebugJavaWithJavac
> Task :app:compileDebugSources
> Task :app:mergeDebugShaders
> Task :app:compileDebugShaders
> Task :app:generateDebugAssets
> Task :mylibrary:mergeDebugShaders
> Task :mylibrary:compileDebugShaders
> Task :mylibrary:generateDebugAssets
> Task :mylibrary:packageDebugAssets
> Task :app:mergeDebugAssets
> Task :app:processDebugJavaRes NO-SOURCE
> Task :mylibrary:processDebugJavaRes NO-SOURCE

> Task :mylibrary:transformClassesWith__MyTransformEditClasses__ForDebug
filePath: /Users/zhuyong/Desktop/Android Demo/JetPackDemo/GradleDemo/mylibrary/build/intermediates/javac/debug/classes
正在操作的路径 = /Users/zhuyong/Desktop/Android Demo/JetPackDemo/GradleDemo/mylibrary/build/intermediates/javac/debug/classes/com/zhuyong/mylibrary/ToastUtils.class
要插入的代码 = android.widget.Toast.makeText(context,"这是我在Library中插入的代码",android.widget.Toast.LENGTH_SHORT).show();

> Task :mylibrary:bundleLibResDebug
> Task :mylibrary:bundleLibRuntimeDebug
> Task :app:dexBuilderDebug
> Task :app:checkDebugDuplicateClasses
> Task :app:mergeDebugJavaResource
> Task :app:mergeDebugJniLibFolders
> Task :mylibrary:mergeDebugJniLibFolders
> Task :mylibrary:mergeDebugNativeLibs
> Task :mylibrary:stripDebugDebugSymbols
> Task :mylibrary:copyDebugJniLibsProjectOnly
> Task :app:mergeDebugNativeLibs
> Task :app:stripDebugDebugSymbols
> Task :app:validateSigningDebug
> Task :app:mergeExtDexDebug
> Task :app:mergeDexDebug
> Task :app:packageDebug
> Task :app:assembleDebug

BUILD SUCCESSFUL in 8s
47 actionable tasks: 47 executed

在整个build过程中,我们看到Task:transformClassesWith__MyTransformEditClasses__ForDebug已经执行了注入代码的工作,接下来看一下ToastUtils.class文件的变化:

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.zhuyong.mylibrary;

import android.content.Context;
import android.widget.Toast;

public class ToastUtils {
    public ToastUtils() {
    }

    public static void showToasShort(Context context) {
        Toast.makeText(context, "这是我在Library中插入的代码", 0).show();
    }
}

到此为止,我们已经在library中完成了代码的注入,最后我们再在MainActivity中使用此类,看看能不能正常弹出Toast提示。

package com.zhuyong.gradledemo;

import android.os.Bundle;

import com.zhuyong.mylibrary.ToastUtils;

import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        showToast();
    }

    /**
     * 弹出一个Toast
     */
    public void showToast() {
        ToastUtils.showToasShort(this);
    }
}

直接运行项目,在手机上运行效果如下:

至此,Gradle系列上中下三篇已经完结了,如果大家还有什么疑问的话随时可以跟我讨论,谢谢。

全部代码已上传至: Github

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

推荐阅读更多精彩内容