在上一篇【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