Node 進階：express 默認日誌組件 morgan 從入門使用到源碼剖析

本文摘錄自我的總結《Nodejs學習筆記》，更多章節及更新，請訪問 github主頁地址。歡迎加羣交流，羣號 197339705。

章節概覽

morgan是express默認的日誌中間件，也能夠脫離express，做爲node.js的日誌組件單獨使用。本文由淺入深，內容主要包括：

• morgan使用入門例子

• 如何將日誌保存到本地文件

• 核心API使用說明及例子

• 進階使用：一、日誌分割 二、將日誌寫入數據庫

• 源碼剖析：morgan的日誌格式以及預編譯

入門例子

首先，初始化項目。

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運行程序，並在瀏覽器裏訪問 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配置項，能夠經過它來實現將日誌落地的效果，代碼以下：

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()，做用是返回一個express日誌中間件。

morgan(format, options)

參數說明以下：

• format：可選，morgan與定義了幾種日誌格式，每種格式都有對應的名稱，好比combined、short等，默認是default。不一樣格式的差異可參考這裏。下文會講解下，若是自定義日誌格式。

• options：可選，配置項，包含stream（經常使用）、skip、immediate。

  • stream：日誌的輸出流配置，默認是process.stdout。

  • skip：是否跳過日誌記錄，使用方式能夠參考這裏。

  • immediate：布爾值，默認是false。當爲true時，一收到請求，就記錄日誌；若是爲false，則在請求返回後，再記錄日誌。

自定義日誌格式

首先搞清楚morgan中的兩個概念：format 跟 token。很是簡單：

• format：日誌格式，本質是表明日誌格式的字符串，好比 :method :url :status :res[content-length] - :response-time ms。

• token：format的組成部分，好比上面的:method、:url即便所謂的token。

搞清楚format、token的區別後，就能夠看下morgan中，關於自定義日誌格式的關鍵API。

morgan.format(name, format);  // 自定義日誌格式
morgan.token(name, fn);  // 自定義token

自定義format

很是簡單，首先經過morgan.format()定義名爲joke的日誌格式，而後經過morgan('joke')調用便可。

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);

咱們來看下運行結果

➜  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);

運行程序，並在瀏覽器裏前後訪問 http://127.0.0.1:3000/hello?f... 和 http://127.0.0.1:3000/hello?f...

➜  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 -

高級使用

日誌切割

一個線上應用，若是全部的日誌都落地到同一個本地文件，時間久了，文件會變得很是大，既影響性能，又不便於查看。這時候，就須要用到日誌分割了。

藉助file-stream-rotator插件，能夠輕鬆完成日誌分割的工做。除了file-stream-rotator相關的配置代碼，其他跟以前的例子差很少，這裏不贅述。

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!')
})

日誌寫入數據庫

有的時候，咱們會有這樣的需求，將訪問日誌寫入數據庫。這種需求常見於須要實時查詢統計的日誌系統。

在morgan裏該如何實現呢？從文檔上，並無看到適合的擴展接口。因而查閱了下morgan的源碼，發現實現起來很是簡單。

回顧下以前日誌寫入本地文件的例子，最關鍵的兩行代碼以下。經過stream指定日誌的輸出流。

var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
app.use(morgan('short', {stream: accessLogStream}));

在morgan內部，大體實現是這樣的（簡化後）。

// opt爲配置文件
var stream = opts.stream || process.stdout;
var logString = createLogString();  // 僞代碼，根據format、token的定義，生成日誌
stream.write(logString);

因而，能夠用比較取巧的方式來實現目的：聲明一個帶write方法的對象，並做爲stream配置傳入。

var express = require('express');
var app = express();
var morgan = require('morgan');

// 帶write方法的對象
var dbStream = {
  write: function(line){
    saveToDatabase(line);  // 僞代碼，保存到數據庫
  }
};

// 將 dbStream 做爲 stream 配置項的值
app.use(morgan('short', {stream: dbStream}));
app.use(function(req, res, next){
  res.send('ok');
});

app.listen(3000);

深刻剖析

morgan的代碼很是簡潔，從設計上來講，morgan的生命週期包含：

token定義 --> 日誌格式定義 -> 日誌格式預編譯 --> 請求達到/返回 --> 寫日誌

其中，token定義、日誌格式定義前面已經講到，這裏就只講下 日誌格式預編譯 的細節。

跟模板引擎預編譯同樣，日誌格式預編譯，也是爲了提高性能。源碼以下，最關鍵的代碼就是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()方法的實現細節這裏不贅述，着重看下compile(fmt)返回的內容：

var morgan = require('morgan');
var format = morgan['tiny'];
var fn = morgan.compile(format);

console.log(fn.toString());

運行上面程序，輸出內容以下，其中tokens其實就是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
}

相關連接

《Nodejs學習筆記》：https://github.com/chyingp/no...
官方文檔：https://github.com/expressjs/...