Express.js 中的中间件：Morgan 使用指南

Express.js 中的中间件：Morgan 使用指南

morganHTTP request logger middleware for node.js项目地址:https://gitcode.com/gh_mirrors/mo/morgan

1. 项目目录结构及介绍

Morgan 是一个用于 Node.js 的 HTTP 请求日志中间件，其设计简洁高效，非常适合集成在基于 Express.js 的应用中。以下是 Morgan 在克隆后的基本目录结构以及关键文件的简要说明：

├── LICENSE
├── README.md            <- 项目的主要文档，包含了安装、使用方法及配置选项。
├── index.js             <- 主入口文件，导出中间件函数。
├── lib                  <- 核心库目录，含中间件的核心逻辑。
│   ├── format.js        <- 日志格式处理文件。
│   └── token.js         <- 定义了所有可用的日志令牌(token)。
├── test                 <- 单元测试目录，确保代码质量。
│   └── ...
└── package.json         <- 项目元数据文件，包括依赖项、版本等。

注意：实际开发中，您可能不会直接操作这些内部文件，而是通过配置Express来使用Morgan。

2. 项目的启动文件介绍

在使用Morgan时，通常不需要直接操作所谓的“启动文件”，因为它是作为Express应用的一部分引入的。但我们可以把如何在Express应用中启动Morgan视为这一部分的重点。

示例：在Express中引入并使用Morgan

// 假设这是您的app.js或server.js（启动文件）
const express = require('express');
const morgan = require('morgan');

const app = express();

// 在任何路由处理之前启用Morgan，以记录请求信息。
app.use(morgan('dev')); // 'dev'是常用的格式之一，适合开发环境。

// 接下来的代码是您的路由定义和其他中间件的使用。
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// 启动服务器
app.listen(3000, () => {
    console.log('Server running on port 3000');
});

3. 项目的配置文件介绍

Morgan本身并不直接使用外部配置文件。它的配置主要通过传递给中间件函数的字符串参数或自定义日志格式函数来实现。这通常发生在应用程序代码层面上，而非独立的配置文件中。

配置示例

• 预定义格式：

  app.use(morgan('combined')); // 使用典型的clf(combined log format)格式
  

• 自定义格式：

  app.use(morgan(':method :url :status - :response-time ms')); // 自定义格式示例
  

• 使用Stream进行日志记录到文件： 虽然不是配置文件的形式，但可以通过将输出重定向至文件流来达到类似配置的效果。

  const accessLogStream = fs.createWriteStream(__dirname + '/access.log', { flags: 'a' });
  app.use(morgan('combined', { stream: accessLogStream }));
  

通过这种方式，您可以灵活地控制和定制Morgan的行为，满足不同场景下的日志需求，无需依赖于传统的配置文件结构。

morganHTTP request logger middleware for node.js项目地址:https://gitcode.com/gh_mirrors/mo/morgan