Home

一、Trace

一个适用于 Android 的字节码插桩库

目前一共包含四个功能点：

View Click 双击防抖
Jetpack Compose Click 双击防抖
替换 Class 的继承关系。应用场景包括：非侵入式地实现监控大图加载的功能
修复 Toast 在 Android 7.1 上的系统 bug。用于解决在 Android 7.1 系统上 Toast 由于 WindowToken 失效从而导致应用崩溃的问题

二、引入

在项目根目录下的 build.gradle.kts 或者 build.gradle 中引入插件

//kts
plugins {
    id("io.github.leavesczy.trace").version("latestVersion").apply(false)
}

//grovy
plugins {
    id "io.github.leavesczy.trace" version "latestVersion" apply false
}

在项目主模块下的 build.gradle.kts 或者 build.gradle 中应用插件，需要哪些功能点就为其设置对应的参数

//kts
plugins {
    id("io.github.leavesczy.trace")
}

viewClickTrace {
    onClickClass = ""
    onClickMethodName = ""
    uncheckViewOnClickAnnotation = ""
    include = setOf()
    exclude = setOf()
}

composeClickTrace {
    onClickClass = ""
    onClickWhiteList = ""
}

replaceClassTrace {
    originClass = ""
    targetClass = ""
    include = setOf()
    exclude = setOf()
}

toastTrace {
    toasterClass = ""
    showToastMethodName = ""
}

//grovy
plugins {
    id("io.github.leavesczy.trace")
}

viewClickTrace {
    onClickClass = ""
    onClickMethodName = ""
    uncheckViewOnClickAnnotation = ""
    include = []
    exclude = []
}

composeClickTrace {
    onClickClass = ""
    onClickWhiteList = ""
}

replaceClassTrace {
    originClass = ""
    targetClass = ""
    include = []
    exclude = []
}

toastTrace {
    toasterClass = ""
    showToastMethodName = ""
}

三、viewClickTrace

viewClickTrace 用于为 Android 原生的 View 体系实现双击防抖功能

开发者一共需要设置两个必填参数和三个可选参数

viewClickTrace {
    //必填参数
    onClickClass = ""
    onClickMethodName = ""
    //可选参数
    uncheckViewOnClickAnnotation = ""
    include = setOf()
    exclude = setOf()
}

viewClickTrace 实现应用双击防抖功能的本质，就是为项目中所有 View.OnClickListener 的回调方法都插入一段逻辑代码，该段代码会计算前后两次点击事件的时间间隔，如果判断到时间间隔小于某个阈值的话就直接 return，否则就让其继续执行

伪代码如下所示

//插桩前
view.setOnClickListener(object : View.OnClickListener {
    override fun onClick(view: View) {
        //TODO
    }
})

//插桩后
view.setOnClickListener(object : View.OnClickListener {
    override fun onClick(view: View) {
        if (!ViewClickMonitor.isEnabled(view)){
            return
        }
        //TODO
    }
})

开发者需要在自己的项目中提供一个方法，用于承接 viewClickTrace 转发的所有 View 点击事件。viewClickTrace 就负责将开发者提供的 ViewClickMonitor.isEnabled(View) 方法插入到 View.OnClickListener 的回调函数中，由方法返回值来决定是否要执行本次点击事件

ViewClickMonitor 的包名、类名、方法名均可以随意命名，viewClickTrace 仅要求其包含一个静态方法，方法签名和 isEnabled 保持一致即可，返回值为 true 即代表允许执行本次点击事件

object ViewClickMonitor {

    @JvmStatic
    fun isEnabled(view: View): Boolean {
        val isEnabled: Boolean
        //TODO
        return isEnabled
    }

}

例如，开发者可以照着以下代码来实现 ViewClickMonitor，将每次点击事件的最小时间间隔设为五百毫秒。开发者可以根据自己的需要来进行自定义，不必局限于以下实现

package github.leavesczy.trace

object ViewClickMonitor {

    private const val MIN_DURATION = 500L

    private var lastClickTime = 0L

