点击事件无痕埋点解决方案--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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355

推荐阅读更多精彩内容

  • 版权归属于微信公众号文章网易HubbleData之Android无埋点实践文末有彩蛋哦☺ 1 背景 网易Hubbl...
    nailperry阅读 8,252评论 3 31
  • 这段时间想到一个有趣的功能,就是在Android的代码编译期间进行一些骚操作,来达到一些日常情境下难以实现的功能,...
    C6C阅读 31,222评论 22 122
  • 《高难度谈话》笔记,3星。 梳理三层对话,为谈话做准备 1. “发生了什么”对话 我们无需再拘泥于证明自己是正确的...
    大清新阅读 554评论 0 0
  • 亲爱的: 回来几天了,虽然这几天里有点小浪花翻了翻,滚了滚,但却让我看到了更多的美好,学习与不完美共存的感觉,真的...
    溪水边的小羊阅读 163评论 0 0
  • 我已收到你指责我没有教育好儿子的信息,只是一直没有回复你。我这样做的原因,主要是我不知道怎么跟你说。所以在收到你信...
    雪夜花开阅读 231评论 0 2