前段时间刚做完公司无埋点数据采集项目,跟大家分享一下。
以下只有部分核心代码,完整源码及接入流程请移步
github:https://github.com/harvie1208/TracePoint
项目背景
当前手动代码埋点的方式,效率低、成本高、见效慢,故开发一套sdk自动采集pv、click等事件。
技术方案调研
无埋点主流方案有以下几种
1.View.AccessibilityDelegate
- 采用辅助功能事件实现无埋点,简单来讲,就是给View设置AccessibilityDelegate,当View产生了click,long_click等事件时,会在响应原有的Listener方法后,发送消息给AccessibilityDelegate,然后在sendAccessibilityEvent方法下搜集自动埋点事件。
- 设置代理的时机
实现Application.ActivityLifecycleCallbacks,用来监听Activity生命周期,当监听到某个Activity进入onResumed状态时,通过以下方式获取RootView:
mViewRoot = this.mActivity.getWindow().getDecorView().getRootView()
从RootView出发深度优先遍历控件树,为满足特定条件的View设置代理监听。
2.gradle插件字节码插装
插件实现也分两种,一种是将Button、TextView等替换成自定义View,另一种是修改字节码。这里选择第二种实现。
-
主流程概述:
通过自定义gradle插件拦截到view的onClick方法及Activity、fragment生命周期方法,插入自定义采集方法,从而监听pv、click事件。
-
关键概念简介(图片来源网易HubbleData)
通过上图可以看出,我们就是在class文件打包到dex文件的过程中增加transform任务,执行插入代码
无埋点技术实现(gradle插件方式)
1.编写gradle插件模块(groovy文件实现)
看到groovy文件不要慌,可以把它当做java写
- 1.工程下创建buildSrc模块(系统保留名称)
- 2.编写插件
import com.android.build.gradle.BaseExtension
import org.gradle.api.Plugin
import org.gradle.api.Project
/**
* @author harvie
*/
class NoTracePointPlugin implements Plugin<Project>{
@Override
void apply(Project project) {
project.extensions.create(ClassModifyUtil.CONFIG_NAME,NoTracePointPluginParams)
registerTransform(project)
}
def static registerTransform(Project project){
BaseExtension extension = project.extensions.getByType(BaseExtension)
NoTracePointTransform transform = new NoTracePointTransform(project)
extension.registerTransform(transform)
}
}
其中apply方法中的project对象用于读取build.gradle文件中的一些配置信息
将自定义的transform类注册进去后,执行工程编译命令时就会执行自定义transform中的代码
- 3.编写transform
import com.android.build.api.transform.*
import com.android.build.gradle.BaseExtension
import com.android.build.gradle.internal.pipeline.TransformManager
import groovy.io.FileType
import org.gradle.api.Project
import java.util.jar.JarEntry
import java.util.jar.JarFile
/**
* @author harvie
*/
class NoTracePointTransform extends Transform{
private static Project project
private static BaseExtension android
//需要扫描的目标包名集合
private static Set<String> targetPackages = new HashSet<>()
NoTracePointTransform(Project project) {
this.project = project
this.android = project.extensions.getByType(BaseExtension)
ClassModifyUtil.project = project
ClassModifyUtil.noTracePointPluginParams = project.noTracePoint
}
@Override
String getName() {
//transform任务名称,随意
return "noTracePointTransform"
}
@Override
Set<QualifiedContent.ContentType> getInputTypes() {
//输入类型 class文件
return TransformManager.CONTENT_CLASS
}
@Override
Set<? super QualifiedContent.Scope> getScopes() {
//作用域 全局工程
return TransformManager.SCOPE_FULL_PROJECT
}