JS实现监控微信小程序实现原理

2020-04-1719:57:42WEB前端开发Comments2,051 views字数 2285阅读模式

原理

之前也做过浏览器web端的SDK数据埋点上报,其实原理大同小异:通过劫持原始方法,获取需要上报的数据,最后再执行原始方法,这样就能实现无痕埋点。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

举个例子:我希望监控所有web页面的ajax请求,每次发送ajax,都需要在控制台打印出发送的url文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

平时我们开发,发送ajax一般用的都是封装好的库,例如jQuery,Axios等,然而这些库,底层仍然用的是浏览器原生的XMLHttpRequest对象,因此,我们只需要修改XMLHttpRequest对象即可文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

注意:由于JS的灵活性,修改原生方法是一件很容易的事,然而并不鼓励这样做!文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

// 把这段代码放在所有JS代码之前,我们就实现了拦截ajax的需求
 = (function(originOpen) {
    return function(method, url, async) {
        
        ('发送了ajax,url是: ', url);

        return (this, arguments);
    };
})();

在这个立即执行函数中,我们把原生的open方法通过originOpen暂时存储起来,然后在外面包裹一层函数,实现了打印输出url的功能,最后通过让原生方法运行,这样就实现了无痕拦截。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

监控小程序

拦截

小程序的运行环境并没有windowdocument对象,它只暴露了一个wx全局对象,发送网络请求则是通过这个api,因此,这次我们需要拦截的就是方法文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

我们试着更改一下文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

 = function() {
    ('66666');
}

这时控制台会报错TypeError: Cannot set property request of #<Object> which has only a getter文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

这是因为,这个属性,只有get方法而没有set方法,我们可以通过验证:文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

const des = (wx, 'request');

//  des {
//   configurable: true,
//   enumerable: true,
//   get: f(),
//   set: undefined
// }

我们可以换种方式修改:文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

const originRequest = ;
Object.defineProperty(wx, 'request', {
    configurable: true,
    enumerable: true,
    writable: true,
    value: function() {
        const config = arguments[0] || {};
        const url = config.url;
        ('发送了ajax,url是: ', url);

        return originRequest.apply(this, arguments);
    }
});

这次就实现拦截功能了!文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

监控异常

小程序的注册函数App有个全局的onError方法,我们可以在小程序的入口文件先注册一个该方法:文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

App({
    onError: function(err) {
        ('上报错误啦!');
        ({
            url: '',
            data: err
        })
    }
})

App({
    // 其他逻辑
})

不过需要注意的是:如果后续的程序重写了onError的话,将会导致之前注册的onError失效。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

解决方法可以是:我们监控SDK可以暴露一个接口,让接入方自己在onError中调用我们的接口。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

App({
  onError: function (err) {
    (err)
  }
})

上报数据

收集好需要的数据后,当然就要上报后台。怎么上报?当然还是用的发送请求。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

这里就容易出现一个死循环: 如果用之前被我们包装过的上报数据,那么上报数据这个ajax请求,也会被我们认为是普通的ajax请求,然后又会触发上报,这样来来回回,无穷无尽的发送上报数据。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

解决方法有多种,比如:文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

方案1文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

可以在包装的时候,判断发送的url如果是上报接口,那么就不再上报了。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

const originRequest = ;
Object.defineProperty(wx, 'request', {
    configurable: true,
    enumerable: true,
    writable: true,
    value: function() {
        const config = arguments[0] || {};
        const url = config.url;
        if (('') > -1) {
            // 直接发送请求,不上报
            return originRequest.apply(this, arguments);
        }

        ('上报ajax数据啦!');
        ({
            url: '/monitor/ajax',
            data: 
        })

        return originRequest.apply(this, arguments);
    }
});

方案2文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

在包装之前,保留一份最原始的方法,所有的上报请求,就不走被包装过的方法,而走最原始的方法。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

const myRequest = ;

const wrapRequest = function () {
    const originRequest = ;
    Object.defineProperty(wx, 'request', {
        configurable: true,
        enumerable: true,
        writable: true,
        value: function() {
            const config = arguments[0] || {};
            const url = config.url;
       
            ('上报数据啦!');
            // 使用最原始的request方法
            myRequest({
                url: '/monitor/ajax',
                data: 
            })

            return originRequest.apply(this, arguments);
        }
    });
}

wrapRequest();

其他事项

实际开发中当然还有更多的细节,比如监控项目的鉴权,SDK的代码结构,上报前的数据收集和聚合等等,本文就不详细展开了。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/gcs/18193.html

  • 本站内容整理自互联网,仅提供信息存储空间服务,以方便学习之用。如对文章、图片、字体等版权有疑问,请在下方留言,管理员看到后,将第一时间进行处理。
  • 转载请务必保留本文链接:https://www.cainiaoxueyuan.com/gcs/18193.html

Comment

匿名网友 填写信息

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定