LAD和KOA的更好的错误处理程序。使
ctx.throw很棒(与KOA-404 Handler一起使用)
ETIMEOUT和EBADFAMILY ),并发送408客户端超时错误<ul>支持HTML错误列表,用于蒙古验证错误,多个消息ctx.throw直接美丽的消息(例如ctx.throw(404)将输出一个美丽的错误对象)text/html , application/json和text响应类型npm install --save koa-better-error-handler您可能也应该将其与KOA-404 Handler结合使用!
该软件包导出一个接受四个参数的函数(按顺序):
cookiesKey默认为falselogger默认为consoleuseCtxLogger默认为truestringify默认为fast-safe-stringify (您还可以在此处使用JSON.stringify或其他选项(如果首选))如果您通过cookiesKey ,则将添加对会话的支持。如果使用cookie和会话(例如Web服务器),则应始终设置此参数的值。
我们建议将机舱用于logger ,您也应该使用其中间件,因为它将自动填充ctx.logger ,以使您的基于上下文的日志变得容易。
请注意,此软件包仅支持koa-generic-session ,并且尚未支持koa-session-store (请参阅index.js中的代码以获取更多洞察力,欢迎拉动请求)。
不支持会议,cookie或Flash消息传递:
const errorHandler = require ( 'koa-better-error-handler' ) ;
const Koa = require ( 'koa' ) ;
const Router = require ( 'koa-router' ) ;
const koa404Handler = require ( 'koa-404-handler' ) ;
// initialize our app
const app = new Koa ( ) ;
// override koa's undocumented error handler
app . context . onerror = errorHandler ( ) ;
// specify that this is our api
app . context . api = true ;
// use koa-404-handler
app . use ( koa404Handler ) ;
// set up some routes
const router = new Router ( ) ;
// throw an error anywhere you want!
router . get ( '/404' , ctx => ctx . throw ( 404 ) ) ;
router . get ( '/500' , ctx => ctx . throw ( 500 ) ) ;
// initialize routes on the app
app . use ( router . routes ( ) ) ;
// start the server
app . listen ( 3000 ) ;
console . log ( 'listening on port 3000' ) ;对会话,cookie和Flash消息的内置支持:
const errorHandler = require ( 'koa-better-error-handler' ) ;
const Koa = require ( 'koa' ) ;
const redis = require ( 'redis' ) ;
const RedisStore = require ( 'koa-redis' ) ;
const session = require ( 'koa-generic-session' ) ;
const flash = require ( 'koa-connect-flash' ) ;
const convert = require ( 'koa-convert' ) ;
const Router = require ( 'koa-router' ) ;
const koa404Handler = require ( 'koa-404-handler' ) ;
// initialize our app
const app = new Koa ( ) ;
// define keys used for signing cookies
app . keys = [ 'foo' , 'bar' ] ;
// initialize redis store
const redisClient = redis . createClient ( ) ;
redisClient . on ( 'connect' , ( ) => app . emit ( 'log' , 'info' , 'redis connected' ) ) ;
redisClient . on ( 'error' , err => app . emit ( 'error' , err ) ) ;
// define our storage
const redisStore = new RedisStore ( {
client : redisClient
} ) ;
// add sessions to our app
const cookiesKey = 'lad.sid' ;
app . use (
convert (
session ( {
key : cookiesKey ,
store : redisStore
} )
)
) ;
// add support for flash messages (e.g. `req.flash('error', 'Oops!')`)
app . use ( convert ( flash ( ) ) ) ;
// override koa's undocumented error handler
app . context . onerror = errorHandler ( cookiesKey ) ;
// use koa-404-handler
app . use ( koa404Handler ) ;
// set up some routes
const router = new Router ( ) ;
// throw an error anywhere you want!
router . get ( '/404' , ctx => ctx . throw ( 404 ) ) ;
router . get ( '/500' , ctx => ctx . throw ( 500 ) ) ;
// initialize routes on the app
app . use ( router . routes ( ) ) ;
// start the server
app . listen ( 3000 ) ;
console . log ( 'listening on port 3000' ) ; 示例请求:
curl -H " Accept: application/json " http://localhost/some-page-does-not-exist示例响应:
{
"statusCode" : 404 ,
"error" : " Not Found " ,
"message" : " Not Found "
}截至v3.0.5,您可以通过设置no_translate的错误属性以具有true的值来防止错误自动翻译:
function middleware ( ctx ) {
const err = Boom . badRequest ( 'Uh oh!' ) ;
err . no_translate = true ; // <----
ctx . throw ( err ) ;
} 如果指定app.context.api = true或设置ctx.api = true ,并且发生猫鼬验证错误消息,该消息发生多个消息(例如,多个字段无效),则err.message将由逗号遵守,而不是<li> 。
因此,如果您确实希望您的API错误消息返回HTML格式的错误列表以进行Mongoose验证,则设置app.context.api = false , ctx.api = false ,或者只是在使用此错误处理程序之前只确保不设置它们。
try {
// trigger manual validation
// (this allows us to have a 400 error code instead of 500)
await company . validate ( ) ;
} catch ( err ) {
ctx . throw ( Boom . badRequest ( err ) ) ;
}带有错误列表:
{
"statusCode" : 400 ,
"error" : " Bad Request " ,
"message" : " <ul class= " text-left mb-0 " ><li>Path `company_logo` is required.</li><li>Gig description must be 100-300 characters.</li></ul> "
}没有错误列表:
{
"statusCode" : 400 ,
"error" : " Bad Request " ,
"message" : " Path `company_logo` is required., Gig description must be 100-300 characters. "
}默认情况下,如果ctx.api为真,则将在err.message上调用html-to-Text,从而将所有HTML标记转换为文本格式。
您还可以在环境中指定一个基本URI,以呈现为process.env.ERROR_HANDLER_BASE_URL ,例如ERROR_HANDLER_BASE_URL=https://example.com (省略落后slash slash),以及任何html链接,如<a href="/foo/bar/baz">Click here</a> [1] [Click here][1]链接附加https://example.com/foo/bar/baz 。
麻省理工学院©Nick Baugh