Node.js 中 morgan 依赖及基本使用详解

 更新时间:2025年02月18日 11:07:41   作者:yqcoder  
文章介绍了Node.js中`morgan`依赖的安装、基本使用、日志格式(如`dev`、`combined`、`common`等),以及如何自定义日志格式和将日志写入文件,感兴趣的朋友一起看看吧

记录每个 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 - 12

2. `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 12

4. `short`

输出的信息比 `dev` 格式多一些,但比 `combined` 格式简洁。示例输出:

::1 - GET / HTTP/1.1 200 12 - 3.029 ms

5. `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` 文件中。

到此这篇关于Node.js 中 morgan 依赖详解的文章就介绍到这了,更多相关Node.js morgan 依赖内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 关于node编写文件上传的接口的坑及解决

    关于node编写文件上传的接口的坑及解决

    这篇文章主要介绍了关于node编写文件上传的接口的坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • nodejs个人博客开发第五步 分配数据

    nodejs个人博客开发第五步 分配数据

    这篇文章主要为大家详细介绍了nodejs个人博客开发的分配数据,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • NodeJs内置模块超详细讲解

    NodeJs内置模块超详细讲解

    Node.js内置模块也叫核心模块,跟随Node.js一起安装。console模块提供了一个简单的调试控制台,类似于网络浏览器提供的 JavaScript控制台机制
    2023-01-01
  • 一文带你了解Node.js中的path模块

    一文带你了解Node.js中的path模块

    Node.js和Python技术类似, 都致力于能够实现跨平台的通用代码。 为此,针对路径的拼接, Node.js提供了path模块,本文就来讲讲path模块的使用
    2023-03-03
  • Nodejs脚本实现批量修改文件

    Nodejs脚本实现批量修改文件

    当我们想要更改一下所有的文件,如何可以在修改到这些文件的同时又能实现节省时间呢,通过这篇文章我们将来学习一下怎么通过这个脚本来实现这个功能,希望对大家有所帮助
    2023-11-11
  • node.js 微信开发之定时获取access_token

    node.js 微信开发之定时获取access_token

    本文给大家分享的是在使用node.js做微信开发的过程中如何定时获取access_token的方法,有需要的小伙伴可以参考下
    2020-02-02
  • node.js中的url.parse方法使用说明

    node.js中的url.parse方法使用说明

    这篇文章主要介绍了node.js中的url.parse方法使用说明,本文介绍了url.parse的方法说明、语法、接收参数、使用实例和实现源码,需要的朋友可以参考下
    2014-12-12
  • Node.js+Express配置入门教程

    Node.js+Express配置入门教程

    Node.js是一个Javascript运行环境(runtime)。本文给大家介绍Node.js+Express配置入门教程,值得推荐给大家,感兴趣的朋友一起学习吧
    2016-05-05
  • nodejs中fs模块三种读写文件方法的使用区别

    nodejs中fs模块三种读写文件方法的使用区别

    Node.js的fs模块有多种文件操作API,readFile、read、createReadStream读取文件,writeFile、write、createWriteStream写入文件,readFile和writeFile将文件写入缓存区,适合小文件操作,read和write分步骤读写,适合大文件,createReadStream和createWriteStream通过流处理文件
    2024-10-10
  • 深入解读Node.js中的koa源码

    深入解读Node.js中的koa源码

    这篇文章主要介绍了深入解读Node.js中的koa源码,任何一个框架的出现都是为了解决问题,而Koa则是为了更方便的构建http服务而出现的。 可以简单的理解为一个HTTP服务的中间件框架。,需要的朋友可以参考下
    2019-06-06

最新评论