背景
Hugo 是 Jake Wharton 大神寫的一個(gè)監(jiān)控方法耗時(shí)的插件辐棒。
1. 接入
在根目錄的 build.gradle 中添加
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.jakewharton.hugo:hugo-plugin:1.2.1'
}
}
在 app 的 build.gradle 中添加
plugins {
id 'com.android.application'
id 'com.jakewharton.hugo'
}
2. 使用
@DebugLog
public String getName(String first, String last) {
SystemClock.sleep(15); // Don't ever really do this!
return first + " " + last;
}
在方法上添加 @DebugLog 的注解，就可以在輸出窗口看到相關(guān) Log（方法參數(shù)饺谬，方法耗時(shí)及方法返回值）嫩海。
V/Example: ? getName(first="Jake", last="Wharton")
V/Example: ? getName [16ms] = "Jake Wharton"
3. 問(wèn)題
這個(gè)插件已經(jīng) 7 年沒(méi)有更新了冬殃，gradle 里的一些 api 已經(jīng)不能使用，因此按照上述方法接入叁怪，會(huì)編譯不過(guò)审葬。即在 app 的 build.gradle 中添加 plugin 就會(huì) sync 失敗，具體錯(cuò)誤如下：
查看 Hugo 的源碼發(fā)現(xiàn)代碼量特別少，因此我們完全可以照著源碼自己寫一個(gè)插件涣觉。
創(chuàng)建項(xiàng)目
1. 創(chuàng)建一個(gè) Android 的 project痴荐，并 clone 下 Hugo 的源碼。
2. 從 Hugo 項(xiàng)目中 copy hugo-annotations 到新項(xiàng)目中旨枯，修改 module 中的 build.gradle 文件如下
apply plugin: 'java'
targetCompatibility = JavaVersion.VERSION_1_8
sourceCompatibility = JavaVersion.VERSION_1_8
復(fù)制代碼
這樣第一個(gè) library 就可以編譯成功了蹬昌。
3. 從 Hugo 項(xiàng)目中 copy hugo-runtime 到新項(xiàng)目中，修改 build.gradle 如下：
在 apply plugin 前加入如下代碼攀隔，不然 import 導(dǎo)包找不到文件
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.aspectj:aspectjtools:1.9.6'
classpath 'org.aspectj:aspectjweaver:1.9.6'
}
}
去掉以下插件引用皂贩，因?yàn)槲覀儾⒉皇褂眠@個(gè)插件上傳倉(cāng)庫(kù)
apply plugin: 'com.github.dcendents.android-maven'
整個(gè) build.gradle 文件如下
import org.aspectj.bridge.IMessage
import org.aspectj.bridge.MessageHandler
import org.aspectj.tools.ajc.Main
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.aspectj:aspectjtools:1.9.6'
classpath 'org.aspectj:aspectjweaver:1.9.6'
}
}
apply plugin: 'com.android.library'
dependencies {
implementation 'org.aspectj:aspectjweaver:1.9.6'
implementation project(':hugo-annotations')
testImplementation 'junit:junit:4.13.2'
}
android {
compileSdkVersion 32
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
android.libraryVariants.all { variant ->
JavaCompile javaCompile = variant.javaCompile
javaCompile.doLast {
String[] args = [
"-showWeaveInfo",
"-1.5",
"-inpath", javaCompile.destinationDir.toString(),
"-aspectpath", javaCompile.classpath.asPath,
"-d", javaCompile.destinationDir.toString(),
"-classpath", javaCompile.classpath.asPath,
"-bootclasspath", android.bootClasspath.join(File.pathSeparator)
]
MessageHandler handler = new MessageHandler(true);
new Main().run(args, handler)
def log = project.logger
for (IMessage message : handler.getMessages(null, true)) {
switch (message.getKind()) {
case IMessage.ABORT:
case IMessage.ERROR:
case IMessage.FAIL:
log.error message.message, message.thrown
break;
case IMessage.WARNING:
case IMessage.INFO:
log.info message.message, message.thrown
break;
case IMessage.DEBUG:
log.debug message.message, message.thrown
break;
}
}
}
}
這樣插樁的 Library 也編譯成功了。接下來(lái)最后一步就是生成 gradle 插件了昆汹。
4. 從 Hugo 項(xiàng)目中 copy hugo-plugin 到新項(xiàng)目中明刷，修改 build.gradle 如下：
apply plugin: 'groovy'
targetCompatibility = JavaVersion.VERSION_1_8
sourceCompatibility = JavaVersion.VERSION_1_8
dependencies {
implementation gradleApi()
implementation localGroovy()
implementation 'com.android.tools.build:gradle:7.2.2' // gradle 相關(guān) api
implementation 'org.aspectj:aspectjtools:1.9.6'
implementation 'org.aspectj:aspectjrt:1.9.6'
}
如果 gradle 文件找不到，看下自己的 gradle 版本满粗，我當(dāng)前的是
distributionUrl=https://services.gradle.org/distributions/gradle-7.3.3-bin.zip
5. 修改 HugoPlugin 文件
Hugo項(xiàng)目編譯不過(guò)就是因?yàn)樵?HugoPlugin 文件中使用了廢棄的 debugCompile辈末。
project.dependencies {
debugCompile 'com.jakewharton.hugo:hugo-runtime:1.2.2-SNAPSHOT'
// TODO this should come transitively
debugCompile 'org.aspectj:aspectjrt:1.8.6'
compile 'com.jakewharton.hugo:hugo-annotations:1.2.2-SNAPSHOT'
}
因此把這部分代碼改成如下
project.dependencies {
debugImplementation 'com.jakewharton.hugo:hugo-runtime:1.2.1'
// TODO this should come transitively
debugImplementation 'org.aspectj:aspectjrt:1.8.6'
implementation 'com.jakewharton.hugo:hugo-annotations:1.2.1'
}
6. 生成本地插件
在 hugo-plugin 的 build.gradle 中添加 Java Gradle Plugin 插件及 publish 插件
apply plugin: 'java-gradle-plugin' // Java Gradle Plugin
apply plugin: 'maven-publish'
gradlePlugin {
plugins {
Plugin {
id = 'com.example.plugin' // apply 的時(shí)候使用的
implementationClass = 'hugo.weaving.plugin.HugoPlugin' // 具體的實(shí)現(xiàn)類
}
}
}
group = 'com.example.plugin'
version = '0.0.1'
publishing {
repositories {
// 本地路徑
maven {
url = uri('../localMavenRepository/snapshot')
}
}
}
然后點(diǎn)擊右側(cè)的 gradle，點(diǎn)擊 publish
會(huì)在左側(cè)生成 localMavenRepository/snapshot 文件夾
綠框就是我們要使用的插件映皆。
使用
在項(xiàng)目的 setting.gradle 中添加
pluginManagement {
repositories {
gradlePluginPortal()
google()
mavenCentral()
// 本地倉(cāng)庫(kù)名
maven {
url "$rootDir/localMavenRepository/snapshot"
}
}
}
在項(xiàng)目的 build.gradle 中添加
buildscript {
dependencies {
classpath 'com.example.plugin:hugo-plugin:0.0.1'
}
}
在 app 的 build.gradle 中添加
plugins {
id 'com.example.plugin'
}
最后在代碼中驗(yàn)證
@DebugLog
private void sleep() {
try {
Thread.sleep(200);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
log 如下
V/MainActivity: ? sleep()
V/MainActivity: ? sleep [200ms]
總結(jié)
到目前為止就實(shí)現(xiàn)了一個(gè)本地的 gradle 插件挤聘。目前存在的問(wèn)題是，HugoPlugin 文件中引用的都是遠(yuǎn)程的代碼捅彻，即
project.dependencies {
debugImplementation 'com.jakewharton.hugo:hugo-runtime:1.2.1'
// TODO this should come transitively
debugImplementation 'org.aspectj:aspectjrt:1.8.6'
implementation 'com.jakewharton.hugo:hugo-annotations:1.2.1'
}
因此我們改動(dòng)這兩個(gè) module 并沒(méi)有什么用组去。解決辦法是上傳這兩個(gè) module，然后在 HugoPlugin 中引用我們上傳的 module步淹。完成這一步也就可以完成 gradle 插件上傳遠(yuǎn)端了从隆。
