JS實現監控微信小程式

深紅發表於2018-06-14
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的程式碼結構，上報前的資料收集和聚合等等，本文就不詳細展開了。

相關文章