express默认日志组件morgan的方法

章节概览

morgan是express默认的日志中间件,也可以脱离express,作为node.js的日志组件单独使用。本文由浅入深,内容主要包括:

  1. morgan使用入门例子
  2. 如何将日志保存到本地文件
  3. 核心API使用说明及例子
  4. 进阶使用:1、日志分割 2、将日志写入数据库
  5. 源码剖析:morgan的日志格式以及预编译

入门例子

首先,初始化项目。

然后,在basic.js中添加如下代码。

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配置项,可以通过它来实现将日志落地的效果,代码如下:

使用讲解

核心API

morgan的API非常少,使用频率最高的就是morgan(),作用是返回一个express日志中间件。

参数说明如下:

  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。

自定义format

非常简单,首先通过morgan.format()定义名为joke的日志格式,然后通过morgan('joke')调用即可。

我们来看下运行结果

➜ 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中即可。

// 使用自定义的format
app.use(morgan('joke'));
app.use(function(req,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 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指定日志的输出流。

在morgan内部,大致实现是这样的(简化后)。

于是,可以用比较取巧的方式来实现目的:声明一个带write方法的对象,并作为stream配置传入。

// 带write方法的对象
var dbStream = {
write: function(line){
saveToDatabase(line); // 伪代码,保存到数据库
}
};

// 将 dbStream 作为 stream 配置项的值
app.use(morgan('short',{stream: dbStream}));
app.use(function(req,next){
res.send('ok');
});

app.listen(3000);

深入剖析

morgan的代码非常简洁,从设计上来说,morgan的生命周期包含:

token定义 --> 日志格式定义 -> 日志格式预编译 --> 请求达到/返回 --> 写日志

其中,token定义、日志格式定义前面已经讲到,这里就只讲下 日志格式预编译 的细节。

跟模板引擎预编译一样,日志格式预编译,也是为了提升性能。源码如下,最关键的代码就是compile(fmt)。

// return compiled format
return typeof fmt !== 'function'
? compile(fmt)
: fmt
}

compile()方法的实现细节这里不赘述,着重看下compile(fmt)返回的内容:

console.log(fn.toString());

运行上面程序,输出内容如下,其中tokens其实就是morgan。

看下morgan.token()的定义,就很清晰了

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持编程之家。

相关文章

根据官网 入门 express
java叫接口control什么的app.get.post等等都是请求方式我们可...
为了前端丢进去的时候可以直接判断中间件就是经过了这个就会...
Express 文件的上传和下载
运行命令下载app.js 增加中间件。
基本模板来的 后面用后就有什么加什么都行。