Koa日志中間件封裝開發(fā)的示例分析

小編給大家分享一下Koa日志中間件封裝開發(fā)的示例分析，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！

對(duì)于一個(gè)服務(wù)器應(yīng)用來(lái)說(shuō)，日志的記錄是必不可少的，我們需要使用其記錄項(xiàng)目程序每天都做了什么，什么時(shí)候發(fā)生過(guò)錯(cuò)誤，發(fā)生過(guò)什么錯(cuò)誤等等，便于日后回顧、實(shí)時(shí)掌握服務(wù)器的運(yùn)行狀態(tài)，還原問(wèn)題場(chǎng)景。

日志的作用

• 記錄服務(wù)器程序運(yùn)行狀態(tài)；

• 幫助開發(fā)者快速捕獲錯(cuò)誤，定位以及決解故障。

日志中間件開發(fā)工具log4js

1. 在node當(dāng)中沒(méi)有自帶的日志模塊，所以需要使用第三方模塊

2. 使用模塊：log4js

3. 安裝： npm i log4js -S

4. logsjs官方文檔

5. 日志分類:

1. 訪問(wèn)日志: 記錄客戶端對(duì)項(xiàng)目的訪問(wèn)，主要是 http 請(qǐng)求。用于幫助改進(jìn)和提升網(wǎng)站的性能和用戶體驗(yàn)；

2. 應(yīng)用日志： 項(xiàng)目標(biāo)記和記錄位置打印的日志，包括出現(xiàn)異常情況，方便查詢項(xiàng)目的運(yùn)行狀態(tài)和定位bug（包含了debug、info、warn 和 error等級(jí)別）。

日志等級(jí)

• 如果配置了日志等級(jí)，則其只能記錄日志等級(jí)比設(shè)置的更高級(jí)別的日志信息

• 日志等級(jí)圖

如配置level: 'error',則只能輸出error,fatar,mark級(jí)別的日志信息

日志中間件開發(fā)

設(shè)置需要日志需要記錄的信息段(log_info.js)

export default (ctx, message, commonInfo) => {
  const {
   method, // 請(qǐng)求方法
   url,     // 請(qǐng)求鏈接
   host,   // 發(fā)送請(qǐng)求的客戶端的host
   headers   // 請(qǐng)求中的headers
  } = ctx.request;
  const client = {
   method,
   url,
   host,
   message,
   referer: headers['referer'], // 請(qǐng)求的源地址
   userAgent: headers['user-agent'] // 客戶端信息 設(shè)備及瀏覽器信息
  }
  return JSON.stringify(Object.assign(commonInfo, client));
}

設(shè)置通用獲取配置后的log4js對(duì)象（logger.js）

const getLog = ({env, appLogLevel, dir}, name) => {
  
  //log4js基本說(shuō)明配置項(xiàng)，可自定義設(shè)置鍵名，用于categories.appenders自定義選取
  let appenders = {
    // 自定義配置項(xiàng)1
    cheese: {
      type: 'dateFile', //輸出日志類型
      filename: `${dir}/task`, //輸出日志路徑
      pattern: '-yyyy-MM-dd.log', //日志文件后綴名（task-2019-03-08.log）
      alwaysIncludePattern: true
    }
  }
  // 如果為開發(fā)環(huán)境配置在控制臺(tái)上打印信息
  if (env === "dev" || env === "local" || env === "development") {
    // 自定義配置項(xiàng)2
    appenders.out = {
     type: "stdout"
    }
  }
  // log4js配置
  let config = {
    appenders,
    //作為getLogger方法獲取log對(duì)象的鍵名，default為默認(rèn)使用
    categories: {
     default: {
      appenders: Object.keys(appenders), // 取appenders中的說(shuō)有配置項(xiàng)
      level: appLogLevel
     }
    }
  }
  log4js.configure(config) //使用配置項(xiàng)
  return log4js.getLogger(name)// 這個(gè)cheese參數(shù)值先會(huì)在categories中找，找不到就會(huì)默認(rèn)使用default對(duì)應(yīng)的appenders,信息會(huì)輸出到y(tǒng)yyyMMdd-out.log
}

log日志中間件開發(fā)（logger.js）

