章節概覽

morgan是express默認的日志中間件，也可以脫離express，作為node.js的日志組件單獨使用。本文由淺入深，內容主要包括：

morgan使用入門例子 如何將日志保存到本地文件 核心API使用說明及例子 進階使用：1、日志分割 2、將日志寫入數據庫 源碼剖析：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。