AndroidHook機制——入侵監聽器ClickListener

背景

需求如下，在不侵入業務代碼的情況下監聽所有的點擊事件，並記錄所有的點擊數，用於統計熱點頁面和其他一些分析工作。仔細分析了下，主要涉及到2個問題：

• 如何獲取所有的帶點擊事件的View對象
• 不改動原來的業務代碼，但是在原來點擊事件的業務邏輯中加入新的邏輯，如點擊數上傳等

最大的難點是怎麼在不改變onclickListener->onclick(){}內部的代碼塊的同時，又能插入一段新的邏輯。畢竟不能把老的監聽器一個個找出來去加，不僅可能會漏掉而且會。。。瘋掉。。。

先說解決方案

面對這個問題，我想肯定會有童鞋跟我遇到類似的問題。對於類似的問題，可以抽象出來統一解決，所以我擼了個庫。當然本文的精髓不是怎麼使用這個庫，而是後面原理分析的部分，也就是解決這個問題的過程。源碼的github地址如下

https://github.com/wolearn/HookListenerSimple/tree/master

本來想放到jcenter上浪一下，可惜目前還沒上傳成功。

但是我還是準備了arr包，包含一下也很方便。如果要修改源碼就用module的方式引入吧。庫不大就20K多一點，引入隨意。

用法

具體看你想在單個Activity中使用，建議在如下函數中添加

    @Override
    public void onWindowFocusChanged(boolean hasFocus) {
        super.onWindowFocusChanged(hasFocus);

        ListenerManager.Builer builer = new ListenerManager.Builer();
        builer.buildOnClickListener(new HookListenerContract.OnClickListener() {
            @Override
            public void doInListener(View v) {
                Toast.makeText(BaseActivity.this, "單擊時我執行", Toast.LENGTH_SHORT).show();
            }
        }).buildOnLongClickListener(new HookListenerContract.OnLongClickListener() {
            @Override
            public void doInListener(View v) {
                Toast.makeText(BaseActivity.this, "長按時我執行", Toast.LENGTH_SHORT).show();
            }
        }).buildOnFocusChangeListener(new HookListenerContract.OnFocusChangeListener() {
            @Override
            public void doInListener(View v, boolean hasFocus) {
                Toast.makeText(BaseActivity.this, "焦點變化時我執行", Toast.LENGTH_SHORT).show();
            }
        });
        HookCore.getInstance().startHook(this, ListenerManager.create(builer));
    }

• 可以實現點擊，長按，焦點三種事件，按照自己的需求build。
• 理論上是可以實現所有的監聽器的，各位可以自己擴展。
• doInListener中的代碼會在監聽器觸發的時候執行，如果你想在服務端記錄這次行爲，可以在這裏執行。
• 如果想實現所有Activity，可以把上面的代碼寫在BaseActivity中。也可以參考源碼中的例子。

原理分析

這裏面主要涉及三個方面的知識點

• 靜態代理
• 反射
• 怎麼Hook

1. 靜態代理

我理解的代理就是，代理具備被代理對象的所有能力，並且可以在該能力執行的時候添油加醋。

用程序的語言來說就是，代理對象持有了被代理對象的引用，當被代理方法執行的時候，在執行的前後添加一些邏輯或是修改返回的結果。

舉個簡單的例子如下。先抽象個簡單的狗。

public interface IDog {
    void eat();
    void drink();
}

創建一個具體的黑色狗狗

public class BlackDog implements IDog{
    @Override
    public void eat() {
        Log.i("BlackDog", "----  eat  -----");
    }

    @Override
    public void drink() {
        Log.i("BlackDog", "----  drink  -----");
    }
}

最重要的代理黑狗

public class DogProxy implements IDog{
    private BlackDog mBlackDog;

    public DogProxy(BlackDog blackDog){
        this.mBlackDog = blackDog;
    }

    @Override
    public void eat() {
        Log.i("","----  在吃之前先撒個歡  -----");
        mBlackDog.eat();
    }

    @Override
    public void drink() {
        mBlackDog.drink();
        Log.i("","----  在喝之後撒個歡  -----");
    }
}

發現所有黑狗會的技能，代理狗都會，而且還做的一樣好，甚至在吃喝之前還撒個歡，有了自己的個性。更多設計模式相關的知識，可以參考我的白話設計模式六大原則。

2. 反射

這裏面涉及到幾個的反射方法

Class.forName()

通過類名獲取Class對象。

setAccessible()

改變訪問對象的可見性，常常用來訪問private屬性的對象。

invoke(Object receiver, Object... args)

通過對象和參數列表執行方法。

get(Object object)

獲取Feild的值。

3. 怎麼Hook

先理清Hook是什麼？翻譯過來是鉤子。

我的理解是一些已有的API不能滿足新的需求，可以通過Hook來改變其功能，或在原API前後插入新的代碼，或改變其返回值，或乾脆覆蓋掉原來的代碼，來實現新的需求。

結合文章前面的需求，我們要做的就是在Android源碼調用監聽器的邏輯中加入一段自己的代碼，來統一監聽監聽器的執行。通過閱讀View的源碼發現一個很有用的方法

    ListenerInfo getListenerInfo() {
        if (mListenerInfo != null) {
            return mListenerInfo;
        }
        mListenerInfo = new ListenerInfo();
        return mListenerInfo;
    }

所有監聽器的對象都是保存在ListenerInfo類型的對象中

static class ListenerInfo {
        protected OnFocusChangeListener mOnFocusChangeListener;
        private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
        protected OnScrollChangeListener mOnScrollChangeListener;
        private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
        public OnClickListener mOnClickListener;
        protected OnLongClickListener mOnLongClickListener;
        protected OnContextClickListener mOnContextClickListener;
        protected OnCreateContextMenuListener mOnCreateContextMenuListener;
        private OnKeyListener mOnKeyListener;
        private OnTouchListener mOnTouchListener;
        private OnHoverListener mOnHoverListener;
        private OnGenericMotionListener mOnGenericMotionListener;
        private OnDragListener mOnDragListener;
        private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
        OnApplyWindowInsetsListener mOnApplyWindowInsetsListener;
    }

接下來的事情就簡單了，執行getListenerInfo()方法獲取mListenerInfo對象，然後用靜態代理對象替換掉mListenerInfo的各種監聽器的成員變量，在我們自己的代理對象中我們就可以爲所欲爲了。比如OnclickListener的代理對象

public class OnClickListenerProxy implements View.OnClickListener{
    private View.OnClickListener object;
    private HookListenerContract.OnClickListener mlistener;

    public OnClickListenerProxy(View.OnClickListener object, HookListenerContract.OnClickListener listener){
        this.object = object;
        this.mlistener = listener;
    }

    @Override
    public void onClick(View v) {
        if(mlistener != null) mlistener.doInListener(v);
        if(object != null) object.onClick(v);
    }
}

mlistener是我們要插入邏輯的承載對象。其他監聽器的代理實現類似。接下來只要把原來的監聽器對象換成代理對象即可。替換過程如下。

 mClassView = Class.forName("android.view.View");
 Method method = mClassView.getDeclaredMethod("getListenerInfo");
 method.setAccessible(true);
 Object listenerInfoObject = method.invoke(view);

 Class mClassListenerInfo = Class.forName("android.view.View$ListenerInfo");

 Field feildOnClickListener = mClassListenerInfo.getDeclaredField("mOnClickListener");
 feildOnClickListener.setAccessible(true);
 View.OnClickListener mOnClickListenerObject = (View.OnClickListener) feildOnClickListener.get(listenerInfoObject);

View.OnClickListener onClickListenerProxy = new OnClickListenerProxy(mOnClickListenerObject, mListenerManager.mOnClickListener);

feildOnClickListener.set(listenerInfoObject, onClickListenerProxy);

hook監聽器的過程就完成了，HookListenerContract.OnClickListener()->doInListener(View v)中的方法或隨着監聽器的觸發執行。其他的監聽器類似。