export default (options) => {
  const contextLogger = {}; //后期賦值給ctx.log
  const { env, appLogLevel, dir, serverIp, projectName } = Object.assign({}, baseInfo, options || {});
  // 取出通用配置（項(xiàng)目名，服務(wù)器請(qǐng)求IP）
  const commonInfo = { projectName, serverIp };

  const logger = getLog({env, appLogLevel, dir},'cheese');

  return async (ctx, next) => {
    const start = Date.now(); //日志記錄開始時(shí)間
    // 將日志類型賦值ctx.log，后期中間件特殊位置需要記錄日志，可直接使用ctx.log.error(err)記錄不同類型日志
    methods.forEach((method, i) => {
      contextLogger[method] = (message) => {
        logger[method](logInfo(ctx, message, commonInfo))
      }
    })
    ctx.log = contextLogger;
    // 執(zhí)行中間件
    await next()
    // 結(jié)束時(shí)間
    const responseTime = Date.now() - start;
    // 將執(zhí)行時(shí)間記錄logger.info
    logger.info(logInfo(ctx,
      {
        responseTime: `響應(yīng)時(shí)間為${responseTime/1000}s`
      }, commonInfo)
    )
  }
}

中間件使用（app.js）

import Log from '../log/logger';
...
app.use(Log({
    env: app.env, // koa 提供的環(huán)境變量
    projectName: 'back-API',
    appLogLevel: 'debug',
    dir: 'logs',
    serverIp: ip.address()
  }))

其他特殊位置需要日志記錄使用

ctx.log.error(err.stack); //記錄錯(cuò)誤日志
ctx.log.info(err.stack); // 記錄信息日志
ctx.log.warn(err.stack); // 記錄警告日志
...

運(yùn)行截圖

log4js使用基本配置和流程解析

設(shè)置配置項(xiàng),

// 配置項(xiàng)形式
{
  appenders:{
    [自定義key]:{}
  },
  categories:{
  }
}
// 配置
config: {
  appenders:{
    // 每一個(gè)屬性可以看作為一個(gè)配置模塊
    out: {
      type: 'dateFile', //輸出日志類型
      filename: `log/task`, //輸出日志路徑
      pattern: '-yyyy-MM-dd.log', //日志文件后綴名（task-2019-03-08.log）
      ...//具體配置看官網(wǎng)
    },
    error: {
      type: 'dateFile',
      filename: 'log/error',
      pattern: '-yyyy-MM-dd.log'',
      "alwaysIncludePattern": true
    },
    stdout: { type: 'stdout' }, //在控制臺(tái)上打印信息
  },
  // 通過(guò)categories來(lái)取出給log4js按需配置，返回配置后的log4js對(duì)象，每個(gè)屬性配置相當(dāng)于一個(gè)不同的log4js配置對(duì)象入口；default為默認(rèn)入口（getLogger（）找不到入口時(shí)默認(rèn)使用default）
  categories:{
    // 配置默認(rèn)入口，使用appenders中的'stdout','out'配置模塊，記錄trace以上等級(jí)日志
    default: { appenders: ['stdout','out'], level: 'trace' },
    // 配置error門入口，使用appenders中的'stdout','err'配置模塊，記錄error以上等級(jí)日志
    error : {appenders: ['err'], level: 'error'}
  }
}

使用let logger_out = log4js.getLogger('app');

log4js.getLogger('app')查找特定log4js對(duì)象流程：先根據(jù)app參數(shù)值在categories中找，發(fā)現(xiàn)沒(méi)有app，然后就會(huì)默認(rèn)使用default對(duì)應(yīng)的appenders進(jìn)行配置,即信息會(huì)輸出到log/task-yyyy-mm-dd.log文件中，并且會(huì)輸出到控制臺(tái)

使用let logger_out = log4js.getLogger('error');

根據(jù)error參數(shù)值在categories中找，發(fā)現(xiàn)沒(méi)有擁有error配置，然后就會(huì)使用error對(duì)應(yīng)的appenders進(jìn)行配置,即信息會(huì)輸出到log/error-yyyy-mm-dd.log文件中，因?yàn)閑rror的配置項(xiàng)appenders中沒(méi)有使用stdout模塊，所以信息不會(huì)輸出到控制臺(tái)

看完了這篇文章，相信你對(duì)“Koa日志中間件封裝開發(fā)的示例分析”有了一定的了解，如果想了解更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀！