express預設日誌組件morgan使用詳解

這次帶給大家express預設日誌元件morgan使用詳解，使用express預設日誌元件morgan的注意事項有哪些，以下就是實戰案例，一起來看一下。

章節概覽

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

1. morgan使用入門範例

2. 如何將日誌儲存到本機檔案

3. 核心API使用說明及範例

4. 進階使用：1、日誌分割2、將日誌寫入資料庫

5. #原始碼剖析：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)

參數說明如下：

1. format：可選，morgan與定義了幾種日誌格式，每種格式都有對應的名稱，例如combined、short等，預設是default。不同格式的差異可參考這裡。下文會講解下，如果自訂日誌格式。

2. options：可選，設定項，包含stream（常用）、skip、immediate。

3. stream：日誌的輸出流配置，預設是process.stdout。

4. skip：是否跳過日誌記錄，使用方式可以參考這裡。

5. immediate：布林值，預設是false。當為true時，一收到請求，就記錄日誌；如果為false，則在請求返回後，再記錄日誌。

自訂日誌格式

先搞清楚morgan中的兩個概念：format 跟著 token。非常簡單：

1. format：日誌格式，本質是代表日誌格式的字串，例如 :method :url :status :res[content-length] - :response-time ms。

2. 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?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 -

高级使用

日志切割

一个线上应用，如果所有的日志都落地到同一个本地文件，时间久了，文件会变得非常大，既影响性能，又不便于查看。这时候，就需要用到日志分割了。

借助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
}

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

推荐阅读：

使用react redux中间件步骤详解

JS实现动态进度条步骤分析

nodejs中如何使用websocket（附代码）

以上是express預設日誌組件morgan使用詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！