前言
做項目優(yōu)化時,我們通常會先打印出方法的執(zhí)行時間,再根據方法的耗時情況對其進行優(yōu)化。代碼如下:
public static void main(String[] args) {
long startTime = System.currentTimeMillis();
//...
long endTime = System.currentTimeMillis();
System.out.println("程序運行時間: " + (endTime - startTime) + "ms");
}
如果是一兩個方法我們手動插入代碼沒有問題,但是整個項目的方法何其多,都要我們手動去插入的話,估計能把C、V兩鍵扣廢掉。那么有沒有一種優(yōu)雅的方式實現耗時打印呢?當然有的,這就是今天要介紹的主角 ASM (字節(jié)碼插樁)。
有同學到這里可能就會問,我不會寫ASM代碼該怎么辦呢?
悄悄的跟你說,其實我也不會寫ASM代碼。
那這會影響到我們的開發(fā)嗎?
當然不會了,如果有影響就不會有這篇文章了。
ASM Bytecode Viewer
ASM Bytecode Viewer是一款能 查看字節(jié)碼 和 生成ASM代碼 的插件,是幫助我們學習ASM的利器,剩下就是對ASM的熟悉和使用可以說是so easy。
- 在Android Studio中搜索 ASM Bytecode Viewer Support Kotlin 找到并安裝。
- 代碼右鍵 ASM Bytecode Viewer 便能自動生成ASM插樁代碼。
ASM 和 ASM Bytecode Viewer 我在之前的文章 最通俗易懂的字節(jié)碼插樁實戰(zhàn)(Gradle + ASM)—— 自動埋點 已經介紹過了,有不了解的同學可以翻看一下。具體使用方法我會在后面的編碼階段詳細介紹。
實戰(zhàn)
至此我們已經做了大量的準備工作,現在就正式進入實戰(zhàn)環(huán)節(jié)。
首先創(chuàng)建一個module作為插件開發(fā),再刪除掉多余的文件,然后創(chuàng)建groovy目錄供代碼編寫……
PS:由于gradle插件開發(fā)并不是我們今天的任務,這里就不過多的展開說明了,具體代碼可在 github 上查看,module目錄結構如下:
1、StatisticPlugin
我們本次編寫的插件,在apply 方法的注冊 MethodTimerTransform,并讀取 build.gradle 里面配置信息。
class StatisticPlugin implements Plugin<Project> {
public static List<MethodTimerEntity> METHOD_TIMER_LIST
@Override
void apply(Project project) {
def android = project.extensions.findByType(AppExtension)
// 注冊Transform
android.registerTransform(new MethodTimerTransform())
// 獲取gradle里面配置的埋點信息
def statisticExtension = project.extensions.create('statistic', StatisticExtension)
project.afterEvaluate {
// 獲取方法計時信息,將其保存在METHOD_TIMER_LIST方便調用
METHOD_TIMER_LIST = new ArrayList<>()
def methodTimer = statisticExtension.getMethodTimer()
if (methodTimer != null) {
methodTimer.each { Map<String, Object> map ->
MethodTimerEntity entity = new MethodTimerEntity()
if (map.containsKey("time")) {
entity.time = map.get("time")
}
if (map.containsKey("owner")) {
entity.owner = map.get("owner")
}
METHOD_TIMER_LIST.add(entity)
}
}
}
}
}
2、MethodTimerTransform
通過transform 方法的 Collection<TransformInput> inputs 對 .class文件遍歷拿到所有方法。
class MethodTimerTransform extends Transform {
...省略中間非關鍵代碼,詳細請到github中查看...
/**
*
* @param context
* @param inputs 有兩種類型,一種是目錄,一種是 jar 包,要分開遍歷
* @param outputProvider 輸出路徑
*/
@Override
void transform(
@NonNull Context context,
@NonNull Collection<TransformInput> inputs,
@NonNull Collection<TransformInput> referencedInputs,
@Nullable TransformOutputProvider outputProvider,
boolean isIncremental
) throws IOException, TransformException, InterruptedException {
if (!incremental) {
//不是增量更新刪除所有的outputProvider
outputProvider.deleteAll()
}
inputs.each { TransformInput input ->
//遍歷目錄
input.directoryInputs.each { DirectoryInput directoryInput ->
handleDirectoryInput(directoryInput, outputProvider)
}
// 遍歷jar 第三方引入的 class
input.jarInputs.each { JarInput jarInput ->
handleJarInput(jarInput, outputProvider)
}
}
}
}
3、MethodTimerClassVisitor
通過visitMethod拿到方法進行修改。
class MethodTimerClassVisitor extends ClassVisitor {
...省略中間非關鍵代碼,詳細請到github中查看...
/**
* 掃描類的方法進行調用
* @param access 修飾符
* @param name 方法名字
* @param descriptor 方法簽名
* @param signature 泛型信息
* @param exceptions 拋出的異常
* @return
*/
@Override
MethodVisitor visitMethod(int methodAccess, String methodName, String methodDescriptor, String signature, String[] exceptions) {
MethodVisitor methodVisitor = super.visitMethod(methodAccess, methodName, methodDescriptor, signature, exceptions)
if ((methodAccess & Opcodes.ACC_INTERFACE) == 0 && "<init>" != methodName && "<clinit>" != methodName) {
methodVisitor = new MethodTimerAdviceAdapter(api, methodVisitor, methodAccess, methodName, methodDescriptor)
}
return methodVisitor
}
}
4、MethodTimerAdviceAdapter
這里就是我們插入打印方法耗時的地方了,可以看到代碼沒有很多。
-
onMethodEnter在方法進入時調用,我們先在這里插入一個時間戳,標記方法開始的時間。 -
onMethodExit在方法退出前調用,這里我們也插入一個時間戳,標記方法結束的時間。最后把兩個時間戳相減得到方法耗時時間并打印。
聽完解釋后是不是覺得非常簡單呢。
大家最關心的編(sheng)寫(cheng)ASM代碼,今天它來了。
- 首先我們創(chuàng)建一個Test類,先用java代碼來實現我們的需求,代碼如下:
public class Test {
public static void main(String[] args) {
long startTime = System.currentTimeMillis();
String str = "--- I'm the code line ---";
long endTime = System.currentTimeMillis();
long time = endTime - startTime;
if(time > 500){
System.out.println("程序運行時間: " + time + "ms");
}
}
}
細心的同學會發(fā)現代碼中有一段分割線字符串 String str = "--- I'm the code line ---";
前面說過方法進入時和方法退出前分別是 onMethodEnter 和 onMethodExit,因此我們通過分割線字符串來判斷代碼插入的時機。
分割線字符之前的代碼在 onMethodEnter 插入,分割線字符之后的代碼在onMethodExit插入。
- 代碼右鍵 ASM Bytecode Viewer 自動生成ASM插樁代碼,生成代碼如下:
{
methodVisitor = classWriter.visitMethod(ACC_PUBLIC | ACC_STATIC, "main", "([Ljava/lang/String;)V", null, null);
methodVisitor.visitParameter("args", 0);
methodVisitor.visitCode();
methodVisitor.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
methodVisitor.visitVarInsn(LSTORE, 1);
methodVisitor.visitLdcInsn("--- I'm the code line ---");
methodVisitor.visitVarInsn(ASTORE, 3);
methodVisitor.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
methodVisitor.visitVarInsn(LSTORE, 4);
methodVisitor.visitVarInsn(LLOAD, 4);
methodVisitor.visitVarInsn(LLOAD, 1);
methodVisitor.visitInsn(LSUB);
methodVisitor.visitVarInsn(LSTORE, 6);
methodVisitor.visitVarInsn(LLOAD, 6);
methodVisitor.visitLdcInsn(new Long(500L));
methodVisitor.visitInsn(LCMP);
Label label0 = new Label();
methodVisitor.visitJumpInsn(IFLE, label0);
methodVisitor.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
methodVisitor.visitTypeInsn(NEW, "java/lang/StringBuilder");
methodVisitor.visitInsn(DUP);
methodVisitor.visitMethodInsn(INVOKESPECIAL, "java/lang/StringBuilder", "<init>", "()V", false);
methodVisitor.visitLdcInsn("\u7a0b\u5e8f\u8fd0\u884c\u65f6\u95f4\uff1a ");
methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false);
methodVisitor.visitVarInsn(LLOAD, 6);
methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(J)Ljava/lang/StringBuilder;", false);
methodVisitor.visitLdcInsn("ms");
methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false);
methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "toString", "()Ljava/lang/String;", false);
methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
methodVisitor.visitLabel(label0);
methodVisitor.visitInsn(RETURN);
methodVisitor.visitMaxs(4, 8);
methodVisitor.visitEnd();
}
我們把 methodVisitor.visitCode(); 之后 methodVisitor.visitLdcInsn("--- I'm the code line ---"); 之前的代碼插入到 onMethodEnter 。把 methodVisitor.visitLdcInsn("--- I'm the code line ---"); 之后 methodVisitor.visitInsn(RETURN); 之前的代碼插入到 onMethodExit 。
最終的 MethodTimerAdviceAdapter 代碼如下:
class MethodTimerAdviceAdapter extends AdviceAdapter {
int slotIndex
...省略中間非關鍵代碼,詳細請到github中查看...
@Override
protected void onMethodEnter() {
super.onMethodEnter()
for (MethodTimerEntity entity : StatisticPlugin.METHOD_TIMER_LIST) {
if (methodOwner.contains(entity.getOwner())) {
slotIndex = newLocal(Type.LONG_TYPE)
mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false)
mv.visitVarInsn(LSTORE, slotIndex)
}
}
}
@Override
void onMethodExit(int opcode) {
for (MethodTimerEntity entity : StatisticPlugin.METHOD_TIMER_LIST) {
if (methodOwner.contains(entity.getOwner())) {
mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false)
mv.visitVarInsn(LLOAD, slotIndex)
mv.visitInsn(LSUB)
mv.visitVarInsn(LSTORE, slotIndex)
mv.visitVarInsn(LLOAD, slotIndex)
mv.visitLdcInsn(new Long(entity.getTime()))
mv.visitInsn(LCMP)
Label label0 = new Label()
mv.visitJumpInsn(IFLE, label0)
mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;")
mv.visitTypeInsn(NEW, "java/lang/StringBuilder")
mv.visitInsn(DUP)
mv.visitMethodInsn(INVOKESPECIAL, "java/lang/StringBuilder", "<init>", "()V", false)
mv.visitLdcInsn(methodOwner + "/" + methodName + " --> execution time : (")
mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false)
mv.visitVarInsn(LLOAD, slotIndex)
mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(J)Ljava/lang/StringBuilder;", false)
mv.visitLdcInsn("ms)")
mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false)
mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "toString", "()Ljava/lang/String;", false)
mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false)
mv.visitLabel(label0)
}
}
super.onMethodExit(opcode)
}
}
---這里畫個重點---
局部變量表(Local Variable Table) 是一組變量值存儲空間,用于存放方法參數和方法內定義的局部變量。具體的順序是 this-方法接收的參數-方法內定義的局部變量 。而我們通過 ASM Bytecode Viewer 生成的ASM代碼是1,2,3按順序寫死的,所以我們通過 newLocal(type) 來重新獲取壓入的位置 slotIndex 把參數壓入到局部變量表中。
5、 如何使用?
5.1、 先打包插件到本地倉庫進行引用

