错误

目录

• 错误

  • Node.js 中的错误处理
    • 未捕获的错误
    • 在 Promise 中捕获错误
  • Fastify 中的错误
    • 输入数据中的错误
    • 在 Fastify 中捕获未捕获的错误
  • Fastify 生命周期钩子和自定义错误处理程序中的错误
  • Fastify 错误代码
    • FST_ERR_NOT_FOUND
    • FST_ERR_OPTIONS_NOT_OBJ
    • FST_ERR_QSP_NOT_FN
    • FST_ERR_SCHEMA_CONTROLLER_BUCKET_OPT_NOT_FN
    • FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN
    • FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_OBJ
    • FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_ARR
    • FST_ERR_CTP_ALREADY_PRESENT
    • FST_ERR_CTP_INVALID_TYPE
    • FST_ERR_CTP_EMPTY_TYPE
    • FST_ERR_CTP_INVALID_HANDLER
    • FST_ERR_CTP_INVALID_PARSE_TYPE
    • FST_ERR_CTP_BODY_TOO_LARGE
    • FST_ERR_CTP_INVALID_MEDIA_TYPE
    • FST_ERR_CTP_INVALID_CONTENT_LENGTH
    • FST_ERR_CTP_EMPTY_JSON_BODY
    • FST_ERR_CTP_INSTANCE_ALREADY_STARTED
    • FST_ERR_INSTANCE_ALREADY_LISTENING
    • FST_ERR_DEC_ALREADY_PRESENT
    • FST_ERR_DEC_DEPENDENCY_INVALID_TYPE

• FST_ERR_DEC_ALREADY_PRESENT

  • FST_ERR_DEC_DEPENDENCY_INVALID_TYPE
  • FST_ERR_DEC_MISSING_DEPENDENCY
  • FST_ERR_DEC_AFTER_START
  • FST_ERR_DEC_REFERENCE_TYPE
  • FST_ERR_DEC_UNDECLARED
  • FST_ERR_HOOK_INVALID_TYPE
  • FST_ERR_HOOK_INVALID_HANDLER
  • FST_ERR_HOOK_INVALID_ASYNC_HANDLER
  • FST_ERR_HOOK_NOT_SUPPORTED
  • FST_ERR_MISSING_MIDDLEWARE
  • FST_ERR_HOOK_TIMEOUT
  • FST_ERR_LOG_INVALID_DESTINATION
  • FST_ERR_LOG_INVALID_LOGGER
  • FST_ERR_LOG_INVALID_LOGGER_INSTANCE
  • FST_ERR_LOG_INVALID_LOGGER_CONFIG
  • FST_ERR_LOG_LOGGER_AND_LOGGER_INSTANCE_PROVIDED
  • FST_ERR_REP_INVALID_PAYLOAD_TYPE
  • FST_ERR_REP_RESPONSE_BODY_CONSUMED
  • FST_ERR_REP_READABLE_STREAM_LOCKED
  • FST_ERR_REP_ALREADY_SENT
  • FST_ERR_REP_SENT_VALUE
  • FST_ERR_SEND_INSIDE_ONERR
  • FST_ERR_SEND_UNDEFINED_ERR
  • FST_ERR_BAD_STATUS_CODE
  • FST_ERR_BAD_TRAILER_NAME
  • FST_ERR_BAD_TRAILER_VALUE
  • FST_ERR_FAILED_ERROR_SERIALIZATION

• FST_ERR_BAD_TRAILER_VALUE

  • FST_ERR_FAILED_ERROR_SERIALIZATION
  • FST_ERR_MISSING_SERIALIZATION_FN
  • FST_ERR_MISSING_CONTENTTYPE_SERIALIZATION_FN
  • FST_ERR_REQ_INVALID_VALIDATION_INVOCATION
  • FST_ERR_SCH_MISSING_ID
  • FST_ERR_SCH_ALREADY_PRESENT
  • FST_ERR_SCH_CONTENT_MISSING_SCHEMA
  • FST_ERR_SCH_DUPLICATE
  • FST_ERR_SCH_VALIDATION_BUILD
  • FST_ERR_SCH_SERIALIZATION_BUILD
  • FST_ERR_SCH_RESPONSE_SCHEMA_NOT_NESTED_2XX
  • FST_ERR_INIT_OPTS_INVALID
  • FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE
  • FST_ERR_DUPLICATED_ROUTE
  • FST_ERR_BAD_URL
  • FST_ERR_ASYNC_CONSTRAINT
  • FST_ERR_INVALID_URL
  • FST_ERR_ROUTE_OPTIONS_NOT_OBJ
  • FST_ERR_ROUTE_DUPLICATED_HANDLER
  • FST_ERR_ROUTE_HANDLER_NOT_FN
  • FST_ERR_ROUTE_MISSING_HANDLER
  • FST_ERR_ROUTE_METHOD_INVALID
  • FST_ERR_ROUTE_METHOD_NOT_SUPPORTED
  • FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED
  • FST_ERR_ROUTE_BODY_LIMIT_OPTION_NOT_INT
  • FST_ERR_ROUTE_REWRITE_NOT_STR

• 路由体限制选项不是整数错误

  • 重写路径不是字符串错误
  • 重新打开已关闭的服务器错误
  • 重新打开服务器错误
  • 插件版本不匹配错误
  • 插件回调不是函数错误
  • 无效插件错误
  • 根插件已启动错误
  • 父插件已启动错误
  • 插件超时错误
  • 实例中不存在的插件错误
  • 无效异步处理程序错误
  • 验证错误
  • 监听选项无效错误
  • 错误处理器不是函数错误
  • 错误处理器已设置错误

