埋點(diǎn)方案的確定
業(yè)界的埋點(diǎn)方案主要分為以下三類:
代碼埋點(diǎn):在需要埋點(diǎn)的節(jié)點(diǎn)調(diào)用接口卸奉,攜帶數(shù)據(jù)上傳睬塌。如百度統(tǒng)計(jì)等;
可視化埋點(diǎn):使用可視化工具進(jìn)行配置化的埋點(diǎn)昆庇,即所謂的「無(wú)痕埋點(diǎn)」末贾,前端在頁(yè)面加載時(shí),可以讀取配置數(shù)據(jù)整吆,自動(dòng)調(diào)用接口進(jìn)行埋點(diǎn)拱撵。如開(kāi)源的Mixpanel;
無(wú)埋點(diǎn):前端自動(dòng)采集全部事件并上報(bào)埋點(diǎn)數(shù)據(jù)。如國(guó)內(nèi)的神策數(shù)據(jù)等表蝙;
在當(dāng)時(shí)排期緊湊拴测,人力緊缺的情況下,顯然不允許我們?nèi)ラ_(kāi)發(fā)可視化埋點(diǎn)方案和無(wú)埋點(diǎn)方案勇哗,所以只能采取代碼埋點(diǎn)方案昼扛。
命令式埋點(diǎn)
命令式埋點(diǎn),顧名思義欲诺,開(kāi)發(fā)者需要手動(dòng)在需要埋點(diǎn)的節(jié)點(diǎn)處進(jìn)行埋點(diǎn)抄谐。如點(diǎn)擊按鈕或鏈接后的回調(diào)函數(shù)、頁(yè)面ready時(shí)進(jìn)行請(qǐng)求的發(fā)送扰法。大家肯定都很熟悉這樣的代碼:
// 頁(yè)面加載時(shí)發(fā)送埋點(diǎn)請(qǐng)求
$(document).ready(function(){
// ... 這里存在一些業(yè)務(wù)邏輯
sendRequest(params);
});
// 按鈕點(diǎn)擊時(shí)發(fā)送埋點(diǎn)請(qǐng)求
$('button').click(function(){
// ... 這里存在一些業(yè)務(wù)邏輯
sendRequest(params);
});
可以很容易發(fā)現(xiàn)蛹含,這樣的做法很有可能會(huì)將埋點(diǎn)代碼侵入業(yè)務(wù)代碼,這使整體業(yè)務(wù)代碼變得繁瑣塞颁,容易出錯(cuò)浦箱,且后續(xù)代碼會(huì)愈加膨脹,難以維護(hù)祠锣。所以酷窥,我們需要讓埋點(diǎn)的代碼與具體的業(yè)務(wù)邏輯解耦,即 聲明式埋點(diǎn) 伴网,從而提高埋點(diǎn)的效率和代碼的可維護(hù)性蓬推。
聲明式埋點(diǎn)
理論上,聲明式埋點(diǎn)只需要關(guān)注兩個(gè)問(wèn)題:
需要埋點(diǎn)的DOM節(jié)點(diǎn)澡腾;
所需攜帶的數(shù)據(jù)
因此沸伏,可以很快想出一個(gè)聲明式埋點(diǎn)的方法:
// key表示埋點(diǎn)的唯一標(biāo)識(shí)糕珊;act表示埋點(diǎn)方式
<button data-stat="{key:'111', act: 'click'}">埋點(diǎn)</button>
那么可以去遍歷DOM樹(shù),找到 [data-stat] 的節(jié)點(diǎn)毅糟,給這個(gè)button綁上click事件红选,把這些參數(shù)在回調(diào)函數(shù)中通過(guò)請(qǐng)求發(fā)出去。
在DOM節(jié)點(diǎn)(html)上聲明埋點(diǎn)姆另,與業(yè)務(wù)邏輯(通常在Javascript文件中)就解耦了喇肋。調(diào)用也很方便。
看起來(lái)很美迹辐,但這樣就能解決問(wèn)題了嗎苟蹈?顯然是不夠的。還需要解決以下問(wèn)題:
遍歷DOM樹(shù)的時(shí)機(jī)問(wèn)題右核,一個(gè)簡(jiǎn)單的例子,一個(gè)表格的行數(shù)據(jù)是通過(guò)異步加載渺绒,而表格行中的操作按鈕需要埋點(diǎn)贺喝,那么在DOM ready的時(shí)候去遍歷,顯然是無(wú)法找到的
綁定埋點(diǎn)事件次數(shù)的問(wèn)題宗兼,怎樣保證埋點(diǎn)事件不會(huì)被重復(fù)綁定到元素上躏鱼,一次操作發(fā)了N個(gè)埋點(diǎn)請(qǐng)求?
如何處理特有的埋點(diǎn)行為,如頁(yè)面展現(xiàn)埋點(diǎn)殷绍,區(qū)域展現(xiàn)埋點(diǎn)?
如何在解綁時(shí)染苛,銷毀已綁定的事件?
1.自定義指令實(shí)現(xiàn)埋點(diǎn)數(shù)據(jù)統(tǒng)計(jì)
在項(xiàng)目中通常需要做數(shù)據(jù)埋點(diǎn),這個(gè)時(shí)候主到,使用自定義指令將會(huì)變非常簡(jiǎn)單
在項(xiàng)目入口文件 main.js 中配置我們的自定義指令
// 坑位埋點(diǎn)指令
Vue.directive('stat', {
bind(el, binding) {
el.addEventListener('click', () => {
const data = binding.value;
let prefix = 'store';
if (OS.isAndroid || OS.isPhone) {
prefix = 'mall';
}
analytics.request({
ty: `${prefix}_${data.type}`,
dc: data.desc || ''
}, 'n');
}, false);
}
});
2.使用路由攔截統(tǒng)計(jì)頁(yè)面級(jí)別的 PV
由于第一次在單頁(yè)應(yīng)用中嘗試數(shù)據(jù)埋點(diǎn)茶行,在項(xiàng)目上線一個(gè)星期之后,數(shù)據(jù)統(tǒng)計(jì)后臺(tái)發(fā)現(xiàn)登钥,首頁(yè)的 PV 遠(yuǎn)遠(yuǎn)高于其它頁(yè)面畔师,數(shù)據(jù)很不正常。后來(lái)跟數(shù)據(jù)后臺(tái)的人溝通詢問(wèn)他們的埋點(diǎn)統(tǒng)計(jì)原理之后牧牢,才發(fā)現(xiàn)其中的問(wèn)題所在看锉。
傳統(tǒng)應(yīng)用,一般都在頁(yè)面加載的時(shí)候塔鳍,會(huì)有一個(gè)異步的 js 加載伯铣,就像百度的統(tǒng)計(jì)代碼類似,所以我們每個(gè)頁(yè)面的加載的時(shí)候轮纫,都會(huì)統(tǒng)計(jì)到數(shù)據(jù)腔寡;然而在單頁(yè)應(yīng)用,頁(yè)面加載初始化只有一次蜡感,所以其它頁(yè)面的統(tǒng)計(jì)數(shù)據(jù)需要我們自己手動(dòng)上報(bào)
解決方案
使用 vue-router
的 beforeEach
或者 afterEach
鉤子上報(bào)數(shù)據(jù)蹬蚁,具體使用哪個(gè)最好是根據(jù)業(yè)務(wù)邏輯來(lái)選擇恃泪。
const analyticsRequest = (to, from) => {
// 只統(tǒng)計(jì)頁(yè)面跳轉(zhuǎn)數(shù)據(jù),不統(tǒng)計(jì)當(dāng)前頁(yè) query 不同的數(shù)據(jù)
// 所以這里只使用了 path, 如果需要統(tǒng)計(jì) query 的犀斋,可以使用 to.fullPath
if (to.path !== from.path) {
analytics.request({
url: `${location.protocol}//${location.host}${to.path}`
});
}
};
router.beforeEach((to, from, next) => {
if (to.matched.some(record => record.meta.requiresAuth)) {
// 這里做登錄等前置邏輯判斷
// 判斷通過(guò)之后贝乎,再上報(bào)數(shù)據(jù)
...
analyticsRequest(to, from);
} else {
// 不需要判斷的,直接上報(bào)數(shù)據(jù)
analyticsRequest(to, from);
next();
}
});
在組件中使用我們的自定義指令
基于 jquery + widget 的老項(xiàng)目叽粹,
那么在這些項(xiàng)目中的DOM操作是jquery甚至原生DOM API來(lái)實(shí)現(xiàn)览效,Vue的自定義指令就無(wú)法工作
基于MutationObserver API的Mixin
MutationObserver是在DOM3標(biāo)準(zhǔn)中提出的標(biāo)準(zhǔn)API,提供讓開(kāi)發(fā)者感知到在某一個(gè)DOM節(jié)點(diǎn)變更的能力虫几〈覆樱可以監(jiān)聽(tīng)以下場(chǎng)景:
childList: 目標(biāo)節(jié)點(diǎn)的子節(jié)點(diǎn)插入刪除引起的變更
attributes: 目標(biāo)節(jié)點(diǎn)屬性改變引起的變更
characterData: 目標(biāo)節(jié)點(diǎn)的文本節(jié)點(diǎn)改變引起的變更,如通過(guò)appendData()等
subtree: 目標(biāo)節(jié)點(diǎn)的子孫節(jié)點(diǎn)改變引起的變更
attributeOldValue:當(dāng)attribute監(jiān)聽(tīng)被設(shè)定為true時(shí)辆脸,可以記錄改變前的屬性值
characterDataOldValue:當(dāng)characterData監(jiān)聽(tīng)被設(shè)定為true時(shí)但校,可以記錄改變前的屬性值
attributeFilter:可以設(shè)定需要監(jiān)聽(tīng)的屬性列表
但為了保證MutationObserver可以在所有瀏覽器上正常工作,我們?nèi)匀灰肓诉@個(gè)API的polyfill,詳情可見(jiàn)這里啡氢。
在此能力的前提下状囱,我們就可以在任意的DOM操作下觸發(fā)Vue進(jìn)行重新解析指令。
我們將 MutationObserver 封裝進(jìn)一個(gè) Vue mixin , 非Vue應(yīng)用的業(yè)務(wù)代碼只需要引入這個(gè)mixin倘是,這樣也可以很好地解耦亭枷。
詳細(xì)的實(shí)現(xiàn)原理可以見(jiàn)以下偽代碼:
let observer;
export default {
ready() {
// 開(kāi)啟監(jiān)聽(tīng)
observer = new MutationObserver(mutations => {
this.$compile(this.$el);
});
observer.observe(this.$el, config);
},
destroyed() {
// 清理工作
observer.disconnect();
observer.takeRecords();
}
}
參考:
https://segmentfault.com/a/1190000011066120
https://zhuanlan.zhihu.com/p/27659302
http://webcomponents.org/polyfills/
https://www.zhihu.com/question/67951942/answer/259125217