express默認(rèn)日志組件morgan的方法
章節(jié)概覽
morgan是express默認(rèn)的日志中間件，也可以脫離express，作為node.js的日志組件單獨(dú)使用。本文由淺入深，內(nèi)容主要包括：
- morgan使用入門例子
- 如何將日志保存到本地文件
- 核心API使用說明及例子
- 進(jìn)階使用：1、日志分割 2、將日志寫入數(shù)據(jù)庫
- 源碼剖析：morgan的日志格式以及預(yù)編譯
入門例子
首先，初始化項(xiàng)目。
npm install express morgan
然后，在basic.js中添加如下代碼。
var express = require('express');
var app = express();
var morgan = require('morgan');
app.use(morgan('short'));
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
node basic.js運(yùn)行程序，并在瀏覽器里訪問 http://127.0.0.1:3000 ，打印日志如下
➜ 2016.12.11-advanced-morgan git:(master) ✗ node basic.js
::ffff:127.0.0.1 - GET / HTTP/1.1 304 - - 3.019 ms
::ffff:127.0.0.1 - GET /favicon.ico HTTP/1.1 200 2 - 0.984 ms
將日志打印到本地文件
morgan支持stream配置項(xiàng)，可以通過它來實(shí)現(xiàn)將日志落地的效果，代碼如下：
var express = require('express');
var app = express();
var morgan = require('morgan');
var fs = require('fs');
var path = require('path');
var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
app.use(morgan('short', {stream: accessLogStream}));
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
使用講解
核心API
morgan的API非常少，使用頻率最高的就是morgan()，作用是返回一個(gè)express日志中間件。
morgan(format, options)
參數(shù)說明如下：
- format：可選，morgan與定義了幾種日志格式，每種格式都有對(duì)應(yīng)的名稱，比如combined、short等，默認(rèn)是default。不同格式的差別可參考這里。下文會(huì)講解下，如果自定義日志格式。
- options：可選，配置項(xiàng)，包含stream（常用）、skip、immediate。
- stream：日志的輸出流配置，默認(rèn)是process.stdout。
- skip：是否跳過日志記錄，使用方式可以參考這里。
- immediate：布爾值，默認(rèn)是false。當(dāng)為true時(shí)，一收到請求，就記錄日志；如果為false，則在請求返回后，再記錄日志。
自定義日志格式
首先搞清楚morgan中的兩個(gè)概念：format 跟 token。非常簡單：
- format：日志格式，本質(zhì)是代表日志格式的字符串，比如 :method :url :status :res[content-length] - :response-time ms。
- token：format的組成部分，比如上面的:method、:url即使所謂的token。
搞清楚format、token的區(qū)別后，就可以看下morgan中，關(guān)于自定義日志格式的關(guān)鍵API。
morgan.format(name, format); // 自定義日志格式 morgan.token(name, fn); // 自定義token
自定義format
非常簡單，首先通過morgan.format()定義名為joke的日志格式，然后通過morgan('joke')調(diào)用即可。
var express = require('express');
var app = express();
var morgan = require('morgan');
morgan.format('joke', '[joke] :method :url :status');
app.use(morgan('joke'));
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
我們來看下運(yùn)行結(jié)果
➜ 2016.12.11-advanced-morgan git:(master) ✗ node morgan.format.js
[joke] GET / 304
[joke] GET /favicon.ico 200
自定義token
代碼如下，通過morgan.token()自定義token，然后將自定義的token，加入自定義的format中即可。
var express = require('express');
var app = express();
var morgan = require('morgan');
// 自定義token
morgan.token('from', function(req, res){
return req.query.from || '-';
});
// 自定義format，其中包含自定義的token
morgan.format('joke', '[joke] :method :url :status :from');
// 使用自定義的format
app.use(morgan('joke'));
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
運(yùn)行程序，并在瀏覽器里先后訪問 http://127.0.0.1:3000/hello?from=app 和 http://127.0.0.1:3000/hello?from=pc
➜ 2016.12.11-advanced-morgan git:(master) ✗ node morgan.token.js
[joke] GET /hello?from=app 200 app
[joke] GET /favicon.ico 304 -
[joke] GET /hello?from=pc 200 pc
[joke] GET /favicon.ico 304 -
高級(jí)使用
日志切割
一個(gè)線上應(yīng)用，如果所有的日志都落地到同一個(gè)本地文件，時(shí)間久了，文件會(huì)變得非常大，既影響性能，又不便于查看。這時(shí)候，就需要用到日志分割了。
借助file-stream-rotator插件，可以輕松完成日志分割的工作。除了file-stream-rotator相關(guān)的配置代碼，其余跟之前的例子差不多，這里不贅述。
var FileStreamRotator = require('file-stream-rotator')
var express = require('express')
var fs = require('fs')
var morgan = require('morgan')
var path = require('path')
var app = express()
var logDirectory = path.join(__dirname, 'log')
// ensure log directory exists
fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory)
// create a rotating write stream
var accessLogStream = FileStreamRotator.getStream({
date_format: 'YYYYMMDD',
filename: path.join(logDirectory, 'access-%DATE%.log'),
frequency: 'daily',
verbose: false
})
// setup the logger
app.use(morgan('combined', {stream: accessLogStream}))
app.get('/', function (req, res) {
res.send('hello, world!')
})
日志寫入數(shù)據(jù)庫
有的時(shí)候，我們會(huì)有這樣的需求，將訪問日志寫入數(shù)據(jù)庫。這種需求常見于需要實(shí)時(shí)查詢統(tǒng)計(jì)的日志系統(tǒng)。
在morgan里該如何實(shí)現(xiàn)呢？從文檔上，并沒有看到適合的擴(kuò)展接口。于是查閱了下morgan的源碼，發(fā)現(xiàn)實(shí)現(xiàn)起來非常簡單。
回顧下之前日志寫入本地文件的例子，最關(guān)鍵的兩行代碼如下。通過stream指定日志的輸出流。
var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
app.use(morgan('short', {stream: accessLogStream}));
在morgan內(nèi)部，大致實(shí)現(xiàn)是這樣的（簡化后）。
// opt為配置文件 var stream = opts.stream || process.stdout; var logString = createLogString(); // 偽代碼，根據(jù)format、token的定義，生成日志 stream.write(logString);
于是，可以用比較取巧的方式來實(shí)現(xiàn)目的：聲明一個(gè)帶write方法的對(duì)象，并作為stream配置傳入。
var express = require('express');
var app = express();
var morgan = require('morgan');
// 帶write方法的對(duì)象
var dbStream = {
write: function(line){
saveToDatabase(line); // 偽代碼，保存到數(shù)據(jù)庫
}
};
// 將 dbStream 作為 stream 配置項(xiàng)的值
app.use(morgan('short', {stream: dbStream}));
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
深入剖析
morgan的代碼非常簡潔，從設(shè)計(jì)上來說，morgan的生命周期包含：
token定義 --> 日志格式定義 -> 日志格式預(yù)編譯 --> 請求達(dá)到/返回 --> 寫日志
其中，token定義、日志格式定義前面已經(jīng)講到，這里就只講下 日志格式預(yù)編譯 的細(xì)節(jié)。
跟模板引擎預(yù)編譯一樣，日志格式預(yù)編譯，也是為了提升性能。源碼如下，最關(guān)鍵的代碼就是compile(fmt)。
function getFormatFunction (name) {
// lookup format
var fmt = morgan[name] || name || morgan.default
// return compiled format
return typeof fmt !== 'function'
? compile(fmt)
: fmt
}
compile()方法的實(shí)現(xiàn)細(xì)節(jié)這里不贅述，著重看下compile(fmt)返回的內(nèi)容：
var morgan = require('morgan');
var format = morgan['tiny'];
var fn = morgan.compile(format);
console.log(fn.toString());
運(yùn)行上面程序，輸出內(nèi)容如下，其中tokens其實(shí)就是morgan。
function anonymous(tokens, req, res
/**/) {
return ""
+ (tokens["method"](req, res, undefined) || "-") + " "
+ (tokens["url"](req, res, undefined) || "-") + " "
+ (tokens["status"](req, res, undefined) || "-") + " "
+ (tokens["res"](req, res, "content-length") || "-") + " - "
+ (tokens["response-time"](req, res, undefined) || "-") + " ms";
}
看下morgan.token()的定義，就很清晰了
function token (name, fn) {
morgan[name] = fn
return this
}
以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
Nodemon是一個(gè)Node.js開發(fā)工具,用于自動(dòng)監(jiān)控文件變化并重啟服務(wù)器,本文就來介紹一下Nodemon工具的具體使用,具有一定的參考價(jià)值,感興趣的可以了解一下2024-12-12
對(duì)mac下nodejs 更新到最新版本的最新方法(推薦)
今天小編就為大家分享一篇對(duì)mac下nodejs 更新到最新版本的最新方法(推薦)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-05-05
Node.js?內(nèi)置模塊fs文件系統(tǒng)操作示例詳解
這篇文章主要為大家介紹了Node.js?內(nèi)置模塊fs文件系統(tǒng)操作示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-02-02
這篇文章主要介紹了node.js 事件循環(huán)的相關(guān)資料，文中講解非常細(xì)致，代碼幫助大家更好的理解和學(xué)習(xí)，感興趣的朋友可以了解下2020-07-07
今天小編就為大家分享一篇nodejs aes 加解密實(shí)例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-10-10
Nodejs中使用puppeteer控制瀏覽器中視頻播放功能
本項(xiàng)目主要功能為在瀏覽器中自動(dòng)播放視頻，并且實(shí)現(xiàn)音量控制，快進(jìn)快退，全屏控制，播放暫停控制等功能。對(duì)Nodejs中使用puppeteer控制瀏覽器中視頻播放功能感興趣的朋友跟隨小編一起看看吧2019-08-08
這篇文章主要介紹了Node.js 中如何收集和解析命令行參數(shù)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01
Node.js學(xué)習(xí)之TCP/IP數(shù)據(jù)通訊(實(shí)例講解)
下面小編就為大家?guī)硪黄狽ode.js學(xué)習(xí)之TCP/IP數(shù)據(jù)通訊(實(shí)例講解)。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-10-10
Node.js實(shí)現(xiàn)連接mysql數(shù)據(jù)庫功能示例
這篇文章主要介紹了Node.js實(shí)現(xiàn)連接mysql數(shù)據(jù)庫功能,簡單分析了nodejs連接數(shù)據(jù)庫的操作步驟與相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2017-09-09
這篇文章主要介紹了如何制作一個(gè)Node命令行圖像識(shí)別工具，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-12-12