Node.js 错误处理中间件编写指南

作者:星河

时间:2026-10-25

浏览:528

本文介绍Node.js中错误处理中间件的编写方法,涵盖Koa的try-catch机制、koa-json-error库的使用以及Connect框架中错误中间件的定义规范。重点说明错误处理中间件需接收四个参数,并区分生产与开发环境的响应差异,帮助开发者构建健壮的Web应用错误处理流程。

文章目录

在Node.js开发中,编写高效的错误处理中间件是保障应用稳定性的关键。

app.use(async(ctx, next) => {
    try {
        await next();
    } catch (err) {
        console.log(err, "错误机制");
        ctx.status = err.status || err.statusCode;
        ctx.body = {
            message: err.message
        };
    }
})

以Koa框架为例,其错误处理机制通常通过try-catch块捕获异步操作中的异常。

const koajsonerror = require("koa-json-error");
app.use(koajsonerror({
    postFormat: (err, { stack, ...rest }) => process.env.NODE_ENV === "production" ? rest : { stack, ...rest }
}));

需要注意的是,错误处理中间件应放置在路由注册之前,以确保能捕获所有后续中间件抛出的错误。

在Connect框架中,错误处理中间件的定义有特定规范。

以下是一个基础示例,展示如何定义一个错误处理函数。

var connect = require('connect');
connect()
	.use(errorHandler())
	.listen(3000);
 
/* 错误处理中间件函数必须接受四个参数:err, req, res和 next */
/* 而常规的中间件只有三个参数:req,res和next */
/* 当Connect遇到错误时,它只调用错误处理中间件 */
function errorHandler() {
	var env = process.env.NODE_ENV || 'development';
	return function(err, req, res, next) {
		res.statusCode = 500;
		switch (env) {
			case 'development':
				res.setHeader('Content-Type', 'application/json');
				res.end(JSON.stringify(err));
				break;
			default:
				res.end('Server error');
		}
	}
}

实际应用中,可能需要配置多个错误处理中间件以应对不同场景。

var connect = require('connect');
var api = connect()
	.use(users)
	.use(pets)
	.use(errorHandler);
var app = connect()
	.use(hello)
	.use('/api', api)
	.use(noPage)
	.use(errorPage)
	.listen(3000);
 
 
// hello 中间件组件
function hello(req, res, next) {
	if (req.url.match(/^\/hello/)) {
		res.end('Hello World\n');
	} else {
		next();
	}
}
 
// users 中间件组件
var db = {
	users: [
		{name: 'tobi'},
		{name: 'loki'},
		{name: 'jane'}
	]
};
function users(req, res, next) {
	var match = req.url.match(/^\/user\/(.+)/);
	if (match) {
		var user = db.users[match[1]];
		if (user) {
			res.setHeader('Content-Type', 'application/json');
			res.end(JSON.stringify(user));
		} else {
			var err = new Error('User not found');
			err.notFound = true;
			next(err);
		}
	} else {
		next();
	}
}
 
// pets 中间件组件
function pets(req, res, next) {
	if (req.url.match(/^\/pet\/(.+)/)) {
		foo();
	} else {
		next();
	}
}
 
// errorHandler 错误处理中间件组件
function errorHandler(err, req, res, next) {
	console.error(err.stack);
	res.setHeader('Content-Type', 'application/json');
	if (err.notFound) {
		res.statusCode = 404;
		res.end(JSON.stringify({error: err.message}));
	} else {
		res.statusCode = 500;
		res.end(JSON.stringify({error: 'Internal Server Error'}));
	}
}
 
// noPage 中间件组件
function noPage(req, res, next) {
	res.statusCode = 404;
	res.end('Not Found');
}
 
// errorPage 错误处理中间件组件
function errorPage(err, req, res, next) {
	res.end('Impossible');
}

以上为个人经验,希望能给大家一个参考,也希望大家多多支持本站。

实用工具推荐

电子包浆

绿化、压缩、噪点和虚拟水印,自由调节做旧程度。

使用 ›
图片压缩

选择画质和输出格式,预览压缩前后的大小。

使用 ›
相关文章