探究 | 如何捕獲一個Activity頁面上所有的點擊行為

前言

最近逛wanAndroid論壇，發現一個有趣的問題：如何捕獲一個Activity頁面上所有的點擊行為。

一起研究下吧，不想看源碼的小伙伴可以直接看文末總結～

准備工作

先得羅列出頁面上的一些點擊行為，常用的有：

• 普通View的點擊
• 動態add的View的點擊
• Dialog上的按鈕點擊

於是就有了如下代碼：

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        btn1.setOnClickListener {
            showToast("點了按鈕1")
        }


        btn2.setOnClickListener {
            val builder =
                AlertDialog.Builder(this)
                    .setTitle("我是一個dialog")
            val view: View = layoutInflater.inflate(R.layout.dialog_btn, null)
            val btn4 =
                view.findViewById<View>(R.id.btn4)
            btn4.setOnClickListener {
                showToast("點擊了Dialog按鈕")
            }
            builder.setView(view)
            builder.create().show()
        }


        btn3.setOnClickListener {

            var button = Button(this)
            button.text = "我是新加的按鈕"
            var param = LinearLayout.LayoutParams(
                ViewGroup.LayoutParams.WRAP_CONTENT,
                ViewGroup.LayoutParams.WRAP_CONTENT
            )
            mainlayout.addView(button, param)

            button.setOnClickListener {
                showToast("點擊了新加的按鈕")
            }
        }
    }
}

既然我要捕獲點擊事件，首先就想到的是通過事件分發機制，也就是在源頭就去獲取所有的觸摸事件，然后對點擊事件進行統計，干吧～

事件分發

重寫Activity的dispatchTouchEvent方法，由於只有點擊事件，所以只需要統計ACTION_UP事件即可，如果有長按事件就在需要判斷下按下的時間。

    override fun dispatchTouchEvent(ev: MotionEvent?): Boolean {
        ev?.let {
            when (ev.action) {
                MotionEvent.ACTION_UP -> {
                    Log.e(Companion.TAG,"ACTION_UP——CLICK") 
                }
                else -> {}
            }
        }
        return super.dispatchTouchEvent(ev)
    }

ok，運行下。

• 點擊按鈕1，日志打印正常
• 點擊按鈕2中的dialog按鈕，日志。。。沒有
• 點擊按鈕3中的button，日志打印正常

結果大家也看到了，Dialog中的點擊事件無法被響應，這是為啥呢？

這就要從事件分發機制說起了，點擊屏幕首先響應的是當前屏幕的頂層View，也就是DecorView，在Activity中也就是Window的根布局。然后DecorView會調用Activity的dispatchTouchEvent方法，作為開發者事件分發的一個控制攔截，最后重新返回到DecorView的super.dispatchTouchEvent(event)方法開始ViewGroup的事件傳遞。看看相關源碼：

//DecorView.java
    @Override
    public boolean dispatchTouchEvent(MotionEvent ev) {
        //cb其實就是對應的Activity
        final Window.Callback cb = mWindow.getCallback();
        return cb != null && !mWindow.isDestroyed() && mFeatureId < 0
                ? cb.dispatchTouchEvent(ev) : super.dispatchTouchEvent(ev);
    }


//Activity.java
    public boolean dispatchTouchEvent(MotionEvent ev) {
        if (ev.getAction() == MotionEvent.ACTION_DOWN) {
            onUserInteraction();
        }
        if (getWindow().superDispatchTouchEvent(ev)) {
            return true;
        }
        return onTouchEvent(ev);
    }

//PhoneWindow.java
    @Override
    public boolean superDispatchTouchEvent(MotionEvent event) {
        return mDecor.superDispatchTouchEvent(event);
    }

//DecorView.java
    public boolean superDispatchTouchEvent(MotionEvent event) {
        return super.dispatchTouchEvent(event);
    }    

可以看到事件的開始經歷了DecorView——>Activity——>PhoneWindow——>DecorView——>ViewGroup。

而我們在第二步Acitivity中就無法獲取Dialog的點擊事件了，很明顯是DecorView就沒把事件傳過來，難道Dialog的DecorView和Activity的DecorView不是同一個？