5.2、 在項目的根build.gradle加入插件的依賴
repositories {
google()
mavenCentral()
jcenter()
maven{
url uri('repos')
}
}
dependencies {
classpath "com.android.tools.build:gradle:$gradle_version"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath 'com.meituan.android.walle:plugin:1.1.7'
// 使用自定義插件
classpath 'com.example.plugin:statistic:1.0.0'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
5.3、 在app的build.gradle中使用并配置參數
plugins {
id 'com.android.application'
id 'statistic'
}
statistic {
methodTimer = [
[
// 打印大于time的方法
'time' : 500L,
// 需要打印方法的范圍
'owner': 'com/example/fragment',
],
[
'time' : 5000L,
'owner': 'com/google',
]
]
}
6、 運行項目查看輸出日志
2021-07-20 11:31:51.915 12028-12060/com.example.fragment.project.debug I/System.out: com/example/fragment/library/base/http/SimpleHttp$get$2/invokeSuspend --> execution time : (2066ms)
2021-07-20 11:31:52.565 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/library/common/utils/WanHelper/setTreeList --> execution time : (1184ms)
2021-07-20 11:31:52.565 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/project/model/MainViewModel$getTree$1/invokeSuspend --> execution time : (1184ms)
2021-07-20 11:31:53.768 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/library/common/utils/WanHelper/setTreeList --> execution time : (1186ms)
2021-07-20 11:31:53.768 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/module/system/model/SystemViewModel$getTree$1/invokeSuspend --> execution time : (1186ms)
Thanks
以上就是本篇文章的全部內容,如有問題歡迎指出,我們一起進步。
如果喜歡的話希望點個贊吧,您的鼓勵是我前進的動力。
謝謝~~
項目地址
- github: https://github.com/miaowmiaow