微信小程序集成前端日志庫(kù)的詳細(xì)記錄

更新時(shí)間：2024年07月25日 08:35:22 作者：人工智能的茍富貴

這篇文章主要給大家介紹了關(guān)于微信小程序集成前端日志庫(kù)的詳細(xì)記錄,文中通過(guò)代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用微信小程序具有一定的參考借鑒價(jià)值,需要的朋友可以參考下

在微信小程序內(nèi)接入日志庫(kù)的記錄

在開(kāi)發(fā)微信小程序時(shí)，為了更好地調(diào)試和維護(hù)代碼，通常需要記錄日志信息。我嘗試了多種日志庫(kù)，包括Winston、pion和loglevel，并最終選擇了loglevel作為日志庫(kù)，并實(shí)現(xiàn)了日志上傳到服務(wù)器的功能。本文詳細(xì)記錄了這一過(guò)程，以供參考。

使用Winston失敗

最初，我嘗試在微信小程序中使用Winston日志庫(kù)。然而，Winston依賴Node.js的部分核心模塊（如stream、path和os），這些模塊在微信小程序的環(huán)境中不可用。這導(dǎo)致了編譯和運(yùn)行時(shí)錯(cuò)誤。

示例錯(cuò)誤信息：

Module not found: Error: Can't resolve 'stream' in 'node_modules/winston/dist/winston/transports'

手動(dòng)編寫(xiě)日志庫(kù)：

為了繞過(guò)上述這些問(wèn)題，我嘗試手動(dòng)編寫(xiě)一個(gè)簡(jiǎn)單的日志庫(kù)。該庫(kù)能夠記錄日志，并根據(jù)配置將日志發(fā)送到服務(wù)器

示例代碼：

// utils/logger.js
import {
  getEnvironment
} from './env'
class Logger {
  constructor(config) {
    this.level = config.level || 'info';
    this.sendToServer = config.sendToServer || false;
    this.serverUrl = config.serverUrl || '';
    this.printInDev = config.printInDev || false;
  }

  log(level = this.level, message) {
    const env = getEnvironment()
    if (this.shouldLog(level)) {
      if (typeof message === 'undefined') {
        message = level;
        level = this.level;
      }
      //通過(guò)配置參數(shù)控制是否打印
      if (this.printInDev || env == 'prod' || env == 'test') {
        console.log(`[${level.toUpperCase()}]: ${message}`);
      }
      if (this.sendToServer) {
        if (env == 'prod' || env == 'test') {
          this.sendLogToServer(level, message);
        }
      }
    }
  }

  info(message) {
    this.log('info', message);
  }

  warn(message) {
    this.log('warn', message);
  }

  error(message) {
    this.log('error', message);
  }

  shouldLog(level) {
    const levels = ['info', 'warn', 'error'];
    const currentLevelIndex = levels.indexOf(this.level);
    const messageLevelIndex = levels.indexOf(level);
    return messageLevelIndex >= currentLevelIndex;
  }

  sendLogToServer(level, message) {
    wx.request({
      url: this.serverUrl,
      method: 'POST',
      data: {
        level,
        message,
      },
      success(res) {
        console.log('Log sent to server:', res);
      },
      fail(err) {
        console.error('Failed to send log to server:', err);
      },
    });
  }
}

module.exports = Logger;

app.js使用：

引入模塊

const Logger = require('./utils/logger.js');

在小程序onLaunch中初始化并掛在到wx

//實(shí)例話 Logger
    const logger = new Logger({
      level: env, // 可配置為 'info', 'warning', 'error'
      sendToServer: true, // 是否發(fā)送到服務(wù)端
      printInDev: false, //開(kāi)發(fā)環(huán)境是否打印日志
      serverUrl: 'https://your-server-url.com/logs', // 服務(wù)端 URL
    });
    wx.logger = logger; //掛載到wx

使用小程序onError捕獲異常

 onError(error) {
    wx.logger.log(error);
  },

最后重寫(xiě)小程序page(),使日志庫(kù)能夠監(jiān)聽(tīng)頁(yè)面生命周期

// utils/overridePage.js

function overridePage() {
  const logger = wx.logger;
  const originalPage = Page;
  Page = function (pageConfig) {
    const originalOnLoad = pageConfig.onLoad;
    pageConfig.onLoad = function (options) {
      logger.log(`Page loaded: ${this.route}`);
      if (originalOnLoad) originalOnLoad.call(this, options);
    };

    const originalOnShow = pageConfig.onShow;
    pageConfig.onShow = function () {
      logger.log(`Page shown: ${this.route}`);
      if (originalOnShow) originalOnShow.call(this);
    };

    const originalOnHide = pageConfig.onHide;
    pageConfig.onHide = function () {
      logger.log(`Page hidden: ${this.route}`);
      if (originalOnHide) originalOnHide.call(this);
    };

    const originalOnUnload = pageConfig.onUnload;
    pageConfig.onUnload = function () {
      logger.log(`Page unloaded: ${this.route}`);
      if (originalOnUnload) originalOnUnload.call(this);
    };


    originalPage(pageConfig);
  };
}

