前端统计SDK (设计思路分析-初步代码实现)

1. 分析

前端统计的范围(基本统计,更详细的需要根据自己项目的需求进行添加)
  • 访问量PV
  • 自定义事件 (如统计一个按钮被点击了多少次)
  • 网页性能
  • 错误信息
统计数据的流程
  • 前端发送统计数据给服务端(详细数据格式与后端协商制定)
  • 服务端接受,并处理统计数据
  • 查看统计结果,根据结果分析优化系统,产生闭环

2. 代码结构

SDK要用于多个不同的产品,所以初始化要传入 productId

class MyStatistic {
    private productId: number

    constructor(productId: number = 0) {
        if (productId <= 0) {
            throw new Error('productId is invalid')
        }
        this.productId = productId // 产品 id (SDK 会被用于多个产品)

        this.initPerformance() // 性能统计
        this.initError() // 监听错误
    }
    private send(url: string, paramObj: object = {}) {
        // 发送统计数据
    }
    private initPerformance() {
        // 性能统计
    }
    private initError() {
        // 监听全局错误(有些错误需要主动传递过来,如 Vue React try-catch 的)
    }
    pv() {
        // 访问量 PV 统计
    }
    event(key: string, value: string) {
        // 自定义事件
    }
    error(key: string, info: object = {}) {
        // 错误统计
    }
}

使用 因为要做性能统计所以初始化要在 DOMContentLoaded 或 onload 中进行

const myStatistic = new MyStatistic('SFCP')

2.1 发送数据 - send

发送统计数据,用<img>标签,因为浏览器兼容性非常好,且没有跨域限制

private send(url: string, paramObj: object = {}) {
    // 追加 productId
    paramObj.productId = this.productId

    // params 参数拼接为字符串
    const paramArr = []
    for (let key in paramObj) {
        const value = paramObj[key]
        paramArr.push(`${key}=${value}`)
    }
    const param = `?${paramArr.join('&')}` // ?key=value&key1=value1&key2=value2

    const img = document.createElement('img')
    img.src = url + param
}

这里可以进一步优化,send中可以使用requestIdleCallback:“空闲时才执行,低优”(兼容使用setTimeout)

2.2 自定义事件 - event

event(key: string, value: string) {
    const url = 'xxx' // 接受自定义事件的 API
    this.send(url, { key, value }) // 发送
}

使用

// 如需要统计某个弹框的“同意” “不同意” “取消” 三个按钮的点击量,即可使用自定义事件统计
$agreeBtn.click(() => {
    // ...业务逻辑...
    myStatistic.event('some-button', 'agree') // 其他不同的按钮,传递不同的 value (如 'refuse' 'cancel')
})

具体传递的参数和后端协商制定

2.3 访问量 - pv

pv可以通过自定义事件的方式,但是为了避免用户重复发送,需要加一个判断
根据不同的产品来设计,有的产品访问当前不同的页面每次访问就会+1,有的产品只要访问了一次,无论再访问其他的页面也只会算一次, 具体根据业务来判断。

// 定义一个全局的 Set ,记录已经发送 pv 的 url
const PV_URL_SET = new Set()
pv() {
    const href = location.href
    if (PV_URL_SET.has(href)) return // 判断当前页面是否访问过

    this.event('pv', '') // 发送 pv
    PV_URL_SET.add(href)
}

使用

myStatistic.pv()

PV统计需要让用户自己发送吗?能不能在DOMContentLoaded时自动发送?最好让用户发送,因为SPA中切换路由也可能发送PV

2.4 性能统计 - initPerformance

通过performance.timing可以看到网页的各个性能

private initPerformance() {
    const url = 'xxx' // 接受性能统计的 API
    this.send(url, performance.timing) // 全部传给服务端,让服务端去计算结果 —— 统计尽量要最原始数据,不要加工处理
}

想要得到全面的性能数据,要在网页加载之后(DOMContentLoadedonload) 去初始化 myStatistic

2.5 错误统计 - initError - error

监听全局操作

private initError() {
    // 全局操作
    window.addEventListener('error', event => {
        const { error, lineno, colno } = event
        this.error(error, { lineno, colno })
    })
    // Promise 未 catch 的报错
    window.addEventListener("unhandledrejection", event => {
        this.error(event.reason)
    })
}

主动收集的错误,调用API来统计

error(error: Error, info: object = {}) {
    // error 结构 { message, stack }
    // info 是附加信息

    const url = 'xxx' // 接受错误统计的 API
    const { message, stack } = error
    this.send(url, { message, stack, ...info })
}

使用 结合 统一监听Vue组件报错方案

// try catch
try {
    100()
} catch (e) {
    myStatistic.error(e)
}

// Vue 错误监听
app.config.errorHandler = (error, instance, info) => {
    myStatistic.error(error, { info })
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容