繼續來研究下Dialog這個物種，它和Activity之間可有着不清不楚的關系～

Dialog，Activity扯不斷的關系

這里我們只看兩個方法，一個是Dialog的構造函數，一個是show方法，看看這段三角戀是怎么形成的：

//構造函數
Dialog(Context context, int theme, boolean createContextThemeWrapper) {
        //......
        //獲取了WindowManager對象，mContext一般是個Activity，獲取系統服務一般是通過Binder獲取
        mWindowManager = (WindowManager)context.getSystemService(Context.WINDOW_SERVICE);
        //創建新的Window
        Window w = PolicyManager.makeNewWindow(mContext);
        mWindow = w;
        //這里也是上方mWindow.getCallback()為什么是Activity的原因，在創建新Window的時候會設置callback為自己
        w.setCallback(this);
        w.setOnWindowDismissedCallback(this);
        //關聯WindowManager與新Window，token為null
        w.setWindowManager(mWindowManager, null, null);
        w.setGravity(Gravity.CENTER);
        mListenersHandler = new ListenersHandler(this);
    }



//show方法
    public void show() {
        //......
        if (!mCreated) {
            //回調Dialog的onCreate方法
            dispatchOnCreate(null);
        }
        //回調Dialog的onStart方法
        onStart();
        //獲取當前新Window的DecorView對象
        mDecor = mWindow.getDecorView();
        WindowManager.LayoutParams l = mWindow.getAttributes();
        try {
            //把一個View添加到Activity共用的windowManager里面去
            mWindowManager.addView(mDecor, l);
            //......
        } finally {
        }
    }

可以看到一個Dialog從無到有經歷了以下幾個步驟：

• 首先創建了一個新的Window，類型是PhoneWindow類型，與Activity創建Window過程類似，並設置setCallback回調。
• 將這個新Window與從Activity拿到的WindowManager對象相關聯，也就是dialog與Activity公用了同一個WindowManager對象。
• show方法展示Dialog，先回調了Dialog的onCreate，onStart方法。
• 然后獲取Dialog自己的DecorView對象，並通過addView方法添加到WindowManager對象中，Dialog出現到屏幕上。

分析這個流程我們還可以得知一些平時遇到的小問題，比如為啥Dialog必須要依附於Activity顯示？因為Dialog創建過程中需要使用Activity的Context，即需要使用Activity的token用來創建window。所以傳入Application的Content就會報錯——“Unable to add window -- token null is not for an application”。

回到正題，這個過程用一句話總結就是，Dialog用了Activity的WindowManager對象，並在這之上添加了一個新的Window的DecorView。

因此我們得知，Dialog和Activity但是所處的Window不一樣，也就是所在的父View——DecorView也是不一樣的，所以在Dialog出現之后，點擊屏幕上的按鈕，是從Dialog自己的DecorView開始響應，再回顧下剛才DecorView的代碼：

//DecorView.java
    @Override
    public boolean dispatchTouchEvent(MotionEvent ev) {
        //cb在這里就變成了Dialog
        final Window.Callback cb = mWindow.getCallback();
        return cb != null && !mWindow.isDestroyed() && mFeatureId < 0
                ? cb.dispatchTouchEvent(ev) : super.dispatchTouchEvent(ev);
    }

這時候getCallback的對象變成了Dialog，所以不會回調Activity的dispatchTouchEvent方法，而是走到Dialog的dispatchTouchEvent方法。

這個問題終於搞清楚了，但是我們自己的問題該怎么解決呢？繼續探索～

替換OnClickListener

既然點擊事件都是通過setOnClickListener完成的，那么我們替換這個OnClickListener不就能獲取所有的點擊事件了？

ok，先看看setOnClickListener方法，看看該怎么替換：

//View.java
    ListenerInfo mListenerInfo;

    public void setOnClickListener(@Nullable OnClickListener l) {
        if (!isClickable()) {
            setClickable(true);
        }
        getListenerInfo().mOnClickListener = l;
    }

代碼很簡單，所以我們只需要替換View的getListenerInfo()獲取到的mListenerInfo對象中的mOnClickListener即可。