    @JvmStatic
    fun isEnabled(view: View): Boolean {
        val currentTime = SystemClock.elapsedRealtime()
        val isEnabled = currentTime - lastClickTime > MIN_DURATION
        if (isEnabled) {
            lastClickTime = currentTime
        }
        return isEnabled
    }

}

然后将 ViewClickMonitor 的类名和对应的方法名传给 viewClickTrace 即可

viewClickTrace {
    onClickClass = "github.leavesczy.trace.ViewClickMonitor"
    onClickMethodName = "isEnabled"
}

在默认情况下，viewClickTrace 会对整个项目中的所有 onClick 事件均进行拦截检测。如果想过滤特定的点击事件，或者是想过滤特定类或者是特定包名，可以通过 viewClickTrace 的另外三个可选参数来实现

viewClickTrace {
    //过滤包含特定注解的 onClick 事件
    uncheckViewOnClickAnnotation = ""
    //仅对特定类或者特定包名中的 onClick 事件进行拦截检测
    include = setOf()
    //过滤特定类或者特定包名中的 onClick 事件
    exclude = setOf()
}

例如，开发者可以自己声明一个 UncheckViewOnClick 注解

package github.leavesczy.trace

@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class UncheckViewOnClick

将该注解的全路径传给 uncheckViewOnClickAnnotation 后，以下的点击事件就会被过滤

findViewById<View>(R.id.tvObjectUnCheck).setOnClickListener(
    object : View.OnClickListener {
        @UncheckViewOnClick
        override fun onClick(view: View) {
            onClickView()
        }
    })

include 和 exclude 两个参数则用于以类名或包名为单位，共同控制 viewClickTrace 的生效范围

include 用于设定 viewClickTrace 的生效范围。参数值在为空的情况下代表着对所有模块均生效，传值后则只对参数值代表的模块生效
exclude 用于设定 viewClickTrace 的排除范围。用于在 include 限定的范围内再排除特定模块

include 和 exclude 均通过正则表达式来进行传值，viewClickTrace 每当遍历到一个类时，均会拿其类名和 include 和 exclude 一起进行匹配，均匹配通过后才会对该类进行双击防抖

例如，以下参数就表示：

包含 UncheckViewOnClick 注解的 onClick 回调不会进行双击防抖
仅在 github.leavesczy.trace.xxx 包名下的类会进行双击防抖，但 github.leavesczy.trace.mylibrary.xxx 包名下的类除外

viewClickTrace {
    uncheckViewOnClickAnnotation = "github.leavesczy.trace.UncheckViewOnClick"
    include = setOf("^github\\.leavesczy\\.trace.*")
    exclude = setOf("^github\\.leavesczy\\.trace\\.mylibrary.*")
}

四、composeClickTrace

composeClickTrace 用于为 Jetpack Compose 实现双击防抖功能

开发者一共需要设置一个必填参数和一个可选参数

composeClickTrace {
    //必填参数
    onClickClass = ""
    //可选参数
    onClickWhiteList = ""
}

和 View 体系一样，开发者也需要在自己项目中声明一个符合以下签名的类，ComposeOnClick 的包名和类名均可以随意命名，将该类的全路径作为参数值传递给 onClickClass 即可

class ComposeOnClick(private val onClick: () -> Unit) : Function0<Unit> {

    override fun invoke() {
        //TODO
    }
    
}

例如，开发者可以照着以下代码来实现 ComposeOnClick

package github.leavesczy.trace

class ComposeOnClick(private val onClick: () -> Unit) : Function0<Unit> {

    companion object {

        private const val MIN_DURATION = 500L

        private var lastClickTime = 0L

    }

    override fun invoke() {
        val currentTime = SystemClock.elapsedRealtime()
        val isEnabled = currentTime - lastClickTime > MIN_DURATION
        if (isEnabled) {
            lastClickTime = currentTime
            onClick()
        }
    }

}

另外，onClickWhiteList 即点击事件的白名单，对于某些不希望执行双击防抖的 Modifier.clickable 和 Modifier.combinedClickable 方法，通过将其 onClickLabel 设置为 onClickWhiteList 的属性值后就不会进行双击防抖

