Node.js 中 morgan 依赖详解
记录每个 HTTP 请求的详细信息，方便开发者调试和监控应用程序。
一、安装
npm install morgan二、基本使用
const express = require("express");
const morgan = require("morgan");
const app = express();
// 使用 morgan 中间件，默认日志格式为 'dev'
app.use(morgan("dev"));
app.get("/", (req, res) => {
res.send("Hello, World!");
});
const port = 3000;
app.listen(port, () => {
console.log(`Server running on port ${port}`);
});三、日志格式
`morgan` 提供了多种内置的日志格式，每种格式输出的信息不同。
1. `dev`
这是开发环境常用的格式，输出简洁且包含颜色编码，便于查看。示例输出：
含义分别为：请求方法（`GET`）、请求路径（`/`）、响应状态码（`200`）、响应时间（`3.029 ms`）和响应内容长度（`12`）。
GET / 200 3.029 ms - 122. `combined`
这是一种类似于 Apache 服务器的通用日志格式，包含客户端 IP 地址、用户代理等详细信息。示例输出：
::1 - - [24/Jan/2025:10:30:00 +0000] "GET / HTTP/1.1" 200 12 "http://localhost:3000/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"3. `common`
和 `combined` 格式类似，但不包含用户代理信息。示例输出：
::1 - - [24/Jan/2025:10:30:00 +0000] "GET / HTTP/1.1" 200 124. `short`
输出的信息比 `dev` 格式多一些，但比 `combined` 格式简洁。示例输出：
::1 - GET / HTTP/1.1 200 12 - 3.029 ms5. `tiny`
输出最简洁的日志信息，只包含请求方法、路径、状态码、响应内容长度和响应时间。示例输出：
GET / 200 12 - 3.029 ms四、自定义日志格式
使用 `morgan.token()` 方法定义了一个自定义的日志令牌 `custom-date`，用于输出当前时间的 ISO 格式。
const express = require("express");
const morgan = require("morgan");
const app = express();
// 自定义日志格式
morgan.token("custom-date", () => {
return new Date().toISOString();
});
const customFormat =
":custom-date :method :url :status :res[content-length] - :response-time ms";
app.use(morgan(customFormat));
app.get("/", (req, res) => {
res.send("Hello, World!");
});
const port = 3000;
app.listen(port, () => {
console.log(`Server running on port ${port}`);
});五、将日志写入文件
`morgan` 还可以将日志信息写入文件，而不只是输出到控制台。
const express = require("express");
const morgan = require("morgan");
const fs = require("fs");
const path = require("path");
const app = express();
// 创建一个写入流（追加模式）
const accessLogStream = fs.createWriteStream(
path.join(__dirname, "access.log"),
{ flags: "a" }
);
// 使用 morgan 并将日志写入文件
app.use(morgan("combined", { stream: accessLogStream }));
app.get("/", (req, res) => {
res.send("Hello, World!");
});
const port = 3000;
app.listen(port, () => {
console.log(`Server running on port ${port}`);
});这里使用 `fs.createWriteStream()` 方法创建一个写入流，将 `morgan` 的日志信息追加到 `access.log` 文件中。