如何在 Express.js 中进行日志处理？

引言

在开发 Web 应用程序时，日志处理是不可或缺的一项工作，以便开发人员更好地了解应用程序的运行状态和错误信息。而在 Node.js 服务器端框架中，Express.js 可谓当仁不让的首选。

本文将重点介绍如何在 Express.js 中进行日志处理，让你更好的掌握日志处理技巧。

快速入门

在 Express.js 中，我们可以使用如下代码段来处理日志信息：

// javascriptcn.com 代码示例
const express = require('express');
const morgan = require('morgan');
const app = express();

app.use(morgan('dev'));

// 数据处理逻辑
// ...

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在以上代码中，我们使用了 morgan 中间件来输出日志信息。

接下来，我们详细了解 morgan 中间件的实现原理。

Morgan 中间件

morgan 是一个 Node.js 中间件，用于在控制台或日志文件中输出 HTTP 请求的信息。它提供了多种格式化日志信息的方式，便于开发人员对输出信息进行处理和分析。

安装

我们可以通过 npm 安装 morgan：

npm install morgan --save

使用方式

安装完 morgan 之后，我们可以通过下面几种方式使用它：

使用默认设置

我们可以使用 morgan 的默认设置来输出日志信息。

// javascriptcn.com 代码示例
const express = require('express');
const morgan = require('morgan');
const app = express();

// 使用默认设置
app.use(morgan('dev'));

// 数据处理逻辑
// ...

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的示例中，我们调用了 morgan 函数，并将其返回的中间件传递给了 Express.js 的 app.use 方法。使用 dev 作为参数调用 morgan 方法，将使用默认设置输出日志信息。

默认情况下，这将在控制台上输出类似如下的信息：

GET / 200 54.036 ms - 2739

这条记录告诉我们，某个客户端使用 GET 方法访问了服务器上的某个资源，并在 54 毫秒之后成功响应 200 状态码和 2739 字节的数据。

定制输出格式

我们还可以自定义日志输出格式。

// javascriptcn.com 代码示例
const express = require('express');
const morgan = require('morgan');
const app = express();

// 定制日志格式
morgan.token('custom', (req, res) => {
  return 'custom message';
});
app.use(morgan(':method :url ::custom'));

// 数据处理逻辑
// ...

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的示例中，我们使用 morgan.token API 定义了一个自定义的格式化函数 custom，将这个函数的返回值输出到日志信息中。然后，我们在调用 morgan 中间件时使用 :method, :url 和 ::custom 来定义日志格式。

输出方式

在 Express.js 中，我们可以使用多种方式输出日志信息：

• 在控制台上输出
• 将日志信息写入文件
• 将日志信息发送到远程日志分析服务

在使用 morgan 中间件时，我们可以通过更改传递给它的信息处理程序，将数据输出到不同的目标位置。

在控制台上输出

这是 morgan 默认使用的方法。在控制台中查看日志信息，使用 dev、short、tiny 或 combined 等字符串作为参数即可。不同的字符串代表不同的输出方式，如下表所示：

写入日志文件

我们可以将日志信息写入文件，以便在出现问题时查找错误信息。使用 fs 模块创建和写入日志文件即可。

// javascriptcn.com 代码示例
const express = require('express');
const morgan = require('morgan');
const fs = require('fs');
const path = require('path');
const app = express();

// 创建日志目录
const logDir = path.join(__dirname, 'logs');
if (!fs.existsSync(logDir)) {
  fs.mkdirSync(logDir);
}

// 创建日志文件
const fileName = path.join(logDir, 'access.log');
const accessLogStream = fs.createWriteStream(fileName, { flags: 'a' });

// 将输出重定向到文件
app.use(morgan('combined', { stream: accessLogStream }));

// 数据处理逻辑
// ...

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的示例中，我们创建了一个文件流来写入日志文件，并将其传递给 morgan 中间件。传递 { stream: accessLogStream } 选项即可将输出信息重定向到日志文件。

发送到远程日志分析服务

最后，我们可以将日志信息发送到日志分析服务，例如使用 Elasticsearch、Logstash 和 Kibana 进行分析和监控。

我们可以使用一个专门的 morgan 流插件将日志转发到远程服务器。

// javascriptcn.com 代码示例
const express = require('express');
const morgan = require('morgan');
const elasticsearch = require('elasticsearch');
const Stream = require('stream');
const app = express();

// 连接到 Elasticsearch 集群
const client = new elasticsearch.Client({ host: 'localhost:9200' });

// 创建流插件
const esStream = new Stream.Writable();
esStream._write = (chunk, enc, next) => {
  const body = JSON.parse(chunk.toString());
  client.index({
    index: 'access-logs',
    type: 'access-log',
    body
  }, (err, resp) => {
    if (err) {
      console.error(err);
    }
  });
  next();
};

// 将输出重定向到 Elasticsearch
app.use(morgan('combined', { stream: esStream }));

// 数据处理逻辑
// ...

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的示例中，我们创建了一个流插件，它将日志信息转发到 Elasticsearch 集群中的索引 access-logs。在重定向输出时使用这个插件即可实现将日志信息发送到远程日志服务的目的。

总结

本文详细介绍了如何在 Express.js 中进行日志处理，特别介绍了 morgan 中间件的使用方法，以及如何将日志信息输出到不同的目标位置。希望本文对大家在开发 Web 应用程序时进行日志处理有所帮助。

参考文献

• Express.js 官方文档
• morgan 中间件官方文档
• Elasticsearch 官方文档

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64f8acd5f6b2d6eab3092945