python 点击埋点_点击事件无痕埋点解决方案--ClickTrace

背景

最近App开发中遇到了无痕埋点的需求。

所谓无痕埋点，即在App上线后可以上报通用数据(如生命周期事件、点击事件)，并且不需要手动在上报处一一埋点，最好可以做到不修改任何Java旧代码。

字节码插桩可以在.class转为.dex之前，修改.class，以插入工程中不存在的代码。

目前市面通常用字节码插桩实现上述需求，开源的库也有很多，如HiBeaver、网易HubbleData，用它们可以很简单的实现下面需求：

生命周期事件

只需要在对应基类Activity的生命周期函数中插入上报代码即可。

页面使用时长

分别在基类Activity的onCreate和onDestroy中插入监听代码，即可统计页面使用时长。

然而此次的无痕埋点还要求能统计到App的所有点击事件，即每当点击事件触发时，就上报当前被点击View的相关参数，如id，content。

在每一个clickListener中写埋点上报代码肯定是不可行的，因为程序员会疯。这就要求所有点击事件最终都可以通过触发同一个回调来上报埋点事件。

如果借用HiBeaver等第三方库呢？(以下方案建议亲测感受一下)

序列

方案

问题

1

点击事件implements View.OnClickListener，在onClick(View v)函数中插入上报代码。

在成熟项目里，因为历史原因，并非所有的点击事件都如此'标准'，很多直接调用setOnClickListener(new OnClickListener())，或者xml中定义onClick，这种情况无法插入代码。

2

重写BaseView，在setOnClickListener()函数中插入代码。

原因同上，我们不可能重写所有的View以继承BaseView，工作量巨大。

3

在onCreate()中插入代码：遍历组件树，给每个View添加AccessDelegate回调。

似乎可行，实际运行发现：动态添加的View没有回调，因为遍历组件树时根本没有；有些id为-1或者重复，因为同样的原因或组件复用。

4

祭出大招：onCreate()中插入代码，监听组件树变化，每当组件树变化，就执行方案3的逻辑。对于id重复的问题，返回position或path以做甄别。

实测可行，但逻辑复杂，插入代码之多，字节码插桩库只起到了微小的作用。

可不可以使用Gradle插件快捷实现点击事件统一回调需求呢？

目标

给指定Activity或全部Activity的所有View增添统一点击后回调入口，同时无须改动现有代码。

只需要在统一回调里添加我的埋点上报代码，即可实现点击事件上报。

为此我开发了一款Gradle插件，后续会出文章分享我的插件开发填坑史。

使用

关于插件的引入可以查看Git地址 ClickTrace

这里仅介绍如何使用插件：

首先新建点击事件回调类，代码如下：

public class ClickTrace {

public static void log(View view, int eventType, String path, String content, int position) {

if (eventType == 1) {

//TODO 点击事件的埋点上报代码 这里演示仅输出日志

Log.e("TraceUtils", "ViewName:" + view.getClass().getSimpleName() +

"\nViewId:" + view.getId() +

"\nEventType:" + eventType +

"\nViewPath:" + path +

"\nViewContent:" + content +

"\nViewPosition:" + position);

}

}

}

之后在Module的build.gradle里配置了要监听的页面和回调的函数路径。如下：

apply plugin: 'com.dixon.clicktrace'

clickconfig {

basepath 'com.example.clickdemo.BaseActivity'

tracepath 'com.example.clickdemo.ClickTrace', 'log'

}

如上配置结束后，当监听页面的某一View点击事件触发时，就会调用log方法输出日志，同时不会影响原有的点击事件(仅当View设置了点击事件，log方法才会被触发)。

效果

如下图demo所示：

Demo.png

当我点击HelloWorld，会打印如下日志：

ViewName:AppCompatTextView

ViewId:2131165317

EventType:1

ViewPath:DecorView/LinearLayout/FrameLayout/ActionBarOverlayLayout/ContentFrameLayout/LinearLayout/AppCompatTextView

ViewContentHello:World!

ViewPosition:-1

当我点击item-C时，会打印如下日志：

ViewName:AppCompatTextView

ViewId:2131165318

EventType:1

ViewPath:DecorView/LinearLayout/FrameLayout/ActionBarOverlayLayout/ContentFrameLayout/LinearLayout/ListView/FrameLayout/AppCompatTextView

ViewContent:C

ViewPosition:2

当我点击item-F时，会打印如下日志：

ViewName:AppCompatTextView

ViewId:2131165318

EventType:1

ViewPath:DecorView/LinearLayout/FrameLayout/ActionBarOverlayLayout/ContentFrameLayout/LinearLayout/ListView/FrameLayout/AppCompatTextView

ViewContent:F

ViewPosition:5

这里Item-C和Item-F的id是相同的，因为复用同一个layout。

写在最后

插件目前处于1.0.0版本，目前发现有一定的漏点问题，但基本可以满足无痕埋点的点击事件要求。

你可以通过简单的几步为你的项目引入并使用ClickTrace插件，欢迎各位大佬使用～

相关代码以及引入插件和配置的方法详见Git地址：ClickTrace