1）思路有了，先生成我們自己需要替換的OnClickListener：

class MyOnClickListenerer(var onClickListener: View.OnClickListener?) : View.OnClickListener {

    override fun onClick(v: View?) {
        Log.e("lz", "點擊了一個按鈕——$v")
        onClickListener!!.onClick(v)
    }
}

2）然后選擇hook點，我們之前在《線程與更新UI》文章中說過，Activity的DecorView被完整繪制出來是在onResume之后，所以我們就在這里進行hook我們的MyOnClickListenerer：

    override fun onResume() {
        super.onResume()

        var rootView = window.decorView as ViewGroup
        hookAllChildView(rootView)
    }


    private fun hookAllChildView(viewGroup: ViewGroup) {
        val count = viewGroup.childCount
        for (i in 0 until count) {
            if (viewGroup.getChildAt(i) is ViewGroup) {
                hookAllChildView(viewGroup.getChildAt(i) as ViewGroup)
            } else {
                hook(viewGroup.getChildAt(i))
            }
        }
    }

    @SuppressLint("DiscouragedPrivateApi", "PrivateApi")
    private fun hook(view: View) {
        try {
            val getListenerInfo: Method = View::class.java.getDeclaredMethod("getListenerInfo")
            getListenerInfo.isAccessible = true
            //獲取當前View的ListenerInfo對象
            val mListenerInfo: Any = getListenerInfo.invoke(view)
            try {
                val listenerInfoClazz =
                    Class.forName("android.view.View\$ListenerInfo")
                try {
                    //獲取mOnClickListener參數
                    val mOnClickListener: Field =
                        listenerInfoClazz.getDeclaredField("mOnClickListener")
                    mOnClickListener.isAccessible = true
                    var oldListener: View.OnClickListener? =
                        mOnClickListener.get(mListenerInfo) as? View.OnClickListener
                    if (oldListener != null && oldListener !is MyOnClickListenerer) {
                        //替換OnClickListenerer
                        val proxyOnClick =
                            MyOnClickListenerer(oldListener)
                        mOnClickListener.set(mListenerInfo, proxyOnClick)
                    }
                } catch (e: NoSuchFieldException) {
                    e.printStackTrace()
                }
            } catch (e: ClassNotFoundException) {
                e.printStackTrace()
            }
        } catch (e: NoSuchMethodException) {
            e.printStackTrace()
        }
    }

等我滿意的去運行項目的時候，又被無情的現實扇了一巴掌：

• 點擊按鈕1，日志打印正常
• 點擊按鈕2中的dialog按鈕，日志。。。沒有
• 點擊按鈕3中的button，日志。。。沒有

好家伙，結果只有一個按鈕是正常捕獲的。分析下原因吧，為啥Dialog和新加的View都無法捕獲呢？

好好想想我們hook的時機，是在界面上的布局繪制出來之后，但是Dialog和新加的View都是在界面繪制之后再出現的，自然也就沒有hook到。怎么解決呢？

• 新加的View其實還比較好解決，給rootView 添加ViewTreeObserver.OnGlobalLayoutListener監聽即可，當視圖樹的布局發生改變時，就可以被ViewTreeObserver監聽到，然后再hook一次就行了。
• 但是Dialog又不好處理了，還是同樣的問題，不是同一個rootView ，所以需要在Dialog的rootView也要進行一次hook。

4）再次改動

//Dialog增加hook
    var rootView = dialog.window?.decorView as ViewGroup
    hookAllChildView(rootView)

//增加監聽view樹
    rootView.viewTreeObserver.addOnGlobalLayoutListener { hookAllChildView(rootView) }

這下運行確實都能打印出日志了，但是，這也太蠢了點吧。。
特別是Dialog，不可能每個Dialog都去加一遍hook代碼呀。
所以，還需要想想其他的方案。

AspectJ

經過上述問題，我們又想到了一個辦法，同樣是進行代碼埋點，使用AspectJ來解決我們的問題。

AspectJ是一個面向切面編程（AOP）的框架，可以在編譯期將代碼插入到目標切入點中，達到AOP目的。

