JS實現監控微信小程序

博客地址

《使用模塊化工具打包本身開發的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的代碼結構，上報前的數據收集和聚合等等，本文就不詳細展開了。