專案自帶的日誌模組koa-logger

專案自帶的日誌系統是很給力的，我們隨便啟動一下下程式，請求一下地址我們就會看到控制檯上出現一堆GET啊啥的是這樣的

logger

超級簡單明瞭，通俗易懂，上面的輸出就是有一個GET請求請求了/目錄，然後處理這個get請求GET用時12ms（這段話是在app.js console.log的不算logger的）下面的處理請求GET，目錄是/,http響應碼是200，用時24ms 資料大小138b
真的是很厲害。但是這個logger不能夠生成本地日誌檔案和更加詳細的記錄。所以為了補全這個遺憾（不能叫缺點，本來人家就是隻負責控制檯輸出的）我們要再搗鼓另一個模組來處理這個問題。

日誌處理模組log4js

這個模組是個大而全的一各模組，有日誌等級分類，可以替換掉console.log輸出，可以生成本地的日誌檔案，甚至還可以傳送郵件把危險的日誌用郵件發出去（(⊙﹏⊙)b神奇）；

安裝log4js模組

建立log4js的配置檔案

log_config.js

'use strict';
var path = require('path');

//日誌根目錄
var baseLogPath = path.resolve(__dirname, '../logs')

//錯誤日誌目錄
var errorPath = "/error";
//錯誤日誌檔名
var
 
 errorFileName = "error";
//錯誤日誌輸出完整路徑
var errorLogPath = baseLogPath + errorPath + "/" + errorFileName;
// var errorLogPath = path.resolve(__dirname, "../logs/error/error");


//響應日誌目錄
var responsePath = "/response";
//響應日誌檔名
var responseFileName = "response";
//響應日誌輸出完整路徑
var responseLogPath = baseLogPath + responsePath + "/"
 
 + responseFileName;
// var responseLogPath = path.resolve(__dirname, "../logs/response/response");

var log_config = {
    "appenders":
    [
        //錯誤日誌
        {
            "category":"errorLogger",             //logger名稱
            "type": "dateFile",                   //日誌型別
            "filename": errorLogPath,             //日誌輸出位置
            "alwaysIncludePattern":true,          //是否總是有後綴名
            "pattern": "-yyyy-MM-dd-hh.log",      //字尾，每小時建立一個新的日誌檔案
            "path": errorPath                     //自定義屬性，錯誤日誌的根目錄
        },
        //響應日誌
        {
            "category":"resLogger",
            "type": "dateFile",
            "filename": responseLogPath,
            "alwaysIncludePattern":true,
            "pattern": "-yyyy-MM-dd-hh.log",
            "path": responsePath  
        }
    ],
    "levels":                                   //設定logger名稱對應的的日誌等級
    {
        "errorLogger":"ERROR",
        "resLogger":"ALL"
    },
    "baseLogPath": baseLogPath                  //logs根目錄
}

module.exports = log_config;

建立log4js的封裝模組

在app_need下面新建一檔案

log.js

'use strict';
var log4js = require('log4js');

var log_config = require('../config/log_config');

//載入配置檔案
log4js.configure(log_config);

var log = {};

var errorLogger = log4js.getLogger('errorLogger');
var resLogger = log4js.getLogger('resLogger');

//封裝錯誤日誌
log.logError = function (ctx, error, resTime) {
    if (ctx && error) {
        errorLogger.error(formatError(ctx, error, resTime));
    }
};

//封裝響應日誌
log.logResponse = function (ctx, resTime) {
    if (ctx) {
        resLogger.info(formatRes(ctx, resTime));
    }
};

//格式化響應日誌
var formatRes = function (ctx, resTime) {
    var logText = new String();

    //響應日誌開始
    logText += "\n" + "*************** response log start ***************" + "\n";

    //新增請求日誌
    logText += formatReqLog(ctx.request, resTime);

    //響應狀態碼
    logText += "response status: " + ctx.status + "\n";

    //響應內容
    logText += "response body: " + "\n" + JSON.stringify(ctx.body) + "\n";

    //響應日誌結束
    logText += "*************** response log end ***************" + "\n";

    return logText;

}

//格式化錯誤日誌
var formatError = function (ctx, err, resTime) {
    var logText = new String();

    //錯誤資訊開始
    logText += "\n" + "*************** error log start ***************" + "\n";

    //新增請求日誌
    logText += formatReqLog(ctx.request, resTime);

    //錯誤名稱
    logText += "err name: " + err.name + "\n";
    //錯誤資訊
    logText += "err message: " + err.message + "\n";
    //錯誤詳情
    logText += "err stack: " + err.stack + "\n";

    //錯誤資訊結束
    logText += "*************** error log end ***************" + "\n";

    return logText;
};

//格式化請求日誌
var formatReqLog = function (req, resTime) {

    var logText = new String();

    var method = req.method;
    //訪問方法
    logText += "request method: " + method + "\n";

    //請求原始地址
    logText += "request originalUrl:  " + req.originalUrl + "\n";

    //客戶端ip
    logText += "request client ip:  " + req.ip + "\n";

    //開始時間
    var startTime;
    //請求引數
    if (method === 'GET') {
        logText += "request query:  " + JSON.stringify(req.query) + "\n";
        // startTime = req.query.requestStartTime;
    } else {
        logText += "request body: " + "\n" + JSON.stringify(req.body) + "\n";
        // startTime = req.body.requestStartTime;
    }
    //伺服器響應時間
    logText += "response time: " + resTime + "\n";

    return logText;
}

module.exports = log;

監聽響應和錯誤

app.js的logger部分
修改的app.js初始部分

// logger
app.use(async (ctx, next) => {
  const start = new Date();
  await next();
  const ms = new Date() - start;
  console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);//列印請求的方式請求的url和請求所花費的時間
});

修改為：

//log工具
const log = require('./app_need/log');
// logger
app.use(async (ctx, next) => {
  const start = new Date();
  try {
    await next();

    const ms = new Date() - start;
    log.logResponse(ctx,ms);
    console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);//列印請求的方式請求的url和請求所花費的時


  } catch (e) {
    const ms = new Date() - start;
    log.logError(ctx,error,ms);
  }
});

再安裝log4js的依賴包

在終端裡專案最外層目錄

npm install log4js --save

重啟

重啟一下，然後訪問最外層目錄一下，從控制檯看來是和原來一樣的，但是看看檔案目錄就會發現多出來了
個檔案目錄是這樣的：
log

然後開啟response-2017-xxxxxxx看看

完美記錄了我們的請求響應。

額外擴充套件

現在基本的log日誌系統已經成型了，功能很完備，但是還是可以再擴充套件一下的，具體擴充套件就不寫了只是說下思路，

首先是不是每小時一個log檔案是不是太多了呢，之後找起來也麻煩

我們可以修改下log_config模組，讓他在log檔案的外層再放置一層目錄，這層目錄是會隨著天數的不同而改變的，這樣我們的響應請求就會分門別類到天上了，每天的資料夾裡最多有24個log。
同理我們是不是可以再設定月層次的目錄，和年層次的目錄呢？

其次要是我們在伺服器沒有生成資料夾的許可權怎麼辦。

我們就在www目錄裡寫入一個檢查許可權的程式碼，如果沒有許可權就報錯。

再者如果說我們想生成個測試log怎麼辦

我麼就在app_need/log裡面再寫一個方法，在log_config裡面單獨寫個配置，將生成的測試/debug,log全部寫在對應路徑裡
最終專案地址：https://github.com/jijuxie/koa2_all.git