前言
在开发 Web 应用时，我们都需要记录一些信息，例如请求的 url、请求的方法、响应时间、状态码等等。这些信息可以用来诊断问题、分析性能、安全审计等方面。而 koa-morgan 就是一个非常简洁、易用的 npm 包，它可以将这些信息记录到日志文件中。本文就是对 koa-morgan 的使用进行介绍。
安装 koa-morgan
使用 koa-morgan 前，我们需要先安装它。
npm install koa-morgan --save
使用 koa-morgan
在安装好 koa-morgan 后，我们需要在 Koa 应用中进行引用。在引用 koa-morgan 模块后，我们就可以像使用 Koa 应用方法一样使用 koa-morgan 方法。
以下是一个使用示例：
-- -------------------- ---- ------- ----- --- - --------------- ----- ------ - ---------------------- ----- --- - --- ------ -------------------------- ------------- ----- -- - -------- - ------ -------- --- -----------------
其中，我们使用了 morgan 函数，指定第一个参数为 'common'，即记录常用信息。我们可以更改常用值，常用的值如下：
- combined 完整 log 格式，包含时间、请求地址、响应状态码等
- common 标准 log 格式，包含时间、请求地址、响应状态码及响应时间
- dev 简洁 log 格式，包含时间、请求地址、响应状态码、响应时间及响应大小
- short 简短 log 格式，只包含时间、请求地址、状态码及响应时间
我们还可以添加自定义选项，例如：
app.use(morgan(':method :url :status :response-time ms - :res[content-length]'));深入了解 koa-morgan
koa-morgan 可以与其他 Koa 应用中间件一起使用，除了提供 Koa 自带的能力外，koa-morgan 还能帮我们美化输出信息。以下是一些实用的示例：
美化 log
我们可以自定义颜色、字体，来美化输出信息：
-- -------------------- ---- -------
----- ----- - -----------------
--------------------- -
------- ---- - ------ ---------- - --- -- -- ------- -------
------- ---------------
-- -- ----- ----
------- -------- ---- ------- -------------- -- ----------------------
-- -------
----------- ----- -----
------- -
-------- ---------------------
------ -------------------
--
-- -----
------------- -
-------- -------------------------
------ -----------------------
--
----输出至文件
日志文件是记录应用状态条理最好的方式。将 koa-morgan 的输出写入文件的最简单的方式是，将 Node.js 流写入 Node.js 文件。以下是一个简单示例：
const fs = require('fs');
const path = require('path');
const accessLogStream = fs.createWriteStream(path.join(__dirname, '../logs/access.log'), { flags: 'a' })
app.use(morgan('combined', { stream: accessLogStream }))在这个例子中，我们使用 Node 的文件写入流创建了一个新文件，将 morgan 的输出流导向到这个文件中。
使用第三方日志工具
koa-morgan 还可以将日志信息通过一个流传送到其他日志工具中，例如 Elastic Beanstalk、Papertrail 等可以通过日志管道处理。
总结
koa-morgan 是非常简洁、易用的一个 npm 包，它可以帮我们快速记录应用的请求信息，对于开发、运维人员来说非常有价值。通常，我们在应用中添加日志的主要目的是帮助诊断问题、调优、审计等。通过本文的介绍，希望读者能够深入了解 koa-morgan，达到更好地使用和实践的目的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66847