module.exports = overridePage;

const overridePage = require('./utils/overridePage.js');

 wx.logger = logger; //掛載到wx
 overridePage(); //重寫(xiě)page

使用loglevel

為了簡(jiǎn)化日志記錄，我們決定使用更輕量級(jí)的loglevel庫(kù)。loglevel可以很方便地在微信小程序中使用，并且我們可以通過(guò)插件實(shí)現(xiàn)日志上傳功能。

安裝loglevel：

npm install loglevel

下載完成后，需要使用微信的npm構(gòu)建功能

在小程序內(nèi)使用loglevel

app.js
import log from 'loglevel';
onlaunch(){
log.setLevel('info'); //設(shè)置 loglevel 日志輸出級(jí)別 
log.trace('This is a trace message');
log.debug('This is a debug message');
log.info('This is an info message');
log.warn('This is a warning message');
log.error('This is an error message');
}

日志上傳服務(wù)器，loglevel的上傳插件使用XMLHttpRequest()上傳，小程序內(nèi)不支持，需要重寫(xiě)上傳模塊，下附上傳插件源碼鏈接

https://github.com/artemyarulin/loglevel-serverSend/blob/master/loglevel-serverSend.js

重寫(xiě)上傳模塊

// utils/loglevel-server-send-wx.js
var loglevelServerSend = function (options) {
  var _url = options && options.url || 'http://localhost:8000/main/log',
    _callOriginal = options && options.callOriginal || false,
    _prefix = options && options.prefix,
    _sendQueue = [],
    _isSending = false;

  var _sendNextMessage = function () {
    if (!_sendQueue.length || _isSending) return;

    _isSending = true;

    var msg = _sendQueue.shift();
    wx.request({
      url: _url,
      method: 'POST',
      data: msg,
      header: {
        'Content-Type': 'text/plain'
      },
      success: function () {
        _isSending = false;
        setTimeout(_sendNextMessage, 0);
      },
      fail: function () {
        _isSending = false;
        setTimeout(_sendNextMessage, 0);
      }
    });
  };

  wx.log = {
    log: function (level, message) {
      if (typeof _prefix === 'string') message = _prefix + message;
      else if (typeof _prefix === 'function') message = _prefix(level, message);
      else message = level + ': ' + message;

      console.log(`[${level.toUpperCase()}]: ${message}`);
      if (options && options.sendToServer) {
        _sendQueue.push(message);
        _sendNextMessage();
      }
    },
    info: function (message) {
      this.log('info', message);
    },
    warn: function (message) {
      this.log('warn', message);
    },
    error: function (message) {
      this.log('error', message);
    }
  };
};

module.exports = loglevelServerSend;

在app.js 中調(diào)用

const loglevelServerSend = require('./utils/loglevel-server-send-wx.js');
onLaunch(){
log.setLevel('info'); //設(shè)置 日志輸出級(jí)別 
wx.log = log; //掛載到wx

//wx.log*等觸發(fā)日志上傳服務(wù)端
    loglevelServerSend({
      url: 'https://your-server-url.com/logs',
      prefix: function (level, message) {
        return `[${new Date().toISOString()}] [${level.toUpperCase()}]: ${message}`;
      },
      sendToServer: env === 'dev' || env === 'test' || env === 'pre' || env === 'prod', //設(shè)置允許上傳日志的環(huán)境
      callOriginal: false // 上傳日志時(shí)是否控制臺(tái)打印
    });
    wx.log.level = 'info'; //動(dòng)態(tài)改變?nèi)罩据敵龅募?jí)別
}

//捕獲異常
onError(error) {
    wx.log.log('error', error);
  },

獲取小程序當(dāng)前環(huán)境

如需根據(jù)小程序環(huán)境動(dòng)態(tài)設(shè)置日志輸出級(jí)別，添加以下模塊

// utils/environment.js
function getEnvironment() {
  return __wxConfig.envVersion;
}

function getLogLevel(env) {
  const levels = {
    'develop': 'info',
    'trial': 'warning',
    'pre': 'error',
    'release': 'error'
  };
  return levels[env] || 'info';
}

module.exports = { getEnvironment, getLogLevel };