Gradle 外掛 + ASM 實戰 - 監控圖片載入告警
技術標籤:java程式語言python人工智慧android
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 的時候,大家可能會覺得這麼高階的東西,中小型企業根本很難用上,但現在到了效能優化我想大家應該都能用上,只要我們花一丁點時間整合到專案中,就能發現各種各樣的問題。
作者:紅橙Darren
連結:https://www.jianshu.com/p/206d00dfd683
關注我獲取更多知識或者投稿