10分钟实现Koa-logger：打造自己的请求日志中间件

【免费下载链接】koajs-design-note《Koa.js 设计模式-学习笔记》已完结 😆项目地址: https://gitcode.com/gh_mirrors/ko/koajs-design-note

Koa-logger是Koa.js生态中最实用的请求日志中间件之一，它能帮助开发者实时监控HTTP请求的流转过程。本文将带你从零开始构建一个轻量级的Koa-logger中间件，掌握中间件的核心设计思想，让你在10分钟内拥有自定义日志记录的能力。

为什么需要请求日志中间件？

在Web开发中，请求日志就像应用的"黑匣子"，它能：

• 追踪用户请求路径与响应状态
• 排查接口性能瓶颈
• 定位异常请求来源
• 分析用户行为数据

Koa.js的洋葱模型设计让中间件实现变得异常简单，而logger作为最基础的中间件，是每个Koa项目的必备组件。

实现步骤（超简单3步）

1. 拦截请求并记录基本信息

首先创建中间件函数，在请求到达时记录方法和URL：

const logger = async function(ctx, next) { // 记录请求开始时间 const start = Date.now(); // 打印请求信息 console.log(`<-- ${ctx.method} ${ctx.url}`); // 等待后续中间件执行 await next(); }

2. 监听响应完成事件

利用Node.js的事件机制，在响应结束后补充日志信息：

// 接上面的代码 res.on('finish', () => { // 计算请求耗时 const ms = Date.now() - start; // 打印响应信息与耗时 console.log(`--> ${ctx.method} ${ctx.url} ${ctx.status} ${ms}ms`); });

3. 导出中间件并使用

完整代码如下（demo/chapter-04-01/index.js）：

const logger = async function(ctx, next) { const start = Date.now(); const res = ctx.res; console.log(`<-- ${ctx.method} ${ctx.url}`); await next(); res.on('finish', () => { const ms = Date.now() - start; console.log(`--> ${ctx.method} ${ctx.url} ${ctx.status} ${ms}ms`); }); }; module.exports = logger

在Koa应用中使用：

const Koa = require('koa'); const logger = require('./index'); // 引入我们的logger const app = new Koa(); app.use(logger); // 注册中间件 app.use(async(ctx) => { ctx.body = 'Hello Koa-logger'; }); app.listen(3000);

运行效果展示

启动服务后访问http://127.0.0.1:3000，控制台将输出：

<-- GET / --> GET / 200 8ms

进阶优化方向

添加状态码颜色区分

通过chalk库给不同状态码添加颜色：

const chalk = require('chalk'); // ... const status = ctx.status >= 500 ? chalk.red(ctx.status) : ctx.status >= 400 ? chalk.yellow(ctx.status) : ctx.status >= 300 ? chalk.cyan(ctx.status) : chalk.green(ctx.status);

记录请求IP与用户代理

补充客户端信息：

console.log(`<-- ${ctx.method} ${ctx.url} - ${ctx.ip} ${ctx.headers['user-agent']}`);

输出到日志文件

结合fs模块将日志写入文件：

const fs = require('fs'); const logStream = fs.createWriteStream('app.log', { flags: 'a' }); // ... logStream.write(`[${new Date().toISOString()}] ${ctx.method} ${ctx.url} ${ms}ms\n`);

总结

通过本文的学习，你不仅实现了一个基础的Koa-logger中间件，更重要的是掌握了Koa中间件的核心原理：在请求到达时执行前置逻辑，在响应返回时执行后置逻辑。这个简单的模式却能实现强大的功能，是Koa框架的精髓所在。

想要查看完整示例代码，可以参考项目中的demo/chapter-04-01目录，那里包含了可直接运行的示例工程。如果需要更专业的日志解决方案，也可以参考官方的koa-logger实现。

现在，你已经拥有了构建自定义中间件的能力，快去扩展你的日志功能吧！🚀

【免费下载链接】koajs-design-note《Koa.js 设计模式-学习笔记》已完结 😆项目地址: https://gitcode.com/gh_mirrors/ko/koajs-design-note