Exposure是一个很方便对View进行曝光埋点收集的库,在现有代码上少量侵入即可实现View的曝光埋点。支持对ViewGroup的子View进行曝光收集,支持RV的线性布局、网格布局、瀑布流布局,横向滑动曝光埋点。支持配置item的有效曝光面积。
添加依赖:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.wp529:Exposure:1.2.1'
}
-
将需要采集曝光的View替换为对应的曝光View,库里面提供了三个曝光View (ExposureLinearLayout,ExposureFrameLayout,ExposureRelativeLayout),若需其他类型的曝光View可以自行让对应View实现IProvideExposureData接口
<?xml version="1.0" encoding="utf-8"?> <com.wp.exposure.view.ExposureFrameLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:id="@+id/exposureRoot" android:layout_width="match_parent" android:layout_height="wrap_content" android:orientation="vertical"> <TextView android:id="@+id/tvText" android:layout_width="wrap_content" android:layout_height="wrap_content" tools:text="TEXT" /> </com.wp.exposure.view.ExposureLinearLayout>
-
为曝光View绑定上对应的曝光数据
//注:这里的data对象最好实现了equals方法 exposureRoot.exposureBindData = data
在给RecyclerView设置完adapter后实例化RecyclerViewExposureHelper,实例化时需传递四个参数,需要做曝光埋点的RV,RV所在的生命周期组件容器(用于自动处理开始曝光和结束曝光),item曝光状态改变监听器(泛型类型为第二步中data的类型),item的有效曝光面积判定,eg:设置为50 若item的面积为200平方,则必须要展示200 * 50% = 100平方及以上才算为曝光
recyclerViewExposureHelper =
RecyclerViewExposureHelper(rvList, 50, lifecycleOwner, object : IExposureStateChangeListener<String> {
override fun onExposureStateChange(
bindExposureData: String,
position: Int,
inExposure: Boolean
) {
Log.i(
"ListActivity", "${bindExposureData}${
if (inExposure) {
"开始曝光"
} else {
"结束曝光"
}
}"
)
}
})
3.1 若RV被嵌套在可滚动控件(eg:ScrollView,NestedScrollView,RecyclerView等)中,将会导致RecyclerViewExposureHelper持有的RV不能响应滑动的情况,就必须由外部告知RV被滚动了触发曝光收集
-
对ViewGroup进行曝光收集,实例化时需传递四个参数,需要做曝光埋点的ViewGroup,ViewGroup所在的生命周期组件容器(用于自动处理开始曝光和结束曝光),item曝光状态改变监听器(泛型类型为第二步中data的类型),item的有效曝光面积判定,eg:设置为50 若item的面积为200平方,则必须要展示200 * 50% = 100平方及以上才算为曝光
viewGroupViewExposureHelper = ViewGroupExposureHelper(rootView, 50, lifecycleOwner, object : IExposureStateChangeListener<String> { override fun onExposureStateChange( bindExposureData: String, position: Int, inExposure: Boolean ) { Log.i( "CollectViewGroupActivity", "${bindExposureData}${ if (inExposure) { "开始曝光" } else { "结束曝光" } }" ) } })
4.1 若ViewGroup中需要收集的子View在可滚动的布局中,那么在滚动时,需调用viewGroupViewExposureHelper.onScroll(),若ViewGroup中需要收集的子View Visible状态变更,那么需调用需调用viewGroupViewExposureHelper.childViewVisibleChange()
至此,item曝光埋点接入完成,只需在onExposureStateChange回调中进行处理即可。onExposureStateChange回调会回传三个参数。item绑定的曝光数据,曝光状态改变的位置,曝光状态。曝光状态true代表item从未曝光状态进入曝光中状态,false代表item从曝光中状态进入结束曝光状态
RecyclerView的item曝光埋点对客户端来说只用处理三个问题,此库的作用即是处理这三个问题
-
可见面积是否为有效曝光
-
item可见(开始曝光)
-
item不可见(结束曝光)
埋点SDK一般会提供三个api供客户端调用
-
onItemExposureStart()
-
onItemExposureEnd()
-
onItemExposureUpload()
所以只需在onExposureStateChange里调用埋点SDK对应的api即可,至于曝光时长是否为有效曝光一般由埋点SDK进行计算
若没有中台(埋点SDK),也可通过onExposureStateChange自行处理相关逻辑