例如，以下参数就表示：Modifier.clickable 和 Modifier.combinedClickable 方法触发的点击事件均会被移交给 ComposeOnClick 处理，onClickLabel 属性值为 notCheck 的点击事件除外

composeClickTrace {
    onClickClass = "github.leavesczy.trace.ComposeOnClick"
    onClickWhiteList = "notCheck"
}

五、replaceClassTrace

replaceClassTrace 用于替换项目中类的继承关系

也就是说，replaceClassTrace 会将项目中每一个 originClass 的直接子类，均将其改为直接继承于 targetClass。此外，replaceClassTrace 还包含 include 和 exclude 两个可选参数，其作用和 viewClickTrace 中的同名参数一致

replaceClassTrace {
    //必填参数
    originClass = "x"
    targetClass = "x"
    //可选参数
    include = setOf()
    exclude = setOf()
}

这个功能有什么意义呢？

举个例子。假设现在要来检测项目中的所有 ImageView 加载的图片尺寸是否过大，此时我们就可以自定义实现一个 ImageView 的子类 MonitorImageView，在其中实现好大图检测的功能，然后再通过 replaceClassTrace 将所有直接继承于 ImageView 的子类均改为直接继承于 MonitorImageView，从而使得大图检测的功能对整个项目均能生效，而且还不必手动修改现有代码

例如，以下参数就表示：将项目中所有直接继承于 ImageView 的子类，均改为直接继承于 MonitorImageView，但类名为 IgnoreImageView 的子类除外

replaceClassTrace {
    originClass = "android.widget.ImageView"
    targetClass = "github.leavesczy.trace.MonitorImageView"
    include = setOf()
    exclude = setOf(".*\\.IgnoreImageView\$")
}

六、toastTrace

toastTrace 用于聚拢项目中所有调用系统 Toast 的显示操作，用于解决 Android 7.1 系统中 Toast 由于 WindowToken 失效从而导致应用崩溃的问题

开发者一共需要设置两个必填参数

toastTrace {
    toasterClass = ""
    showToastMethodName = ""
}

开发者需要在自己的项目中提供一个方法，用于承接 toastTrace 转发的所有 Toast 显示操作。toastTrace 就负责将项目中所有调用了 toast.show() 的操作都聚拢到开发者指定的方法下，开发者可以在该方法内对 Android 7.1 中 Toast 的系统 bug 进行修复

例如，开发者可以像以下代码一样来承接 toast.show() 操作，在 Android 7.1 系统版本上捕获系统抛出的异常。Toaster 的包名、类名、方法名均可以随意命名，toastTrace 仅要求其包含一个静态方法，方法签名符合 showToast 的规则即可

package github.leavesczy.trace

object Toaster {

    @JvmStatic
    fun showToast(toast: Toast) {
        hookToastIfNeed(toast)
        toast.show()
    }

    @SuppressLint("DiscouragedPrivateApi")
    private fun hookToastIfNeed(toast: Toast) {
        if (Build.VERSION.SDK_INT == Build.VERSION_CODES.N_MR1) {
            try {
                val cToast = Toast::class.java
                val fTn = cToast.getDeclaredField("mTN")
                fTn.isAccessible = true
                val oTn = fTn.get(toast)
                val cTn = oTn.javaClass
                val fHandle = cTn.getDeclaredField("mHandler")
                fHandle.isAccessible = true
                fHandle.set(oTn, ProxyHandler(fHandle.get(oTn) as Handler))
            } catch (e: Throwable) {
                e.printStackTrace()
            }
        }
    }

    private class ProxyHandler(private val mHandler: Handler) : Handler(mHandler.looper) {

        override fun handleMessage(msg: Message) {
            try {
                mHandler.handleMessage(msg)
            } catch (e: Throwable) {
                e.printStackTrace()
            }
        }

    }

}

然后，将 Toaster 对应的全路径和方法名传给 toastTrace 即可

toastTrace {
    toasterClass = "github.leavesczy.trace.Toaster"
    showToastMethodName = "showToast"
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly