Gradle 插件 + ASM 實戰(zhàn) - 監(jiān)控圖片加載告警

gradle 插件 + asm 字節(jié)碼基礎(chǔ)講完了,我們就要開始實戰(zhàn)環(huán)節(jié)了,這次我們來做一個圖片加載監(jiān)控,本文雖然只講一個實例,但是很多場景以及很多開源框架都會用到 Gradle 插件 + ASM 技術(shù),比如像方法耗時監(jiān)控、代碼覆蓋率統(tǒng)計、自動埋點等等,因此大家一定要熟練掌握這套基礎(chǔ)知識,開發(fā)過程中會帶來很多意想不到的效果。

1. 需求背景

圖片加載是我們開發(fā)過程中最常見不過的一個場景,但很少有同學會主動去監(jiān)測其合法性,比如我們加載一張圖片可能會有好幾M ,比如我們設(shè)置一張圖片的背景大小可能是 720*1080 而我們實際的 View 控件卻只有 100dp*100dp ,再比如我們 bugly 上也會有大量圖片引起的 OOM 等等。我們平時一般都是用的 glide 、Picasso 或者 Fresco ,可能覺得第三方庫一般不會有問題吧?又或是我寫代碼的時候都會考慮這些的,而且我們有代碼 review 機制等等。但其實還是會有意外的情況,只有機器一般不會騙人才能保證不會出差錯。因此我們本次的需求就是監(jiān)控一些異常的圖片操作,像我剛剛所提到的這些情況。

2. 實現(xiàn)方案

實現(xiàn)的方式有很多種,目前我所了解的有 artHook、asm 插裝、native hook,首先 artHook 兼容性不是很好我們就先放棄,其次 native hook 我們目前還沒涉及這個到后面再說,因此我們本次主要采用 asm 插裝。業(yè)界的開源方案像滴滴的 Dokit 就是采用的 asm 插裝方式來實現(xiàn)的,不過實現(xiàn)的思路是對四種主流的框架進行插裝,分別是 Glide 、Picasso、Fresco 和 Image Loader 。上期就說過插樁肯定需要尋找 hook 點,那就意味著如果要自己實現(xiàn)一套,必須要對這四個開源框架的源碼比較熟悉。當然我相信大家目前去熟悉幾個框架源碼應(yīng)該是小菜一碟,但公司一般都有自己的一套圖片加載庫,也有可能是基于這些開源框架改過源碼,因此我們得想一種更通用簡單的實現(xiàn)方式。當然滴滴的這種實現(xiàn)方案也有一個好處,比如能獲取到圖片的加載地址等等。如果大家符合以上要求,直接將 Dokit 集成到項目中就好。

那有沒有一種方式可以不用做各種適配?答案肯定是有的,就看我們愿不愿意去折騰去改變了。 native hook 我們還沒講,所以我目前能想到的就是 hook 住 ImageView 的 setImageBitmap 、setImageDrawable 等等相關(guān)函數(shù),因為我們無論是本地直接加載,還是用第三方開源框架,最終都會調(diào)到這些函數(shù)里面來。但問題是我們之前也分析過 asm 的實現(xiàn)原理,直接是做不到的,因此我們得想辦法解決這個問題。我們先自定義一個 ImageView 然后繼承自系統(tǒng)的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();
    }

    /**
     * 添加圖片合法監(jiān)控
     */
    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) {
        // 線上線下處理方式需要不一致,偽代碼
        // 線上彈出提示窗口把信息輸出,同時提供一個關(guān)閉打開開關(guān)
        // ......
        // 線下需要搜集代碼信息,代碼具體在哪里,把信息上報到服務(wù)器
        // ......
    }

    /**
     * 計算 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. 寫在最后

并不是倡導大家都要自己實現(xiàn)一套,但是了解實現(xiàn)原理,發(fā)現(xiàn)改進一些已有的不足,能根據(jù)自己項目量身實現(xiàn)定制,這應(yīng)該是我們必備的技能。哪怕大家只是直接把 Dokit 這套方案集成到項目中,那么本文的目的也就達到了。

以前在講 framework 原理和 C++ 與 Linux 的時候,大家可能會覺得這么高級的東西,中小型企業(yè)根本很難用上,但現(xiàn)在到了性能優(yōu)化我想大家應(yīng)該都能用上,只要我們花一丁點時間集成到項目中,就能發(fā)現(xiàn)各種各樣的問題。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容