如何捕獲一個Activity頁面上全部的點擊行爲

前言

最近逛wanAndroid論壇,發現一個有趣的問題:如何捕獲一個Activity頁面上全部的點擊行爲html

一塊兒研究下吧,不想看源碼的小夥伴能夠直接看文末總結~java

準備工做

先得羅列出頁面上的一些點擊行爲,經常使用的有:android

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

因而就有了以下代碼:git


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("點擊了新加的按鈕")
            }
        }
    }
}

既然我要捕獲點擊事件,首先就想到的是經過事件分發機制,也就是在源頭就去獲取全部的觸摸事件,而後對點擊事件進行統計,幹吧~github

事件分發

重寫Activity的dispatchTouchEvent方法,因爲只有點擊事件,因此只須要統計ACTION_UP事件便可,若是有長按事件就在須要判斷下按下的時間。web


    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方法,做爲開發者事件分發的一個控制攔截,最後從新返回到DecorViewsuper.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——>ViewGroupapp

而咱們在第二步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, nullnull);
        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 ClickAccessibilityServiceAccessibilityService() {

    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方法,切面編程,無障礙服務,有了這些知識,真正遇到一些關於頁面事件的問題或需求,就能有本身的解決方案了。

參考

https://www.wanandroid.com/wenda/show/8476

http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/0615/3044.html

https://juejin.cn/post/6844903926446161927

源碼

https://github.com/JiMuzz/PageClickMonitor

拜拜

感謝你們的閱讀,有一塊兒學習的小夥伴能夠關注下個人公衆號——碼上積木❤️❤️
每日三問知識點/面試題,聚沙成塔。


本文分享自微信公衆號 - 碼上積木(Lzjimu)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。

相關文章
相關標籤/搜索