《使用模塊化工具打包自己開發的JS庫》 文章中有提到,當時需要寫一個SDK,監控小程序的后臺接口調用和頁面報錯,今天就來說下實現原理吧! 原理之前也做過瀏覽器web端的SDK數據埋點上報,其實原理大同小異:通過劫持原始方法,獲取需要上報的數據,最后再執行原始方法,這樣就能實現無痕埋點。 舉個例子:我希望監控所有web頁面的ajax請求,每次發送ajax,都需要在控制臺打印出發送的url 平時我們開發,發送ajax一般用的都是封裝好的庫,例如jQuery,Axios等,然而這些庫,底層仍然用的是瀏覽器原生的XMLHttpRequest對象,因此,我們只需要修改XMLHttpRequest對象即可 注意:由于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); 在這個立即執行函數中,我們把原生的 open 方法通過 originOpen 暫時存儲起來,然后在外面包裹一層函數,實現了打印輸出url的功能,最后通過 originOpen.apply 讓原生方法運行,這樣就實現了無痕攔截。 監控小程序攔截wx.request小程序的運行環境并沒有 window 和 document 對象,它只暴露了一個 wx 全局對象,發送網絡請求則是通過wx.request這個api,因此,這次我們需要攔截的就是 wx.request 方法 我們試著更改一下 wx.request wx.request = function() { console.log('66666'); } 這時控制臺會報錯 TypeError: Cannot set property request of #<Object> which has only a getter 這是因為, wx.request 這個屬性,只有 get 方法而沒有 set 方法,我們可以通過 Object.getOwnPropertyDescriptor 驗證: const des = Object.getOwnPropertyDescriptor(wx, 'request'); // des { // configurable: true, // enumerable: true, // get: f(), // set: undefined // } 我們可以換種方式修改: 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 先注冊一個該方法: App({ onError: function(err) { console.log('上報錯誤啦!'); wx.request({ url: 'http://monitor.com/monitor/error', data: err }) } }) App({ // 其他邏輯 }) 不過需要注意的是:如果后續的程序重寫了onError的話,將會導致之前注冊的onError失效。 解決方法可以是:我們監控SDK可以暴露一個接口,讓接入方自己在onError中調用我們的接口。 App({ onError: function (err) { monitor.notifyError(err) } }) 上報數據收集好需要的數據后,當然就要上報后臺。怎么上報?當然還是用的 wx.request 發送請求。 這里就容易出現一個 死循環 : 如果用之前被我們包裝過的 wx.request 上報數據,那么上報數據這個ajax請求,也會被我們認為是普通的ajax請求,然后又會觸發上報,這樣來來回回,無窮無盡的發送上報數據。 解決方法有多種,比如: 方案1可以在包裝 wx.request 的時候,判斷發送的url如果是上報接口,那么就不再上報了。 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 方法,所有的上報請求,就不走被包裝過的方法,而走最原始的方法。 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的代碼結構,上報前的數據收集和聚合等等,本文就不詳細展開了。 |