uniapp开发app框架在提升开发效率中的独特优势与应用探索
389
2023-11-11
JS实现监控微信小程序的原理
原理
之前也做过浏览器web端的SDK数据埋点上报，其实原理大同小异：通过劫持原始方法，获取需要上报的数据，最后再执行原始方法，这样就能实现无痕埋点。
举个例子：我希望监控所有web页面的ajax请求，每次发送ajax，都需要在控制台打印出发送的url
平时我们开发，发送ajax一般用的都是封装好的库，例如jQuery,Axios等，然而这些库，底层仍然用的是浏览器原生的XMLHttpRequest对象，因此，我们只需要修改XMLHttpRequest对象即可
注意：由于js的灵活性，修改原生方法是一件很容易的事，然而并不鼓励这样做！
?
1
2
3
4
5
6
7
8
9
// 把这段代码放在所有JS代码之前，我们就实现了拦截ajax的需求
window.XMLHttpRequest.prototype.open = (function(originOpen) {
return function(method, url, async) {
console.log(发送了ajax，url是: , url);
return originOpen.apply(this, arguments);
};
})(window.XMLHttpRequest.prototype.open);
在这个立即执行函数中，我们把原生的 open 方法通过 originOpen 暂时存储起来，然后在外面包裹一层函数，实现了打印输出url的功能，最后通过 originOpen.apply 让原生方法运行，这样就实现了无痕拦截。
监控小程序
拦截wx.request
小程序的运行环境并没有 window 和 document 对象，它只暴露了一个 wx 全局对象，发送网络请求则是通过wx.request这个api，因此，这次我们需要拦截的就是 wx.request 方法
我们试着更改一下 wx.request
?
1
2
3
wx.request = function() {
console.log(66666);
}
这时控制台会报错 TypeError: Cannot set property request of #<Object> which has only a getter
这是因为， wx.request 这个属性，只有 get 方法而没有 set 方法，我们可以通过 Object.getOwnPropertyDescriptor 验证：
我们可以换种方式修改：
?
1
2
3
4
5
6
7
8
9
10
11
12
13
const originRequest = wx.request;
Object.defineProperty(wx, request, {
configurable: true,
enumerable: true,
writable: true,
value: function() {
const config = arguments[0] || {};
const url = config.url;
console.log(发送了ajax，url是: , url);
return originRequest.apply(this, arguments);
}
});
这次就实现拦截功能了！
监控异常
小程序的注册函数 App 有个全局的 onError 方法，我们可以在小程序的入口文件 app.js 先注册一个该方法:
?
1
2
3
4
5
6
7
8
9
10
11
App({ onError: function(err) {
console.log(上报错误啦！);
wx.request({
url: http://monitor.com/monitor/error,
data: err
})
}
})
App({
// 其他逻辑
})
不过需要注意的是：如果后续的程序重写了onError的话，将会导致之前注册的onError失效。
解决方法可以是：我们监控SDK可以暴露一个接口，让接入方自己在onError中调用我们的接口。
?
1
2
3
4
5
App({
onError: function (err) {
monitor.notifyError(err)
}
})
上报数据
收集好需要的数据后，当然就要上报后台。怎么上报？当然还是用的 wx.request 发送请求。
这里就容易出现一个 死循环 : 如果用之前被我们包装过的 wx.request 上报数据，那么上报数据这个ajax请求，也会被我们认为是普通的ajax请求，然后又会触发上报，这样来来回回，无穷无尽的发送上报数据。
解决方法有多种，比如：
方案1
可以在包装 wx.request 的时候，判断发送的url如果是上报接口，那么就不再上报了。
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
const originRequest = wx.request;
Object.defineProperty(wx, request, {
configurable: true,
enumerable: true,
writable: true,
value: function() {
const config = arguments[0] || {};
const url = config.url;
if (url.indexOf(http://monitor.com) > -1) {
// 直接发送请求，不上报
return originRequest.apply(this, arguments);
}
console.log(上报ajax数据啦!);
wx.request({
url: http://monitor.com/monitor/ajax,
data: config.data
})
return originRequest.apply(this, arguments);
}
});
方案2
在包装 wx.request 之前，保留一份最原始的 wx.request 方法，所有的上报请求，就不走被包装过的方法，而走最原始的方法。
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
const myRequest = wx.request;
const wrapRequest = function () {
const originRequest = wx.request;
Object.defineProperty(wx, request, {
configurable: true,
enumerable: true,
writable: true,
value: function() {
const config = arguments[0] || {};
const url = config.url;
console.log(上报数据啦!);
// 使用最原始的request方法
myRequest({
url: http://monitor.com/monitor/ajax,
data: config.data
})
return originRequest.apply(this, arguments);
}
});
}
wrapRequest();
其他事项
实际开发中当然还有更多的细节，比如监控项目的鉴权，SDK的代码结构，上报前的数据收集和聚合等等，本文就不详细展开了。
总结
以上所述是小编给大家介绍的JS实现监控微信小程序的原理，希望对大家有所帮助，如果大家
您可能感兴趣的文章:微信小程序 轮播图实现原理及优化详解微信小程序button标签open-type属性原理解析微信小程序事件流原理解析微信小程序wxml列表渲染原理解析微信小程序 下拉刷新及上拉加载原理解析微信小程序 冒泡事件原理解析微信小程序之数据绑定原理解析解析从小程序开发者工具源码看原理实现
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
相关文章
发表评论
最近发表
推荐文章
热评文章
暂时没有评论，来抢沙发吧~