Nodejs日志记录中间件morgan的使用

Nodejs日志记录中间件morgan的使用
Morgan 是一个非常流行的 Node.js 日志中间件，主要用于 HTTP 请求的日志记录。它可以帮助你轻松地记录请求的详细信息，如请求方法、URL、HTTP 版本、客户端 IP 地址等。

安装 Morgan

首先，你需要安装 Morgan。可以通过 npm 来安装：

npm install morgan

基本使用

安装完成后，你可以在你的 Express 应用中引入并配置 Morgan。以下是一个基本的示例：

const express = require('express');
const morgan = require('morgan');

const app = express();

// 使用 Morgan 中间件
app.use(morgan('combined'));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

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

在这个例子中，我们使用了 Morgan 的 combined 格式来记录日志。combined 是 Apache 的 Combined Log Format，它包含了很多有用的信息，如请求的方法、状态码、响应时间等。

自定义日志格式

如果你想要自定义日志的输出格式，可以传入一个格式字符串或函数给 Morgan。例如，你可以创建一个简单的自定义格式：

app.use(morgan(':method :url :status :res[content-length] - :response-time ms'));

或者，你可以传入一个函数来完全控制日志的生成：

app.use(morgan(function (tokens, req, res) {
  return [
    tokens.method(req, res),
    tokens.url(req, res),
    tokens.status(req, res),
    tokens.res(req, res, 'content-length'), '-',
    tokens['response-time'](req, res), 'ms'
  ].join(' ');
}));

指定日志文件

如果你想将日志写入到一个文件而不是标准输出，可以使用 fs 模块来创建一个 write stream，并将其传递给 Morgan：

const fs = require('fs');
const path = require('path');

const logDirectory = path.join(__dirname, 'log');

// 确保日志目录存在
fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory);

const accessLogStream = fs.createWriteStream(path.join(logDirectory, 'access.log'), { flags: 'a' });

app.use(morgan('combined', { stream: accessLogStream }));

这样，所有的访问日志都会被写入到 log/access.log 文件中。

结论

Morgan 提供了强大的功能来帮助你记录 HTTP 请求的详细信息。通过上述步骤，你可以轻松地在你的 Node.js 应用中集成 Morgan，并根据需要进行定制。