这篇文章主要介绍在本人在公司项目上埋点实现的一些心得，在项目早期我们完全依赖于第三方的无痕埋点技术，客户端开发人员只需要做一些简单的工作就能满足 BI 部门对数据的需求。但随着业务增长，对数据的准确性和精细化的要求越来越高，之后不得不转向手动埋点（基于神策）。
很多时候我们需要根据具体业务来选择适合的埋点方案，在 火球买手 这个项目上 BI 部门对埋点数据要求可以总结为一句话：『从哪里来到哪里去』，比如在 Timeline 中点击一篇文章进入详情页，那么 Timeline 就是『从哪里来』，详情页就是『到哪里去』，当然『从哪里来』不只需要一个维度定位，有时候需要两三个维度才能定位。
下面举一些具体的例子，首先『频道主页』是项目中比较常见的页面，它对应的 Model 是 Channel，然后当任何点击进入的频道主页的事件触发后都需要上报以下数据
1
2
3
4
5
6
{
module_name
page_name
channel_name
channel_id
}
page_name指的是当前的 ViewController 名称，module_name主要用于区分同一个页面内的不同入口，这样子就能确定『从哪里来』，channel_name 和 channel_id 数据来自于 Channel，至于『到哪里去』这里就用埋点的 key 来表明，比如是 ChannelClick。
频道主页在 APP 中入口众多，即使在不考虑埋点的情况下，一个统一的入口也是必要的
1
2
3
4
5
extension UIViewController {
func pushToChannelDetailController(_ id: String?) {
// ...
}
}
显然这样的方法根本无法满足埋点上的需求，改造一下：
1
2
3
4
5
6
7
8
9
10
11
12
extension UIViewController {
func pushToChannelDetailController(_ model: Channel?) {
// ...
let value = [
"module_name" : model.module_name,
"channel_id" : model._id,
"channel_name": model.name,
"page_name": self.pageName
]
SensorsAnalyticsSDK.sharedInstance()?.track(key, withProperties: value)
}
}
大多数情况下入口函数只接受一个具象参数是行不通的，因为随着项目的开发业务的迭代总有一些其他的模型被加入，它们同样带有能够跳转至频道主页的 id 属性，这个后面会提到。然后是 pageName：
1
2
3
4
5
6
7
8
extension UIViewController {
var pageName: String {
switch self {
case is ChannelDetailController:
return "频道主页"
}
}
}
最后在具体的跳转处设置 module_name ，事实上 module_name 不属于 Channel，至于为什么需要和模型绑定，后面会提到
1
2
3
4
@objc func buttonAction(_ sender: Any) {
model.module_name = "Header"
pushToChannelDetailController(model)
}
整体看下来虽然可以应付点击进入频道主页的埋点，但是还是存在以下问题
入口函数不够抽象
在实际开发中接收不同的数据模型跳转到同一个页面的情况应该不少见，并且入口函数也是因为埋点把参数从相对抽象的 String 替换成了具象的 Channel，所以抽象 model 是首先要做的。无论接受什么类型参数，实际的跳转只需要用到 id 这一个字段，那么让一个只有带有 id 属性的 protocol 去约束模型再合适不过了。
1
2
3
protocol CommonModelType {
var id: String { get }
}
然后让 Channle 遵守这个协议，利用 extension 是为了看起来更解耦
1
extension Channel: CommonModelType{}
这时候入口函数就是这样
1
func pushToChannellDetail(_ model: CommonModelType?)
可以接受任何有 id 属性的模型，为了更抽象，甚至可以让 String 也遵守这个协议
1
2
3
4
5
extension String: CommonModelType {
var id: String {
return self
}
}
数据提供方式不够优雅
埋点数据除了 pageName 不属于 model 以外，其他都属于 model 本身的属性（module_name 属于额外添加），所以和参数一样，同样用 protocol 约束 Channel ，让 Channel 拥有一个直接用于提供数据的属性。
1
2
3
protocol AnalyticsModelType {
var analytics: [String: Any] { get }
}
让 Channel 同时遵守这两个协议，并且添加 analytics 属性
1
2
3
4
5
6
7
8
9
10
extension Channel: CommonModelType, AnalyticsModelType {
var analytics: [String : Any] {
let value = [
"module_name" : module_name,
"channel_id" : id,
"channel_name": name
]
return value
}
}
最后完整的入口函数是这样的
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
extension UIViewController {
func pushToChannellDetail(_ model: CommonModelType?) {
guard let model = model else {
return
}
let viewController = ChannelDetailViewController()
viewController.id = model.id
navigationController?.pushViewController(viewController, animated: true)
guard let value = model as? AnalyticsModelType else {
return
}
var properties = value.analytics
properties["page_name"] = pageName
SensorsAnalyticsSDK.sharedInstance.track(key: "ChannelClick", properties: properties)
}
}
别忘记还有module_name，前面说过 module_name 主要用于区分同一个页面内的不同入口，比如页面内A和B入口都会触发 ChannelClick 事件，他们的 module_name 分别是 “A” 和 “B”，回到前面设置 module_name 的地方，module_name 显然和业务耦合在了一起
1
2
3
4
@objc func buttonAction(_ sender: Any) {
model.module_name = "你可能想关注"
pushToChannelDetailController(model)
}
在埋点方案设计的前期最头痛的是怎么处理 module_name，因为从含义上来说 module_name 应该属于视图层面，它不应该绑定到 model 上，但是仔细思考后发现如果把 module_name 绑定到 model 上可以做到足够的低耦合，因为 module_name 在绝大多数情况下在数据返回后已经明确了，比如 “首页时间线” 这个 module_name 我们可以在获取服务端数据后直接绑定到对应的 model 上，想象一下一个页面上的模块划分从数据结构上来说是不是已经明确了，所以说 module_name 甚至可以由服务端直接给出。比如在服务端返回数据之后设置 module_name
1
2
3
4
5
6
7
8
func brandFeed() -> [HQBrandList] {
...
let listValue = Mapper<BrandList>().mapArray(JSONArray: timeline)
listValue.forEach { (item) in
item.reviews.forEach({$0.module_name = "xxxxx" + item.title})
}
return listValue
}
这样子一来，大部分情况下 module_name 都可以通过这种方式设置，对的，这只是大部分情况下，其他情况后面会提到。
总的来说入口函数够抽象，无论后期增加多少种模型只要它遵循CommonModelType即可，甚至对于不熟悉项目的人来说直接传入 id 也是可以正常跳转的。埋点的细节也被隐藏到了入口函数内，而需要上报的数据又由相应的模型负责提供只要它遵循AnalyticsModelType，module_name 通过在对应的数据返回处设置即可。
浏览事件
除了上面说的 ChannelClick 这样子的点击事件，我们还有一种浏览事件，比如浏览频道详情页：ChannelBrowse，也就是在频道详情页完全展现出来后就会触发这个埋点，它所需要携带的信息有
1
2
3
4
5
6
{
channel_name
channel_id
previous_page_name
previous_module_name
}
previous_page_name代表的是上一个页面的名称，previous_module_name是上一个页面内的 module_name，在这里暂且不讨论它和 ChannelClick 到底有什么区别。对于 previous_page_name 我们可以在 navigationController?.viewControllers 里面很简单的获取到，基于这种逻辑当时我当时做了一个错误的决定，就是用一个数组中存放 module_name，这数组初始化就有 N 个空的 module_name，每当有跳转事件发生就在当前的 index 上设置上 module_name，之后一旦有需要就通过当前 viewcontroller 的 index 在这个数组中取到 previous_module_name，但是并不是所有的跳转都会刷新 module_name，也就是并没有把 module_name 设置为空，还有关于 parentViewController 的问题，总之通过单例数组的方案有太多的弊端。
总的来说，类似于 ChannelBrowse 这样的事件获取到 previous_module_name 才是关键，除了前面提到的方案，把 previous_module_name 绑定到当前的 viewController 似乎是一种更好的方案，具体就是在通过页面跳转的时候直接把当前的 module_name 绑定到目标 viewController 上。
1
2
3
4
5
6
7
8
9
10
extension UIViewController {
var previousValue: (String, String) {
get {
return (objc_getAssociatedObject(self, &AssociatedKeys.PreviousValue) as? (String, String)) ?? ("", "")
}
set {
objc_setAssociatedObject(self, &AssociatedKeys.PreviousValue, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)
}
}
}
跳转的时候绑定数据
1
2
3
4
5
6
7
8
9
10
11
12
func pushToReviewDetailController(_ model: HQCommonModelType?) {
guard let model = model else {
return
}
SensorsAnalyticsSDK.track(key: .reviewClick(model), page: self)
let viewController = ReviewDetailViewController.instantiateFromSB
viewController.reviewId = model._id
let module_name = (model as? AnalyticsModelType)?.module_name ?? ""
viewController.previousValue = (pageName, module_name)
navigationController?.pushViewController(viewController, animated: true)
}
执行 ChannelBrowse 浏览事件
1
SensorsAnalyticsSDK.track(key: .channelBrowse(model), page: self)
具体实现
1
2
3
4
5
6
7
8
9
10
11
static func track(key: SensorsAnalyticsKey, page: UIViewController? = nil) {
case .channelBrowse(let model):
guard let page = page else {
return
}
var value = model.analytics
value["previous_page_name"] = page.previousValue.0
value["previous_module_name"] = page.page.previousValue.1
value["page_name"] = page.pageName
track(key.rawValue, value)
}
可以看到对于浏览事件的实现其实并不复杂，整个过程只是走了一点弯路。