在 Web 应用中，日志记录是非常重要的一环。日志记录可以帮助开发人员快速定位和诊断问题，同时也可以为应用的性能分析提供重要的依据。而对于使用 Express.js 构建的应用来说，则可以通过内置的中间件来实现日志记录的功能。
使用 Morgan 中间件
Morgan 是一个流行的 Node.js 应用程序的 HTTP 请求日志中间件。它可以记录请求的 url、http 方法、响应时间、响应状态码等信息。使用该中间件只需要简单的安装和配置即可。
安装 Morgan
Morgan 的安装非常简单，只需要使用 npm 安装即可：
npm install morgan --save
配置 Morgan
在 Express.js 应用中使用 Morgan，只需要将其作为中间件引入即可。通常情况下，我们会将 Morgan 的日志格式设置为 "dev"，它会输出类似下面的日志：
GET / 304 6.230 ms - -
示例代码如下：
const express = require('express');
const app = express();
const morgan = require('morgan');
// 将 Morgan 中间件引入到应用中
app.use(morgan('dev'));
// 添加路由
app.get('/', (req, res) => {
res.send('Hello World!');
});
// 启动应用
app.listen(3000, () => {
console.log('App listening on port 3000!');
});自定义 Morgan 日志格式
除了 "dev" 格式以外，Morgan 还支持自定义日志格式。开发人员可以根据自己的需求，设置自己所需要的日志格式。
Morgan 中间件的日志格式由预定义的 token 组成。每个 token 代表了一个特定的日志信息，例如 ":method" 代表了 HTTP 方法，":status" 代表了 HTTP 状态码等。在设置自定义日志格式时，只需要将这些 token 组合在一起即可。
示例代码如下：
const express = require('express');
const app = express();
const morgan = require('morgan');
// 定义自定义日志格式
morgan.token('remote-addr', function (req, res) {
return req.headers['x-real-ip'] || req.headers['x-forwarded-for'] || req.connection.remoteAddress;
});
const logFormat = ':remote-addr - :remote-user [:date[clf]] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"'
// 将 Morgan 中间件引入到应用中
app.use(morgan(logFormat));
// 添加路由
app.get('/', (req, res) => {
res.send('Hello World!');
});
// 启动应用
app.listen(3000, () => {
console.log('App listening on port 3000!');
});在上面的代码中，我们定义了一个自定义日志格式，该格式包含了请求地址、响应时间、响应状态码等信息。启动应用后，Morgan 将会记录这些信息，并输出到控制台上。
使用 Winston 库
Winston 是一个流行的 Node.js 日志库。它提供了多种日志记录方式，支持自定义日志格式，还可以将日志记录到多个目标，例如控制台、文件和数据库等。使用 Winston 可以更加灵活和便捷地管理应用的日志记录。
安装 Winston
使用 npm 安装 Winston：
npm install winston --save
配置 Winston
在 Express.js 应用中使用 Winston，需要首先定义一个 Logger 对象。Logger 对象包含多个 Transport，每个 Transport 负责将日志发送到各自的目标中。常见的 Transport 类型包括 Console、File 和 MongoDB 等。
示例代码如下：
const express = require('express');
const app = express();
const winston = require('winston');
// 定义 Logger 对象
const logger = winston.createLogger({
level: 'info', // 记录的日志级别
format: winston.format.json(), // 日志格式
transports: [
new winston.transports.Console(),
new winston.transports.File({ filename: 'combined.log' })
]
});
// 添加路由
app.get('/', (req, res) => {
// 记录日志
logger.info('Hello World!');
res.send('Hello World!');
});
// 启动应用
app.listen(3000, () => {
console.log('App listening on port 3000!');
});在上面的代码中，我们首先定义了一个 Logger 对象，该对象包含了两个 Transport。一个 Console Transport 将日志输出到控制台上，一个 File Transport 将日志记录到 combined.log 文件中。
自定义 Winston 日志格式
Winston 支持自定义日志格式。在 Logger 对象中，可以通过 format 属性来设置日志格式。Winston 提供了多种日志格式，例如 json、simple、printf 等。开发人员也可以定义自己的日志格式。
示例代码如下：
const express = require('express');
const app = express();
const winston = require('winston');
// 定义自定义日志格式
const myFormat = winston.format.printf(({ level, message, timestamp }) => {
return `${timestamp} ${level.toUpperCase()}: ${message}`;
});
// 定义 Logger 对象
const logger = winston.createLogger({
level: 'info',
format: winston.format.combine(
winston.format.timestamp(),
myFormat
),
transports: [
new winston.transports.Console(),
new winston.transports.File({ filename: 'combined.log' })
]
});
// 添加路由
app.get('/', (req, res) => {
// 记录日志
logger.info('Hello World!');
res.send('Hello World!');
});
// 启动应用
app.listen(3000, () => {
console.log('App listening on port 3000!');
});在上面的代码中，我们定义了一个自定义日志格式 myFormat。该格式将日志信息中的 level、message 和 timestamp 组合在一起，并输出到控制台和日志文件中。
总结
通过本文的介绍，我们了解了如何使用 Express.js 中间件和 Winston 库来实现 Web 应用的日志记录功能。在实际开发中，开发人员可以根据自己的需求来选择适合自己的日志记录方式和工具，以便更好地管理和维护应用的日志。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6596a637eb4cecbf2da704e3