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"http://類名
    packageName = "com.zhuyong.mylibrary"http://類所在包名
    methodName = "showToasShort"http://方法名
    injectCode = "android.widget.Toast.makeText(context,\"這是我在Library中插入的代碼\",android.widget.Toast.LENGTH_SHORT).show();"http://要注入的代碼
}

接下來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閱讀 228,345評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,494評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,283評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,953評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,714評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,410評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,940評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,776評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,210評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,654評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373

推薦閱讀更多精彩內容