Node.js中的错误处理

未捕获的错误

在Node.js中，未捕获的错误可能导致内存泄漏、文件描述符泄漏以及其他重大生产问题。 Domains  是一种尝试解决此问题但失败的方法。

鉴于无法合理处理所有未捕获的错误，最好的方法是 崩溃 。

在Promise中捕获错误

使用Promise时，请同步附加一个.catch()处理器。

Fastify中的错误

Fastify采取全有或全无的方法，并力求精简和优化。开发人员负责确保正确处理所有错误。

输入数据中的错误

大多数错误源于意外的输入数据，因此建议对输入数据进行JSON模式验证。

在Fastify中捕获未捕获的错误

Fastify尝试在不影响性能的情况下尽可能多地捕获未捕获的错误。这包括：

1. 同步路由，例如 app.get('/', () => { throw new Error('kaboom') })
2. 异步路由，例如 app.get('/', async () => { throw new Error('kaboom') })

在这两种情况下，错误将被安全捕获并传递给Fastify的默认错误处理器，导致返回一个通用的500 Internal Server Error响应。

要自定义此行为，请使用 setErrorHandler。

Fastify 生命周期钩子中的错误及自定义错误处理程序

从 Hooks 文档：

如果在执行您的钩子时遇到错误，请将其传递给 done()，Fastify 将自动关闭请求并向用户发送适当的错误代码。

当通过 setErrorHandler 定义自定义错误处理程序时，它将接收传递给 done() 回调或通过其他支持的自动错误处理机制传递的错误。如果多次使用 setErrorHandler，则错误会被路由到错误封装上下文中的最优先级处理器。错误处理程序是完全封装的，因此插件内的 setErrorHandler 调用将限制错误处理程序仅在该插件的上下文中有效。

根错误处理程序是 Fastify 的通用错误处理程序。此错误处理程序会使用 Error 对象中的头信息和状态码（如果存在）。如果提供了自定义错误处理程序，则不会自动设置头信息和状态码。

使用自定义错误处理程序时应考虑以下事项：

• reply.send(data) 行为与 常规路由处理器 相同

  • 对象会被序列化，触发 preSerialization 生命周期钩子（如果已定义）
  • 字符串、缓冲区和流会以适当的头信息发送给客户端（不进行序列化）

• 在自定义错误处理程序中抛出新的错误将调用父级的 errorHandler。

  • 对于首次抛出的错误，onError 钩子会被触发一次
  • 生命周期钩子阶段不会两次触发同一个错误。Fastify 内部监控错误调用来避免在回复阶段（路由处理器之后）抛出错误时出现无限循环

当使用Fastify的自定义错误处理功能时，通过setErrorHandler，请注意自定义和默认错误处理器之间如何传播错误。

如果插件中的错误处理器重新抛出一个不是Error 实例的错误，则该错误不会传递到父上下文的错误处理器。相反，它将被捕获并由默认错误处理器处理。这可以在下面示例中的/bad路由中看到。

为了确保一致的错误处理，请抛出Error类型的实例。例如，在/bad路由中，用throw new Error('foo')替换throw 'foo'以确保错误能够按照预期通过自定义错误处理链传播。这种做法有助于避免在使用Fastify时进行自定义错误处理时可能出现的问题。

例如：

const Fastify = require('fastify')
 
// 初始化框架
const fastify = Fastify({
  logger: true
})
 
// 注册父级错误处理器
fastify.setErrorHandler((error, request, reply) => {
  reply.status(500).send({ ok: false })
})
 
fastify.register((app, options, next) => {
  // 注册子级错误处理器
  fastify.setErrorHandler((error, request, reply) => {
    throw error
  })
 
  fastify.get('/bad', async () => {
    // 抛出一个非Error类型的错误，'foo'
    throw 'foo'
  })
 
  fastify.get('/good', async () => {
    // 抛出一个Error实例，'bar'
    throw new Error('bar')
  })
 
  next()
})
 
// 启动服务器
fastify.listen({ port: 3000 }, function (err, address) {
  if (err) {
    fastify.log.error(err)
    process.exit(1)
  }
  // 服务器正在${address}监听
})
 

Fastify 错误代码

您可以访问 errorCodes 进行映射：

// ESM
import { errorCodes } from 'fastify'
 
// CommonJS
const errorCodes = require('fastify').errorCodes
 

例如：

const Fastify = require('fastify')
 
// 实例化框架
const fastify = Fastify({
  logger: true
})
 
// 声明一个路由
fastify.get('/', function (request, reply) {
  reply.code('bad status code').send({ hello: 'world' })
})
 
fastify.setErrorHandler(function (error, request, reply) {
  if (error instanceof Fastify.errorCodes.FST_ERR_BAD_STATUS_CODE) {
    // 记录错误
    this.log.error(error)
    // 发送错误响应
    reply.status(500).send({ ok: false })
  } else {
    // Fastify 将使用父级错误处理程序来处理此错误
    reply.send(error)
  }
})
 
// 启动服务器！
fastify.listen({ port: 3000 }, function (err, address) {
  if (err) {
    fastify.log.error(err)
    process.exit(1)
  }
  // 服务器现在正在 ${address} 监听
})
 

以下是Fastify 使用的所有错误代码的表格。