gradle 插件 + asm 字节码基础讲完了,我们就要开始实战环节了,这次我们来做一个图片加载监控,本文虽然只讲一个实例,但是很多场景以及很多开源框架都会用到 Gradle 插件 + ASM 技术,比如像方法耗时监控、代码覆盖率统计、自动埋点等等,因此大家一定要熟练掌握这套基础知识,开发过程中会带来很多意想不到的效果。
1. 需求背景
图片加载是我们开发过程中最常见不过的一个场景,但很少有同学会主动去监测其合法性,比如我们加载一张图片可能会有好几M ,比如我们设置一张图片的背景大小可能是 720*1080 而我们实际的 View 控件却只有 100dp*100dp ,再比如我们 bugly 上也会有大量图片引起的 OOM 等等。我们平时一般都是用的 glide 、Picasso 或者 Fresco ,可能觉得第三方库一般不会有问题吧?又或是我写代码的时候都会考虑这些的,而且我们有代码 review 机制等等。但其实还是会有意外的情况,只有机器一般不会骗人才能保证不会出差错。因此我们本次的需求就是监控一些异常的图片操作,像我刚刚所提到的这些情况。
2. 实现方案
实现的方式有很多种,目前我所了解的有 artHook、asm 插装、native hook,首先 artHook 兼容性不是很好我们就先放弃,其次 native hook 我们目前还没涉及这个到后面再说,因此我们本次主要采用 asm 插装。业界的开源方案像滴滴的 Dokit 就是采用的 asm 插装方式来实现的,不过实现的思路是对四种主流的框架进行插装,分别是 Glide 、Picasso、Fresco 和 Image Loader 。上期就说过插桩肯定需要寻找 hook 点,那就意味着如果要自己实现一套,必须要对这四个开源框架的源码比较熟悉。当然我相信大家目前去熟悉几个框架源码应该是小菜一碟,但公司一般都有自己的一套图片加载库,也有可能是基于这些开源框架改过源码,因此我们得想一种更通用简单的实现方式。当然滴滴的这种实现方案也有一个好处,比如能获取到图片的加载地址等等。如果大家符合以上要求,直接将 Dokit 集成到项目中就好。
那有没有一种方式可以不用做各种适配?答案肯定是有的,就看我们愿不愿意去折腾去改变了。 native hook 我们还没讲,所以我目前能想到的就是 hook 住 ImageView 的 setImageBitmap 、setImageDrawable 等等相关函数,因为我们无论是本地直接加载,还是用第三方开源框架,最终都会调到这些函数里面来。但问题是我们之前也分析过 asm 的实现原理,直接是做不到的,因此我们得想办法解决这个问题。我们先自定义一个 ImageView 然后继承自系统的ImageView,再复写我刚刚所说的几个方法,最后我们用自定义的插件,把源码中所有的 ImageView 都替换成我们自定义的 ImageView 。这样一来插件代码会变得异常简单,其次也可以做到通用。
3. 核心代码
// ImageView 部分
@Override
public void setImageDrawable(@Nullable Drawable drawable) {
super.setImageDrawable(drawable);
addImageLegalMonitor();
}
@Override
public void setImageBitmap(Bitmap bm) {
super.setImageBitmap(bm);
addImageLegalMonitor();
}
@Override
public void setImageResource(int resId) {
super.setImageResource(resId);
addImageLegalMonitor();
}
// View 的部分
@Override
public void setBackgroundDrawable(Drawable background) {
super.setBackgroundDrawable(background);
addImageLegalMonitor();
}
@Override
public void setBackground(Drawable background) {
super.setBackground(background);
addImageLegalMonitor();
}
@Override
public void setBackgroundResource(int resid) {
super.setBackgroundResource(resid);
addImageLegalMonitor();
}
/**
* 添加图片合法监控
*/
private void addImageLegalMonitor() {
Looper.myQueue().removeIdleHandler(this);
Looper.myQueue().addIdleHandler(this);
}
@Override
public boolean queueIdle() {
try {
Drawable drawable = getDrawable();
Drawable background = getBackground();
if (drawable != null) {
checkIsLegal(drawable, "图片");
}
if (background != null) {
checkIsLegal(background, "背景");
}
} catch (Exception e) {
e.printStackTrace();
}
return false;
}
/**
* 检查是否合法
*/
private void checkIsLegal(Drawable drawable, String tag) {
int viewWidth = getMeasuredWidth();
int viewHeight = getMeasuredHeight();
int drawableWidth = drawable.getIntrinsicWidth();
int drawableHeight = drawable.getIntrinsicHeight();
// 大小告警判断
int imageSize = calculateImageSize(drawable);
if (imageSize > MAX_ALARM_IMAGE_SIZE) {
Log.e(TAG, "图片加载不合法," + tag + "大小 -> " + imageSize);
dealWarning(drawableWidth, drawableHeight, imageSize, drawable);
}
// 宽高告警判断
if (MAX_ALARM_MULTIPLE * viewWidth < drawableWidth) {
Log.e(TAG, "图片加载不合法, 控件宽度 -> " + viewWidth + " , " + tag + "宽度 -> " + drawableWidth);
dealWarning(drawableWidth, drawableHeight, imageSize, drawable);
}
if (MAX_ALARM_MULTIPLE * viewHeight < drawableHeight) {
Log.e(TAG, "图片加载不合法, 控件高度 -> " + viewHeight + " , " + tag + "高度 -> " + drawableHeight);
dealWarning(drawableWidth, drawableHeight, imageSize, drawable);
}
}
/**
* 处理警告
*/
private void dealWarning(int drawableWidth, int drawableHeight, int imageSize, Drawable drawable) {
// 线上线下处理方式需要不一致,伪代码
// 线上弹出提示窗口把信息输出,同时提供一个关闭打开开关
// ......
// 线下需要搜集代码信息,代码具体在哪里,把信息上报到服务器
// ......
}
/**
* 计算 drawable 的大小
*/
private int calculateImageSize(Drawable drawable) {
if (drawable instanceof BitmapDrawable) {
Bitmap bitmap = ((BitmapDrawable) drawable).getBitmap();
return bitmap.getByteCount();
}
int pixelSize = drawable.getOpacity() != PixelFormat.OPAQUE ? 4 : 2;
return pixelSize * drawable.getIntrinsicWidth() * drawable.getIntrinsicHeight();
}
插件代码
public class MonitorImageViewClassVisitor extends ClassVisitor {
private static final String MONITOR_SUPER_CLASS_NAME = "com/tencent/eagle/MonitorImageView";
private static final String IMAGE_VIEW_CLASS_NAME = "android/widget/ImageView";
LifecycleClassVisitor(ClassVisitor cv) {
super(Opcodes.ASM5, cv);
}
@Override
public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
// 替换操作
if (!name.equals(MONITOR_SUPER_CLASS_NAME) && superName.equals(IMAGE_VIEW_CLASS_NAME)) {
superName = MONITOR_SUPER_CLASS_NAME;
}
super.visit(version, access, name, signature, superName, interfaces);
}
}
4. 写在最后
并不是倡导大家都要自己实现一套,但是了解实现原理,发现改进一些已有的不足,能根据自己项目量身实现定制,这应该是我们必备的技能。哪怕大家只是直接把 Dokit 这套方案集成到项目中,那么本文的目的也就达到了。
以前在讲 framework 原理和 C++ 与 Linux 的时候,大家可能会觉得这么高级的东西,中小型企业根本很难用上,但现在到了性能优化我想大家应该都能用上,只要我们花一丁点时间集成到项目中,就能发现各种各样的问题。