Android端无埋点统计方案.zip

# AndroidTracker `AndroidTracker`是一个Android端的无埋点统计的实现方法。其对`Activity`、`Fragment`的生命周期进行监听，实现了页面浏览以及点击事件的采集。 针对点击事件的处理，目前兼容`ActionBar`、`ToolBar`的点击，以及[ButterKnife](https://github.com/JakeWharton/butterknife)的点击注解。 支持版本为API 14及以上（Android 4.0及以上）。 ## 初始化 在工程根目录的`build.gradle`文件的最后添加： ```groovy allprojects { repositories { // ... maven { url 'https://jitpack.io' } } } ``` 并在项目中增加如下依赖： ```groovy dependencies { implementation 'com.github.foolchen:AndroidTracker:0.3.3' } ``` 该库中引用了[okhttp3](https://github.com/square/okhttp)以及[retrofit2](https://github.com/square/retrofit)，如果需要独立引用其他版本的`okhttp`和`retrofit`，则可以引用如下： ```groovy dependencies { implementation ("com.github.foolchen:AndroidTracker:0.3.3"){ exclude module: 'okhttp' exclude module: 'retrofit' } } ``` 并在项目的`Application`中初始化如下： ```kotlin class App : Application(), ITrackerContext { override fun onCreate() { super.onCreate() // 设定一些通用的属性，这些属性在每次统计事件中都会附带 // 注意：如果此处的属性名与内置属性的名称相同，则内置属性会被覆盖 Tracker.addProperty("附加的属性1", "附加的属性1") Tracker.addProperty("附加的属性2", "附加的属性2") // 设定上报数据的主机和接口 // 注意：该方法一定要在Tracker.initialize()方法前调用 // 否则会由于上报地址未初始化，在触发启动事件时导致崩溃 Tracker.setService("https://www.demo.com", "report.php") // 设定上报数据的项目名称 Tracker.setProjectName("android_tracker") // 设定上报数据的模式 Tracker.setMode(TrackerMode.RELEASE) // 初始化AndroidTracker Tracker.initialize(this) } } ``` ## Activity中的集成方式 在`Activity`中集成时，如果项目仅存在`Activity`，不需要对`Fragment`进行特殊处理，则仅需要实现`ITrackerHelper`接口，用于获取页面的名称和页面附加属性。 如果项目中有`Fragment`，需要在特定情况下忽略`Activity`的统计，则还应该实现`ITrackerIgnore`接口，手动处理`isIgnore`方法的返回值。示例如下： ```kotlin open class BaseActivity : AppCompatActivity(), ITrackerHelper, ITrackerIgnore { /////////////////////////////////////////////////////////////////////////// // 该类实现ITrackerHelper接口，此处两个方法全部返回null // 则页面名称（别名）会直接取使用canonicalName来当做标题 // 并且不会有附加的属性 /////////////////////////////////////////////////////////////////////////// override fun getTrackName(): String? = null override fun getTrackProperties(): Map<String, Any?>? = null /////////////////////////////////////////////////////////////////////////// // ITrackerIgnore接口用于确定当前Activity中是否包含Fragment // 如果返回值为true，则表明当前Activity中有包含Fragment，则此时不会对Activity进行统计 // 如果返回值为false，则表明当前Activity中不包含Fragment，则此时会对Activity进行统计 // 此处默认不包含Fragment，如有需要应该在子类中覆写该方法并修改返回值 /////////////////////////////////////////////////////////////////////////// override fun isIgnored(): Boolean = false } ``` ## Fragment中的集成方式 与`Activity`相同，如果`Fragment`中不再有子`Fragment`，则仅需要实现`ITrackerHelper`。 如果有子`Fragment`，或者需要手动忽略部分`Fragment`的统计，则需要实现`ITrackerIgnore`接口。示例如下： ```kotlin open class BaseFragment : Fragment(), ITrackerHelper, ITrackerIgnore { /////////////////////////////////////////////////////////////////////////// // Tracker.setUserVisibleHint()和Tracker.onHiddenChanged()方法用于同步Fragment // 的可见性，解决在Fragment显隐/与ViewPager结合使用时无法触发生命周期的问题 /////////////////////////////////////////////////////////////////////////// override fun setUserVisibleHint(isVisibleToUser: Boolean) { super.setUserVisibleHint(isVisibleToUser) Tracker.setUserVisibleHint(this, isVisibleToUser) } override fun onHiddenChanged(hidden: Boolean) { super.onHiddenChanged(hidden) Tracker.onHiddenChanged(this, hidden) } /////////////////////////////////////////////////////////////////////////// // 该类实现ITrackerHelper接口，此处两个方法全部返回null // 则页面名称（别名）会直接取使用canonicalName来当做标题 // 并且不会有附加的属性 /////////////////////////////////////////////////////////////////////////// override fun getTrackName(): String? = null override fun getTrackProperties(): Map<String, Any?>? = null /////////////////////////////////////////////////////////////////////////// // ITrackerIgnore接口用于确定当前Fragment中是否包含子Fragment // 如果返回值为true，则表明当前Fragment中有包含子Fragment，则此时不会对当前Fragment进行统计 // 如果返回值为false，则表明当前Fragment中不包含子Fragment，则此时会对当前Fragment进行统计 // 此处默认不包含子Fragment，如有需要应该在子类中覆写该方法并修改返回值 /////////////////////////////////////////////////////////////////////////// override fun isIgnored(): Boolean = false } ``` ## 对点击事件增加属性 在某些场景下，仅对`View`进行默认属性的统计可能无法满足需求，故可以针对点击事件增加自定义属性。示例如下（ButterKnife）： ```java @OnClick(R.id.tv_clickable) public void click(View view) { Toast.makeText(view.getContext(), ((TextView) view).getText().toString(), Toast.LENGTH_SHORT) .show(); // 此处针对点击事件增加属性 Map<String, Object> map = new HashMap<>(); map.put("附加的View属性", view.toString()); Tracker.INSTANCE.trackView(view, map); } ``` ## 登入/登出处理 每个用户会使用`distinct_id`来标识，用户未登录时，该值由设备`Android Id`、设备制造商、设备型号等字段计算得到唯一值。 而在用户登录后，则需要使用确切的用户id来替代该值。示例如下： kotlin: ```kotlin Tracker.login("此处设置用户id") ``` java: ```java Tracker.INSTANCE.login("此处设置用户id"); ``` 在用户退出登录时，需要主动调用登出方法。此时，`distinct_id`的值会替换为SDK生成的值。示例如下： kotlin： ```kotlin Tracker.logout() ``` java： ```java Tracker.INSTANCE.logout(); ``` ## 设置渠道号 渠道号在统计事件中的属性为`channel`。设置如下： kotlin： ```kotlin Tracker.setChannelId("此处设置渠道号") ``` java： ```java Tracker.INSTANCE.setChannelId("此处设置渠道号"); ``` ## 针对所有统计附加属性 如果想要针对所有的统计事件增加一些固定的属性，则应该在初始化时设置如下： ```kotlin Tracker.addProperty("附加的属性1", "附加的属性1") Tracker.addProperty("附加的属性2", "附加的属性2") ``` ## 自定义事件 该库提供了追踪自定义事件的方法，并且可以自定义属性。调用示例如下： kotlin: ```kotlin Tracker.trackEvent("MainActivity的自定义追踪事件", null) ``` java: ```java Tracker.INSTANCE.trackEvent("MainActivity的自定义追踪事件", null) ``` ## 上报模式 **DEBUG_ONLY**：仅在`Logcat`中打印日志，不上传数据。建议仅在调试阶段使用该模式。 **DEBUG_TRACK**：在`Logcat`中打印日志，并且**即时**上传