日志需要的文件
log // 存放日志的文件夾
>> access.log // 日志記錄文件
utils // 工具文件夾
>> log.js // 日志主要功能代碼
app.js
package.json
第一種:不使用第三方日志模塊方式
- 在utils/log.js文件中定義功能
const fs = require('fs')
const path = require('path')
// 獲取文件Strema流
function createWriteStrema(filename) {
// 獲取文件路徑
const fullFileName = path.join(__dirname, '../log', filename)
// 根據(jù)路徑獲取文件Strema流
const writeStrema = fs.createWriteStrema(fullFileName, {
flags: 'a' // 使用append方式向文件添加內(nèi)容
})
retrun writeStrema
}
const accessWriteStrema = createWriteStrema('access.log')
// 寫入日志
function writeLog(writeStrema, log) {
writeStrema.write(log + '\n') // 寫入到文件中
}
function access (log) {
writeLog(accessWriteStrema, log)
}
module.exports = {
access
}
- 在app.js中使用剛才寫的日志功能
const { access } = require('./utils/log')
// 在文件中寫上這個中間件
app.use(async (ctx, next) => {
// 定義Log格式
const log = `${ctx.method} -- ${ctx.url} -- ${ctx.headers['user-agent']} -- ${Date.now()}`
// 調(diào)用寫入文件方法
access(log)
// 跳到下一個中間件
next()
})
第二種:使用morgan模塊方式
下載morgan模塊
npm i koa-morganapp.js
// 1. 引入模塊
const morgan = require('koa-morgan')
const fs = require('fs')
const path = require('path')
// 2. 獲取記錄日志的文件
const writeStream =fs.createWriteStream(path.resolve(__dirname, './log', 'access.log'), {
flags: 'a'
})
// 3. 注冊中間件
// combined 代表使用較全的格式寫到文件中,這個參數(shù)可以參照官方文檔選擇自己需要的格式 https://github.com/expressjs/morgan
// :remote-addr - :remote-user [:date[clf]] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"
app.use(mogran('combined', {
stream: writeStream // 寫入到文件中
}))
這樣就可以了,在每次訪問的時候就會在日志中寫入一條記錄,如果在開發(fā)時不需要寫入到文件中,可以使用環(huán)境變量來區(qū)分
const ENV = process.env.NODE_ENV
// 如果不是正式環(huán)境就只在控制臺輸出 dev 格式的日志, 否則就寫入 combined 格式的日志到文件中
if (ENV !== 'production' ) {
app.use(morgan('dev'))
} else {
app.use(mogran('combined', {
stream: writeStream // 寫入到文件中
}))
}