|
《使(shi)用(yong)模塊(kuai)化工(gong)具打包(bao)自(zi)己開發的JS庫(ku)》 文章中(zhong)有(you)提(ti)到(dao)，當時需(xu)要寫一個(ge)SDK，監(jian)控(kong)小程序的后臺接口(kou)調用(yong)和頁面(mian)報錯，今天就(jiu)來(lai)說下實現(xian)原理吧！ 原理之前也做過瀏覽器web端的(de)SDK數據(ju)埋(mai)點上報(bao)，其實原理大同小異：通過劫持原始方法，獲(huo)取需要上報(bao)的(de)數據(ju)，最后再執行原始方法，這樣就能實現無痕埋(mai)點。 舉個例子：我希望監控所有web頁(ye)面(mian)的ajax請求(qiu)，每次發送(song)ajax，都需要在控制臺打印出(chu)發送(song)的url 平時(shi)我們開發，發送ajax一般用(yong)的都是封裝好的庫，例如jQuery,Axios等(deng)，然(ran)而這些(xie)庫，底層(ceng)仍然(ran)用(yong)的是瀏覽器原生的XMLHttpRequest對(dui)象，因此，我們只需(xu)要(yao)修改XMLHttpRequest對(dui)象即可 注意：由于JS的靈活性，修改原生方法是一件很容易的事，然而并不鼓勵這樣做！
// 把這段代碼放在所有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);
在這(zhe)個立即執行(xing)函數(shu)(shu)中(zhong)，我們(men)把原生的 open 方(fang)法通(tong)過 originOpen 暫時存儲起來，然后在外面(mian)包裹(guo)一層(ceng)函數(shu)(shu)，實(shi)現(xian)了打印輸出url的功能，最(zui)后通(tong)過 originOpen.apply 讓原生方(fang)法運行(xing)，這(zhe)樣(yang)就實(shi)現(xian)了無痕攔(lan)截(jie)。 監控小程序攔截wx.request小(xiao)程序的運行環境(jing)并沒有 window 和 document 對象，它只暴露了(le)一個 wx 全局對象，發送網絡請求(qiu)則是通過wx.request這(zhe)(zhe)個api，因此(ci)，這(zhe)(zhe)次我們需要攔截的就是 wx.request 方(fang)法(fa) 我們試著更改一下 wx.request
wx.request = function() {
console.log('66666');
}
這時(shi)控制臺(tai)會報錯 TypeError: Cannot set property request of #<Object> which has only a getter 這(zhe)是因為(wei)， wx.request 這(zhe)個屬性(xing)，只有 get 方法而沒有 set 方法，我們可以通過 Object.getOwnPropertyDescriptor 驗證：
const des = Object.getOwnPropertyDescriptor(wx, 'request');
// des {
// configurable: true,
// enumerable: true,
// get: f(),
// set: undefined
// }
我們(men)可以換種(zhong)方式修改：
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);
}
});
這次就實現攔截功(gong)能了！ 監控異常小程序的注冊函數 App 有個全(quan)局的 onError 方法，我(wo)們可以在小程序的入(ru)口文件 app.js 先注冊一(yi)個該方法:
App({
onError: function(err) {
console.log('上報錯誤啦！');
wx.request({
url: '//monitor.com/monitor/error',
data: err
})
}
})
App({
// 其他邏輯
})
不(bu)過需要注意的(de)(de)是(shi)：如果后(hou)續的(de)(de)程序重寫了(le)onError的(de)(de)話，將會導(dao)致(zhi)之(zhi)前注冊(ce)的(de)(de)onError失(shi)效。 解決方法可以是：我們監控SDK可以暴(bao)露(lu)一個接(jie)口，讓接(jie)入(ru)方自己在onError中調用我們的接(jie)口。
App({
onError: function (err) {
monitor.notifyError(err)
}
})
上報數據收集(ji)好需要的(de)數據后(hou)，當然就(jiu)要上報后(hou)臺。怎么上報？當然還是用的(de) wx.request 發送請求。 這里就容易出(chu)現一個 死(si)循環 : 如果(guo)用(yong)之前被(bei)我們包裝過的 wx.request 上報數據(ju)，那么上報數據(ju)這個ajax請求(qiu)，也會被(bei)我們認為是普通的ajax請求(qiu)，然后(hou)又(you)會觸發上報，這樣來來回回，無窮無盡的發送上報數據(ju)。 解決(jue)方法有(you)多種，比如： 方案1可以在包裝 wx.request 的時候，判斷發送的url如果是上(shang)報接口，那么就不再上(shang)報了。
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('//monitor.com') > -1) {
// 直接發送請求，不上報
return originRequest.apply(this, arguments);
}
console.log('上報ajax數據啦!');
wx.request({
url: '//monitor.com/monitor/ajax',
data: config.data
})
return originRequest.apply(this, arguments);
}
});
方案2在包(bao)裝 wx.request 之(zhi)前，保留一份最原始的(de) wx.request 方法，所(suo)有的(de)上報請(qing)求，就不走被包(bao)裝過的(de)方法，而走最原始的(de)方法。
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: '//monitor.com/monitor/ajax',
data: config.data
})
return originRequest.apply(this, arguments);
}
});
}
wrapRequest();
其他事項實際開(kai)發中當然還有更多的(de)細節，比如監控項目的(de)鑒權，SDK的(de)代碼結(jie)構，上報前(qian)的(de)數據收集和聚(ju)合等等，本文就不詳細展開(kai)了。 |