//AspectJ的配置代碼就不貼了，需要的小伙伴可以看看文末的源代碼鏈接

@Aspect
class ClickAspect {
    @Pointcut("execution(* android.view.View.OnClickListener.onClick(..))")
    fun pointcut() {

    }

    @Around("pointcut()")
    @Throws(Throwable::class)
    fun onClickMethodAround(joinPoint: ProceedingJoinPoint) {
        val args: Array<Any> = joinPoint.args
        var view: View? = null
        for (arg in args) {
            if (arg is View) {
                view = arg
            }
        }
        joinPoint.proceed()
        Log.d("lz", "點擊了一個按鈕: $view")
    }
}

通過找到切點，也就是View中的onClick方法，*表示任意返回值，..表示任意參數，然后在這個切點中獲取view信息，得到點擊事件的反饋。

運行，三種情況都能正常打印日志。
所以這個方法是可行的。

AccessibilityService

到這里，問題也是有解決的辦法了。但是還有沒有其他的方案呢？既然是關於界面反饋類的問題，這里又想到一個方案——無障礙服務AccessibilityService，來試試看。

class ClickAccessibilityService: AccessibilityService() {

    override fun onInterrupt() {
    }

    override fun onAccessibilityEvent(event: AccessibilityEvent?) {
        val eventType = event?.eventType
        val className = event?.className.toString()


        when (eventType) {
            AccessibilityEvent.TYPE_VIEW_CLICKED -> Log.e(TAG,"【無障礙方案】點擊了一個按鈕=$className")
        }
    }

    companion object {
        private const val TAG = "AccessibilityService"
    }

}

//另外還需要在AndroidManifest.xml中配置service以及對應的config文件，具體可見文末源碼，這里就不貼了。

關鍵代碼就這么多，在onAccessibilityEvent回調中，獲取AccessibilityEvent.TYPE_VIEW_CLICKED事件即可，運行，打開我們的無障礙服務。

三種點擊事情的情況都能正常打印日志，搞定。

總結

我們一共試了四種方法：

• 事件分發方案。通過重寫Activity的dispatchTouchEvent方法，對頁面上的點擊事件進行攔截。但是攔截不到Dialog中的點擊事件，因為事件分發由DecorView開始發起，但是Dialog所處的DecorView和Activity的DecorView不是同一個，所以無法在Activitiy的dispatchTouchEvent方法進行攔截Dialog中的點擊事件。
• hook替換OnClickListener方案。這個方案主要是通過替換View中的mOnClickListener為我們自己的OnClickListener，然后進行點擊事件的攔截處理。但是這個方案需要獲取替換的那個View才行，所以新增的View和Dialog都需要單獨處理才行。新增的View需要進行當前頁面的View樹進行監聽，Dialog必須對Dialog中的View再進行一次hook。
• AspectJ切面編程方案。這個方案是在編譯期將代碼插入到目標方法中，所以只要找到切點——也就是View中的onClick方法即可。可以完美解決我們的問題，並且不需要用戶另外操作。
• 無障礙服務方案。這個方案是通過Android中的無障礙服務，對APP中的所有點擊事件進行攔截，對應的事件就是AccessibilityEvent.TYPE_VIEW_CLICKED。該方案也能完美解決我們的問題，但是有個很大的缺點，就是需要用戶單獨去設置頁面開啟該輔助服務才行。

雖然在我們實際項目中這個問題——獲取頁面的所有點擊事件的需求幾乎沒有，但是對於這種問題的分析能讓我們了解相關的知識，比如今天了解到的事件分發機制，Hook方法，切面編程，無障礙服務，有了這些知識，真正遇到一些關於頁面事件的問題或需求，就能有自己的解決方案了。

參考

wanAndroid

Android應用Activity、Dialog、PopWindow、Toast窗口添加機制及源碼分析

反思|Android 事件分發機制的設計與實現

源碼

PageClickMonitor

拜拜

有一起學習的小伙伴可以關注下❤️我的公眾號——碼上積木，每天剖析一個知識點，我們一起積累知識。公眾號回復111可獲得面試題《思考與解答》以往期刊。