如何在項目中使用log4.js

如何在項目中使用log4.js

pm2中自帶的日誌內容是不能知足平常的需求的，所以須要在項目中加上日誌管理，這裏研究了下log4的使用方法，效果挺好的，想要查看的均可以找到，記錄下簡單的使用步驟

log4的配合

// config.js

let path = require('path');

// 日誌根目錄
let baseLogPath = path.resolve(__dirname, '../../../logs');
// 請求日誌目錄
let reqPath = '/request';
// 請求日誌文件名
let reqFileName = 'request';
// 請求日誌輸出完整路徑
let reqLogPath = baseLogPath + reqPath + '/' + reqFileName;


// 響應日誌目錄
let resPath = '/response';
// 響應日誌文件名
let resFileName = 'response';
// 響應日誌輸出完整路徑
let resLogPath = baseLogPath + resPath + '/' + resFileName;

// 錯誤日誌目錄
let errPath = '/error';
// 錯誤日誌文件名
let errFileName = 'error';
// 錯誤日誌輸出完整路徑
let errLogPath = baseLogPath + errPath + '/' + errFileName;


module.exports = {
    appenders: {
        // 全部的日誌
        'console': {type: 'console'},
        // 請求日誌
        'reqLogger': {
            type: 'dateFile', // 日誌類型
            filename: reqLogPath, // 輸出文件名
            pattern: '-yyyy-MM-dd-hh.log',  // 後綴
            alwaysIncludePattern: true, // 上面兩個參數是否合併
            encoding: 'utf-8', // 編碼格式
            maxLogSize: 1000, // 最大存儲內容
        },
        // 響應日誌
        'resLogger': {
            type: 'dateFile',
            filename: resLogPath,
            pattern: '-yyyy-MM-dd-hh.log',
            alwaysIncludePattern: true,
            encoding: 'utf-8',
            maxLogSize: 1000,
        },
        // 錯誤日誌
        'errLogger': {
            type: 'dateFile',
            filename: errLogPath,
            pattern: '-yyyy-MM-dd-hh.log',
            alwaysIncludePattern: true,
            encoding: 'utf-8',
            maxLogSize: 1000,
        }
    },
    // 分類以及日誌等級
    categories: {
        default: {
            appenders: ['console'],
            level: 'all'
        },
        reqLogger: {
            appenders: ['reqLogger'],
            level: 'info'
        },
        resLogger: {
            appenders: ['resLogger'],
            level: 'info'
        },
        errLogger: {
            appenders: ['errLogger'],
            level: 'error'
        }
    },
}

log4的日誌封裝

這裏是把log4封裝成一箇中間件，在app.js中直接調用就能夠了

// 先安裝log4js

// log4.js

const log4Config = require('./config')
const log4js = require('log4js')

// 調用配置文件
log4js.configure(log4Config)


class CommonHandle {
    constructor(){}
    // 格式化請求日誌
    static formatReqLog(ctx, time){
        let text = '------------request start------------'
        let method = ctx.method
        text += `request method:  ${method} \n request url: ${ctx.originalUrl } \n`

        if(method = 'GET'){
            text += `request data: ${JSON.stringify(ctx.query)} \n`
        }else{
            text += `request data: ${JSON.stringify(ctx.body)} \n`
        }
        text += `ctx all: ${JSON.stringify(ctx)}`
        return text
    }
    // 格式化相應日誌
    static formatResLog(ctx,time){
        let text = '------------response start------------'
        text += `response result: ${JSON.stringify(ctx.response.body)} \n`

        text += `response all: ${JSON.stringify(ctx)} \n`

        text += `response time: ${time} \n`
        return text
    }
    // 格式化錯誤日誌
    static formatErrorLog(ctx,error,time){
        let text = '------------error start------------'
        text += this.formatResLog(ctx,time)
        text += `error content: ${JSON.stringify(error)}`

        return text
    }
}

class HandleLogger extends CommonHandle{
    constructor(){
        super()
    }

    // 請求日誌
    static reqLogger(ctx){
        log4js.getLogger('reqLogger').info(this.formatReqLog(ctx))
    }

    // 相應日誌
    static resLogger(ctx, time){
        log4js.getLogger('resLogger').info(this.formatResLog(ctx,time))
    }

    // 錯誤日誌
    static errorLogger(ctx, error, time){
        log4js.getLogger('errLogger').info(this.formatErrorLog(ctx,error,time))
    }

}





module.exports = (options) => {
    return async (ctx,next) => {
        const startTime = new Date()
        let period;
        try{
            // 請求日誌
            HandleLogger.reqLogger(ctx)
            await next()
            period = new Date() - startTime
            // 響應日誌
            HandleLogger.resLogger(ctx,period)
        }catch(err){
            period = new Date() - startTime
            // 錯誤日誌
            HandleLogger.errorLogger(ctx, err, period)
        }
    }
}

調用封裝好的日誌函數

這裏直接以中間件的形式調用就能夠了

// app.js

const Koa = require('koa')
const app = new Koa()
const LogJS = require('./common/log/log4')

// log4.js引入
app.use(LogJS())

最後部署上線以後就能直接在根目錄下的logs文件夾下查看對應的日誌內容。

連接地址