Exposure

Project Url: wp529/Exposure
Introduction: ExposureRecyclerView 是一个很方便对 RecyclerView 的 item 进行曝光埋点的库,在现有代码上少量侵入即可实现 RV 的曝光埋点。支持 RV 的线性布局、网格布局、瀑布流布局,横向滑动曝光埋点。支持配置 item 的有效曝光面积。
More: Author   ReportBugs   
Tags:

Exposure

​ Exposure 是一个很方便对 View 进行曝光埋点收集的库,在现有代码上少量侵入即可实现 View 的曝光埋点。支持对 ViewGroup 的子 View 进行曝光收集,支持 RV 的线性布局、网格布局、瀑布流布局,横向滑动曝光埋点。支持配置 item 的有效曝光面积。

添加依赖:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
dependencies {
    implementation 'com.github.wp529:Exposure:1.1.7'
}
使用方式:
  1. 将 View 的根布局替换为对应的 LayoutView,内部提供了三个 LayoutView,若需更多的 LayoutView 可以自行实现 IProvideExposureData 接口

    ExposureLinearLayout,ExposureFrameLayout,ExposureRelativeLayout

    <?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>
    
  2. 为 LayoutView 绑定上曝光的数据

    //注:这里的 data 对象最好实现了 equals 方法
    exposureRoot.exposureBindData = data
    
  3. 对 RecyclerView 进行曝光收集,在给 RV 设置完 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 被滚动了触发曝光收集

  4. 对 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自行处理相关逻辑

可查看 demo 获知更多使用姿势
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools