Fastify

工厂函数

Fastify 模块导出了一个工厂函数，可以用于创建新的 **Fastify server** 实例。这个工厂函数的参数是一个配置对象，用于自定义最终生成的实例。本文描述了这一对象中可用的属性。

http2

设置为 true，则会使用 Node.js 原生的 HTTP/2 模块来绑定 socket。

  • 默认值：false

https

用于配置服务器的 TLS socket 的对象。其选项与 Node.js 原生的 createServer 方法一致。 当值为 null 时，socket 连接将不会配置 TLS。

当 **http2** 选项设置时，https 选项也会被应用。

  • 默认值：null

connectionTimeout

定义服务器超时，单位为毫秒。作用请见 server.timeout 属性的文档。当指定了 serverFactory 时，该选项被忽略。

  • 默认值：0 (无超时)

keepAliveTimeout

定义服务器 keep-alive 超时，单位为毫秒。作用请见 server.keepAliveTimeout 属性的文档。仅当使用 HTTP/1 时有效。当指定了 serverFactory 时，该选项被忽略。

  • 默认值：5000 (5 秒)

ignoreTrailingSlash

Fastify 使用 find-my-way 处理路由。该选项为 true 时，尾斜杠将被省略。 这一选项应用于 server 实例上注册的所有路由。

  • 默认值：false
  1. const fastify = require('fastify')({
  2.   ignoreTrailingSlash: true
  3. })
  5. // 同时注册 "/foo" 与 "/foo/"
  6. fastify.get('/foo/', function (req, reply) {
  7.   reply.send('foo')
  8. })
  10. // 同时注册 "/bar" 与 "/bar/"
  11. fastify.get('/bar', function (req, reply) {
  12.   reply.send('bar')
  13. })

maxParamLength

你可以为通过 maxParamLength 选项为带参路由 (无论是标准的、正则匹配的，还是复数的) 设置最大参数长度。选项的默认值为 100 字符。
当使用正则匹配的路由时，这非常有用，可以帮你抵御 DoS 攻击。
当达到长度限制时，将触发 not found 路由。

bodyLimit

定义服务器可接受的最大 payload，以字节为单位。

  • 默认值：1048576 (1MiB)

onProtoPoisoning

由 secure-json-parse 提供的功能，指定解析带有 __proto__ 键的 JSON 对象时框架的行为。 更多关于原型污染 (prototype poisoning) 的内容请看 https://hueniverse.com/a-tale-of-prototype-poisoning-2610fa170061。

允许的值为 'error'、'remove' 与 'ignore'。

  • 默认值：'error'

onConstructorPoisoning

由 secure-json-parse 提供的功能，指定解析带有 constructor 的 JSON 对象时框架的行为。 更多关于原型污染的内容请看 https://hueniverse.com/a-tale-of-prototype-poisoning-2610fa170061。

允许的值为 'error'、'remove' 与 'ignore'。

  • 默认值：'ignore'

logger

Fastify 依托 Pino 内建了一个日志工具。该属性用于配置日志实例。

属性可用的值为：

  • 默认: false。禁用日志。所有记录日志的方法将会指向一个空日志工具 abstract-logging 的实例。

  • pinoInstance: 一个已被实例化的 Pino 实例。内建的日志工具将指向这个实例。

  • object: 标准的 Pino 选项对象。 它会被直接传递进 Pino 的构造函数。如果下列属性未在该对象中定义，它们将被相应地添加：

    • level: 最低的日志级别。若未被设置，则默认为 'info'。

    • serializers: 序列化函数的哈希。默认情况下，序列化函数应用在 req (来访的请求对象)、res (发送的响应对象) 以及 err (标准的 Error 对象) 之上。当一个日志方法接收到含有上述任意属性的对象时，对应的序列化器将会作用于该属性。举例如下：

      1. fastify.get('/foo', function (req, res) {
      2.   req.log.info({req}) // 日志输出经过序列化的请求对象
      3.   res.send('foo')
      4. })

      用户提供的序列化函数将会覆盖对应属性默认的序列化函数。

  • loggerInstance：自定义日志工具实例。日志工具必须实现 Pino 的接口，即拥有如下方法：info, error, debug, fatal, warn, trace, child。例如：
  1. const pino = require('pino')();
  3. const customLogger = {
  4.   info: function (o, ...n) {},
  5.   warn: function (o, ...n) {},
  6.   error: function (o, ...n) {},
  7.   fatal: function (o, ...n) {},
  8.   trace: function (o, ...n) {},
  9.   debug: function (o, ...n) {},
  10.   child: function() {
  11.     const child = Object.create(this);
  12.     child.pino = pino.child(...arguments);
  13.     return child;
  14.   },
  15. };
  17. const fastify = require('fastify')({logger: customLogger});

disableRequestLogging

默认情况下当开启日志时，Fastify 会在收到请求与发送该请求的响应时记录 info 级别的日志。你可以设置该选项为 true 来禁用该功能。这时，通过自定义 onRequest 和 onResponse 钩子，你能更灵活地记录一个请求的开始与结束。

  • 默认值：false
  1. // 例子：通过钩子再造被禁用的请求日志功能。
  2. fastify.addHook('onRequest', (req, reply, done) => {
  3.   req.log.info({ url: req.raw.url, id: req.id }, 'received request')
  4.   done()
  5. })
  7. fastify.addHook('onResponse', (req, reply, done) => {
  8.   req.log.info({ url: req.raw.originalUrl, statusCode: reply.raw.statusCode }, 'request completed')
  9.   done()
  10. })

请注意，该选项同时也会禁止默认的 onResponse 钩子在响应的回调函数出错时记录错误日志。

serverFactory

通过 serverFactory 选项，你可以向 Fastify 传递一个自定义的 HTTP server。
serverFactory 函数的参数为 handler 函数及一个选项对象。handler 函数的参数为 request 和 response 对象，选项对象则与你传递给 Fastify 的一致。

  1. const serverFactory = (handler, opts) => {
  2.   const server = http.createServer((req, res) => {
  3.     handler(req, res)
  4.   })
  6.   return server
  7. }
  9. const fastify = Fastify({ serverFactory })
  11. fastify.get('/', (req, reply) => {
  12.   reply.send({ hello: 'world' })
  13. })
  15. fastify.listen(3000)

Fastify 内在地使用 Node 原生 HTTP server 的 API。因此，如果你使用一个自定义的 server，你必须保证暴露了相同的 API。不这么做的话，你可以在 serverFactory 函数内部 return 语句之前，向 server 实例添加新的属性。

caseSensitive

默认值为 true，此时路由对大小写敏感。这就意味着 /foo 与 /Foo 是两个不同的路由。当该选项为 false 时，路由大小写不敏感，/foo、/Foo 以及 /FOO 都是一样的。

将 caseSensitive 设置为 false，会导致所有路径变为小写，除了路由参数与通配符。

  1. fastify.get('/user/:username', (request, reply) => {
  2.   // 原 URL: /USER/NodeJS
  3.   console.log(request.params.username) // -> 'NodeJS'
  4. })

要注意的是，将该选项设为 false 与 RFC3986 相悖。

requestIdHeader

用来获知请求 ID 的 header 名。请看请求 ID 一节。

  • 默认值：'request-id'

requestIdLogLabel

定义日志中请求 ID 的标签。

  • 默认值：'reqId'

genReqId

用于生成请求 ID 的函数。参数为来访的请求对象。

  • 默认值：'request-id' header 的值 (当存在时) 或单调递增的整数 在分布式系统中，你可能会特别想覆盖如下默认的 ID 生成行为。要生成 UUID，请看hyperid。
  1. let i = 0
  2. const fastify = require('fastify')({
  3.  genReqId: function (req) { return i++ }
  4. })

注意：当设置了 [requestIdHeader](#requestidheader) 中定义的 header (默认为 ‘request-id’) 时，genReqId 不会 被调用。

trustProxy

通过开启 trustProxy 选项，Fastify 会认为使用了代理服务，且 X-Forwarded-* header 是可信的，否则该值被认为是极具欺骗性的。

  1. const fastify = Fastify({ trustProxy: true })
  • 默认值：false
  • true/false: 信任所有代理 (true) 或不信任任意的代理 (false)。
  • string: 只信任给定的 IP/CIDR (例如 '127.0.0.1')。可以是一组用英文逗号分隔的地址 (例如 '127.0.0.1,192.168.1.1/24')。
  • Array<string>: 只信任给定的 IP/CIDR 列表 (例如 ['127.0.0.1'])。
  • number: 信任来自前置代理服务器的第n跳 (hop) 地址作为客户端。

  • Function: 自定义的信任函数，第一个参数为 address

    1. function myTrustFn(address, hop) {
    2.   return address === '1.2.3.4' || hop === 1
    3. }

更多示例详见 @fastify/proxy-addr。

你还可以通过 request 对象获取 ip、ips、hostname 与 protocol 的值。

  1. fastify.get('/', (request, reply) => {
  2.   console.log(request.ip)
  3.   console.log(request.ips)
  4.   console.log(request.hostname)
  5.   console.log(request.protocol)
  6. })

注：如果请求存在多个 x-forwarded-host 或 x-forwarded-proto header，只会根据最后一个产生 request.hostname 和 request.protocol

pluginTimeout

单个插件允许加载的最长时间，以毫秒计。如果某个插件加载超时，则 ready 会抛出一个含有 'ERR_AVVIO_PLUGIN_TIMEOUT' 代码的 Error 对象。

  • 默认值：10000

querystringParser

Fastify 默认使用 Node.js 核心的 querystring 模块作为 query string 解析器。
你可以通过 querystringParser 选项来使用自定义的解析器，例如 qs。

  1. const qs = require('qs')
  2. const fastify = require('fastify')({
  3.   querystringParser: str => qs.parse(str)
  4. })

exposeHeadRoutes

自动为每个 GET 路由添加对应的 HEAD 路由。如果你不想禁用该选项，又希望自定义 HEAD 处理函数，请在 GET 路由前定义该处理函数。

  • 默认值：false

constraints

Fastify 内建的路由约束由 find-my-way 支持，允许使用 version 或 host 来约束路由。通过为 find-my-way 提供 constraints 对象，你可以添加新的约束策略，或覆盖原有策略。更多内容可见于 find-my-way 的文档。

  1. const customVersionStrategy = {
  2.   storage: function () {
  3.     let versions = {}
  4.     return {
  5.       get: (version) => { return versions[version] || null },
  6.       set: (version, store) => { versions[version] = store },
  7.       del: (version) => { delete versions[version] },
  8.       empty: () => { versions = {} }
  9.     }
  10.   },
  11.   deriveVersion: (req, ctx) => {
  12.     return req.headers['accept']
  13.   }
  14. }
  16. const fastify = require('fastify')({
  17.   constraints: {
  18.     version: customVersionStrategy
  19.   }
  20. })

return503OnClosing

调用 close 方法后返回 503 状态码。 如果为 false，服务器会正常处理请求。

  • 默认值：true

ajv

配置 Fastify 使用的 Ajv 实例。这使得你无需提供一个自定义的实例。

  • 默认值：
  1. {
  2.   customOptions: {
  3.     removeAdditional: true,
  4.     useDefaults: true,
  5.     coerceTypes: true,
  6.     allErrors: false,
  7.     nullable: true
  8.   },
  9.   plugins: []
  10. }
  1. const fastify = require('fastify')({
  2.   ajv: {
  3.     customOptions: {
  4.       nullable: false // 参见 [ajv 的配置选项](https://ajv.js.org/#options)
  5.     },
  6.     plugins: [
  7.       require('ajv-merge-patch')
  8.       [require('ajv-keywords'), 'instanceof'];
  9.       // 用法： [plugin, pluginOptions] - 插件与选项
  10.       // 用法： plugin - 仅插件
  11.     ]
  12.   }
  13. })

http2SessionTimeout

为每个 HTTP/2 会话设置默认超时时间。超时后，会话将关闭。默认值：5000 毫秒。

要注意的是，使用 HTTP/2 时需要提供一个优雅的“close”体验。Node 的默认值为 0，即无超时。

frameworkErrors

  • 默认值：null

对于最常见的场景，Fastify 已经提供了默认的错误处理方法。这个选项允许你重写这些处理方法。

注：目前只实现了 FST_ERR_BAD_URL 这个错误。

  1. const fastify = require('fastify')({
  2.   frameworkErrors: function (error, req, res) {
  3.     if (error instanceof FST_ERR_BAD_URL) {
  4.       res.code(400)
  5.       return res.send("Provided url is not valid")
  6.     } else {
  7.       res.send(err)
  8.     }
  9.   }
  10. })

clientErrorHandler

设置 clientErrorHandler 来监听客户端连接造成的 error 事件，并响应 400 状态码。

设置了该选项，会覆盖默认的 clientErrorHandler。

  • 默认值：
  1. function defaultClientErrorHandler (err, socket) {
  2.   if (err.code === 'ECONNRESET') {
  3.     return
  4.   }
  6.   const body = JSON.stringify({
  7.     error: http.STATUS_CODES['400'],
  8.     message: 'Client Error',
  9.     statusCode: 400
  10.   })
  11.   this.log.trace({ err }, 'client error')
  13.   if (socket.writable) {
  14.     socket.end(`HTTP/1.1 400 Bad Request\r\nContent-Length: ${body.length}\r\nContent-Type: application/json\r\n\r\n${body}`)
  15.   }
  16. }

注：clientErrorHandler 使用底层的 socket，故处理函数需要返回格式正确的 HTTP 响应信息，包括状态行、HTTP header 以及 body。在写入之前，为了避免 socket 已被销毁，你还应该检查 socket 是否依然可写。

  1. const fastify = require('fastify')({
  2.   clientErrorHandler: function (err, socket) {
  3.     const body = JSON.stringify({
  4.       error: {
  5.         message: 'Client error',
  6.         code: '400'
  7.       }
  8.     })
  9.     // `this` 为 fastify 实例
  10.     this.log.trace({ err }, 'client error')
  11.     // 处理函数应当发送正确的 HTTP 响应信息。
  12.     socket.end(`HTTP/1.1 400 Bad Request\r\nContent-Length: ${body.length}\r\nContent-Type: application/json\r\n\r\n${body}`)
  13.   }
  14. })

rewriteUrl

设置一个异步函数，返回一个字符串，用于重写 URL。

重写 URL 会修改 req 对象的 url 属性

  1. function rewriteUrl (req) { // req 是 Node.js 的 HTTP 请求对象
  2.   return req.url === '/hi' ? '/hello' : req.url;
  3. }

要注意的是，rewriteUrl 在处理路由 前 被调用，它不是封装的，而是整个应用级别的。

实例

服务器方法

服务器

fastify.server：由 Fastify 的工厂函数 生成的 Node 原生 server 对象。

after

当前插件及在其中注册的所有插件加载完毕后调用。总在 fastify.ready 之前执行。

  1. fastify
  2.   .register((instance, opts, done) => {
  3.     console.log('当前插件')
  4.     done()
  5.   })
  6.   .after(err => {
  7.     console.log('当前插件之后')
  8.   })
  9.   .register((instance, opts, done) => {
  10.     console.log('下一个插件')
  11.     done()
  12.   })
  13.   .ready(err => {
  14.     console.log('万事俱备')
  15.   })

当 after() 没有回调参数时，它返回一个 Promise：

  1. fastify.register(async (instance, opts) => {
  2.   console.log('Current plugin')
  3. })
  5. await fastify.after()
  6. console.log('After current plugin')
  8. fastify.register(async (instance, opts) => {
  9.   console.log('Next plugin')
  10. })
  12. await fastify.ready()
  14. console.log('Everything has been loaded')

ready

当所有插件的加载都完成时调用。如有错误发生，它会传递一个 error 参数。

  1. fastify.ready(err => {
  2.   if (err) throw err
  3. })

调用时不加参数，它会返回一个 Promise 对象：

  1. fastify.ready().then(() => {
  2.   console.log('successfully booted!')
  3. }, (err) => {
  4.   console.log('an error happened', err)
  5. })

listen

所有的插件加载完毕、ready 事件触发后，在指定的端口启动服务器。它的回调函数与 Node 原生方法的回调相同。默认情况下，服务器监听 localhost 所决定的地址 (127.0.0.1 或 ::1，取决于操作系统)。将地址设置为 0.0.0.0 可监听所有的 IPV4 地址。设置为 :: 则可监听所有的 IPV6 地址，在某些系统中，这么做亦可同时监听所有 IPV4 地址。监听所有的接口要格外谨慎，因为这种方式存在着固有的安全风险。

  1. fastify.listen(3000, (err, address) => {
  2.   if (err) {
  3.     fastify.log.error(err)
  4.     process.exit(1)
  5.   }
  6. })

指定监听的地址：

  1. fastify.listen(3000, '127.0.0.1', (err, address) => {
  2.   if (err) {
  3.     fastify.log.error(err)
  4.     process.exit(1)
  5.   }
  6. })

指定积压队列 (backlog queue size) 的大小：

  1. fastify.listen(3000, '127.0.0.1', 511, (err, address) => {
  2.   if (err) {
  3.     fastify.log.error(err)
  4.     process.exit(1)
  5.   }
  6. })

没有提供回调函数时，它会返回一个 Promise 对象：

  1. fastify.listen(3000)
  2.   .then((address) => console.log(`server listening on ${address}`))
  3.   .catch(err => {
  4.     console.log('Error starting server:', err)
  5.     process.exit(1)
  6.   })

你还可以在使用 Promise 的同时指定地址：

  1. fastify.listen(3000, '127.0.0.1')
  2.   .then((address) => console.log(`server listening on ${address}`))
  3.   .catch(err => {
  4.     console.log('Error starting server:', err)
  5.     process.exit(1)
  6.   })

当部署在 Docker 或其它容器上时，明智的做法是监听 0.0.0.0。因为默认情况下，这些容器并未将映射的端口暴露在 127.0.0.1：

  1. fastify.listen(3000, '0.0.0.0', (err, address) => {
  2.   if (err) {
  3.     fastify.log.error(err)
  4.     process.exit(1)
  5.   }
  6. })

假如未设置 port (或设为 0)，则会自动选择一个随机可用的端口 (之后可通过 fastify.server.address().port 获知)。

getDefaultRoute

获取服务器 defaultRoute 属性的方法：

  1. const defaultRoute = fastify.getDefaultRoute()

setDefaultRoute

设置服务器 defaultRoute 属性的方法：

  1. const defaultRoute = function (req, res) {
  2.   res.end('hello world')
  3. }
  5. fastify.setDefaultRoute(defaultRoute)

routing

访问内部路由库的 lookup 方法，该方法将请求匹配到合适的处理函数：

  1. fastify.routing(req, res)

route

将路由添加到服务器的方法，支持简写。请看这里。

close

fastify.close(callback)：调用这个函数来关闭服务器实例，并触发 'onClose' 钩子。
服务器会向所有新的请求发送 503 错误，并销毁它们。 要改变这一行为，请见 return503OnClosing。

如果无参调用，它会返回一个 Promise：

  1. fastify.close().then(() => {
  2.  console.log('successfully closed!')
  3. }, (err) => {
  4.  console.log('an error happened', err)
  5. })

decorate*

向 Fastify 实例、响应或请求添加装饰器函数。参阅这里了解更多。

register

Fastify 允许用户通过插件扩展功能。插件可以是一组路由、装饰器或其他。请看这里。

addHook

向 Fastify 添加特定的生命周期钩子函数，请看这里。

prefix

添加在路由前的完整路径。

示例：

  1. fastify.register(function (instance, opts, done) {
  2.   instance.get('/foo', function (request, reply) {
  3.     // 输出："prefix: /v1"
  4.     request.log.info('prefix: %s', instance.prefix)
  5.     reply.send({prefix: instance.prefix})
  6.   })
  8.   instance.register(function (instance, opts, done) {
  9.     instance.get('/bar', function (request, reply) {
  10.       // 输出："prefix: /v1/v2"
  11.       request.log.info('prefix: %s', instance.prefix)
  12.       reply.send({prefix: instance.prefix})
  13.     })
  15.     done()
  16.   }, { prefix: '/v2' })
  18.   done()
  19. }, { prefix: '/v1' })

pluginName

当前插件的名称。有三种定义插件名称的方式（按顺序）。

  1. 如果插件使用 fastify-plugin，那么名称为元数据 (metadata) 中的 name。
  2. 如果插件通过 module.exports 导出，使用文件名。
  3. 如果插件通过常规的 函数定义，则使用函数名。

回退方案：插件函数的头两行将作为插件名，并使用 -- 替代换行符。这有助于在处理涉及许多插件的问题时，找到根源。

重点：如果你要处理一些通过 fastify-plugin 包装的嵌套的异名插件，由于没有生成新的定义域，因此不会去覆盖上下文数据，而是将各插件名加入一个数组。在这种情况下，会按涉及到的插件的启动顺序，以 plugin-A -> plugin-B 的格式来展示插件名称。

log

日志的实例，详见这里。

version

Fastify 实例的版本。可在插件中使用。详见插件一文。

inject

伪造 HTTP 注入 (作为测试之用) 。请看更多内容。

addSchema

fastify.addSchema(schemaObj)，向 Fastify 实例添加 JSON schema。你可以通过 $ref 关键字在应用的任意位置使用它。
更多内容，请看验证和序列化。

getSchemas

fastify.getSchemas()，返回一个对象，包含所有通过 addSchema 添加的 schema，对象的键是 JSON schema 的 $id。

getSchema

fastify.getSchema(id)，返回通过 addSchema 添加的拥有匹配 id 的 schema，未找到则返回 undefined。

setReplySerializer

作用于未设置 Reply.serializer(func) 的所有路由的默认序列化方法。这个处理函数是完全封装的，因此，不同的插件允许有不同的错误处理函数。 注：仅当状态码为 2xx 时才被调用。关于错误处理，请看 setErrorHandler。

  1. fastify.setReplySerializer(function (payload, statusCode){
  2.  // 使用同步函数序列化 payload
  3.  return `my serialized ${statusCode} content: ${payload}`
  4. })

setValidatorCompiler

为所有的路由设置 schema 校验编译器 (validator compiler)。详见 #schema-validator。

setSchemaErrorFormatter

为所有的路由设置 schema 错误格式化器 (schema error formatter)。详见 #error-handling。

setSerializerCompiler

为所有的路由设置 schema 序列化编译器 (serializer compiler)。详见 #schema-serializer。 注： setReplySerializer 有更高的优先级！

validatorCompiler

该属性用于获取 schema 校验器。未设置校验器时，在服务器启动前，该值是 null，之后是一个签名为 function ({ schema, method, url, httpPart }) 的函数。该函数将 schema 参数编译为一个校验数据的函数，并返回生成的函数。 schema 参数能访问到所有通过 .addSchema 添加的共用 schema。

serializerCompiler

该属性用于获取 schema 序列化器。未设置序列化器时，在服务器启动前，该值是 null，之后是一个签名为 function ({ schema, method, url, httpPart }) 的函数。该函数将 schema 参数编译为一个校验数据的函数，并返回生成的函数。 schema 参数能访问到所有通过 .addSchema 添加的共用 schema。

schemaErrorFormatter

该属性设置一个函数用于格式化 validationCompiler 在校验 schema 时发生的错误。详见 #error-handling。

schemaController

该属性用于管理应用的 schema 的存放位置，可用于 Fastify 无法分辨保存于某些数据结构中的 schema 之时。在 issue #2446 里有一个通过该属性解决问题的例子。

  1. const fastify = Fastify({
  2.   schemaController: {
  3.     /**
  4.      * 以下的 factory 函数会在每次调用 `fastify.register()` 时被执行。
  5.      * 若父级上下文添加了 schema，它会作为参数传入 factory 函数。
  6.      * @param {object} parentSchemas 会由 `bucket` 对象的 `getSchemas()` 方法返回。
  8.      */
  9.     bucket: function factory (parentSchemas) {
  10.       return {
  11.         addSchema (inputSchema) {
  12.           // 该函数保存用户添加的 schema。
  13.           // 调用 `fastify.addSchema()` 时被执行。
  14.         },
  15.         getSchema (schema$id) {
  16.           // 该函数返回通过 `schema$id` 检索得到的原始 schema。
  17.           // 调用 `fastify.getSchema()` 时被执行。
  18.           return aSchema
  19.         },
  20.         getSchemas () {
  21.           // 返回路由 schema 中通过 $ref 引用的所有 schema。
  22.           // 返回对象以 schema 的 `$id` 为键，以原始内容为值。
  23.           const allTheSchemaStored = {
  24.             'schema$id1': schema1,
  25.             'schema$id2': schema2
  26.           }
  27.           return allTheSchemaStored
  28.         }
  29.       }
  30.     }
  31.   }
  32. });

setNotFoundHandler

fastify.setNotFoundHandler(handler(request, reply))：为 404 状态 (not found) 设置处理函数 (handler)。向 fastify.register() 传递不同的 prefix 选项，就可以为不同的插件设置不同的处理函数。这些处理函数被视为常规的路由处理函数，因此它们的请求会经历一个完整的 Fastify 生命周期。

你也可以为 404 处理函数注册 preValidation 或 preHandler 钩子。

注：通过此方法注册的 preValidation 钩子会在遇到未知路由时触发，但手动调用 reply.callNotFound 方法时则不会。此时只有 preHandler 会执行。

  1. fastify.setNotFoundHandler({
  2.   preValidation: (req, reply, done) => {
  3.     // 你的代码
  4.     done()
  5.   } ,
  6.   preHandler: (req, reply, done) => {
  7.     // 你的代码
  8.     done()
  9.   }  
  10. }, function (request, reply) {
  11.     // 设置了 preValidation 与 preHandler 钩子的默认 not found 处理函数
  12. })
  14. fastify.register(function (instance, options, done) {
  15.   instance.setNotFoundHandler(function (request, reply) {
  16.     // '/v1' 开头的 URL 的 not found 处理函数，
  17.     // 未设置 preValidation 与 preHandler 钩子
  18.   })
  19.   done()
  20. }, { prefix: '/v1' })

setErrorHandler

fastify.setErrorHandler(handler(error, request, reply))：设置任意时刻的错误处理函数。错误处理函数绑定在 Fastify 实例之上，是完全封装 (fully encapsulated) 的，因此不同插件的处理函数可以不同。支持 async-await 语法。
注：假如错误的 statusCode 小于 400，在处理错误前 Fastify 将会自动将其设为 500。

  1. fastify.setErrorHandler(function (error, request, reply) {
  2.   // 记录错误
  3.   this.log.error(error)
  4.   // 发送错误响应
  5.   reply.status(409).send({ ok: false })
  6. })

当没有设置错误处理函数时，Fastify 会调用一个默认函数。你能通过 fastify.errorHandler 访问该函数。它根据 statusCode 相应地记录日志。

  1. var statusCode = error.statusCode
  2. if (statusCode >= 500) {
  3.   log.error(error)
  4. } else if (statusCode >= 400) {
  5.   log.info(error)
  6. } else {
  7.   log.error(error)
  8. }

printRoutes

fastify.printRoutes()：打印路由的基数树 (radix tree)，可作调试之用。可以用 fastify.printRoutes({ commonPrefix: false }) 来打印扁平化后的路由
记得在 ready 函数的内部或之后调用它。

  1. fastify.get('/test', () => {})
  2. fastify.get('/test/hello', () => {})
  3. fastify.get('/hello/world', () => {})
  5. fastify.ready(() => {
  6.   console.log(fastify.printRoutes())
  7.   // └── /
  8.   //     ├── test (GET)
  9.   //     │   └── /hello (GET)
  10.   //     └── hel
  11.   //         ├── lo/world (GET)
  12.   //         └── licopter (GET)
  14.   console.log(fastify.printRoutes({ commonPrefix: false }))
  15.   // └── / (-)
  16.   //     ├── test (GET)
  17.   //     │   └── /hello (GET)
  18.   //     ├── hello/world (GET)
  19.   //     └── helicopter (GET)
  20. })

printPlugins

fastify.printPlugins()：打印 avvio 内部的插件树，可用于调试插件注册顺序相关的问题。
请在 ready 事件的回调中或事件触发之后调用该方法。

  1. fastify.register(async function foo (instance) {
  2.   instance.register(async function bar () {})
  3. })
  4. fastify.register(async function baz () {})
  6. fastify.ready(() => {
  7.   console.error(fastify.printPlugins())
  8.   // 输出：
  9.   // └── root
  10.   //   ├── foo
  11.   //   │   └── bar
  12.   //   └── baz
  13. })

addContentTypeParser

fastify.addContentTypeParser(content-type, options, parser) 用于给指定 content type 自定义解析器，当你使用自定义的 content types 时会很有帮助。例如 text/json, application/vnd.oasis.opendocument.text。content-type 是一个字符串、字符串数组或正则表达式。

  1. // 传递给 getDefaultJsonParser 的两个参数用于配置原型污染以及构造函数污染，允许的值为 'ignore'、'remove' 和 'error'。设置为 ignore 会跳过校验，和直接调用 JSON.parse() 效果相同。详见 <a href="https://github.com/fastify/secure-json-parse#api">`secure-json-parse` 的文档</a>。
  3. fastify.addContentTypeParser('text/json', { asString: true }, fastify.getDefaultJsonParser('ignore', 'ignore'))

getDefaultJsonParser

fastify.getDefaultJsonParser(onProtoPoisoning, onConstructorPoisoning) 接受两个参数。第一个参数是原型污染的配置，第二个则是构造函数污染的配置。详见 secure-json-parse 的文档。

defaultTextParser

fastify.defaultTextParser() 可用于将 content 解析为纯文本。

  1. fastify.addContentTypeParser('text/json', { asString: true }, fastify.defaultTextParser())

errorHandler

fastify.errorHandler 使用 Fastify 默认的错误处理函数来处理错误。

  1. fastify.get('/', {
  2.   errorHandler: (error, request, reply) => {
  3.     if (error.code === 'SOMETHING_SPECIFIC') {
  4.       reply.send({ custom: 'response' })
  5.       return
  6.     }
  8.     fastify.errorHandler(error, request, response)
  9.   }
  10. }, handler)

initialConfig

fastify.initialConfig：暴露一个记录了 Fastify 初始选项的只读对象。

当前暴露的属性有：

  • connectionTimeout
  • keepAliveTimeout
  • bodyLimit
  • caseSensitive
  • http2
  • https (返回 false/true。当特别指明时，返回 { allowHTTP1: true/false })
  • ignoreTrailingSlash
  • disableRequestLogging
  • maxParamLength
  • onProtoPoisoning
  • onConstructorPoisoning
  • pluginTimeout
  • requestIdHeader
  • requestIdLogLabel
  • http2SessionTimeout
  1. const { readFileSync } = require('fs')
  2. const Fastify = require('fastify')
  4. const fastify = Fastify({
  5.   https: {
  6.     allowHTTP1: true,
  7.     key: readFileSync('./fastify.key'),
  8.     cert: readFileSync('./fastify.cert')
  9.   },
  10.   logger: { level: 'trace'},
  11.   ignoreTrailingSlash: true,
  12.   maxParamLength: 200,
  13.   caseSensitive: true,
  14.   trustProxy: '127.0.0.1,192.168.1.1/24',
  15. })
  17. console.log(fastify.initialConfig)
  18. /*
  19. 输出：
  20. {
  21.   caseSensitive: true,
  22.   https: { allowHTTP1: true },
  23.   ignoreTrailingSlash: true,
  24.   maxParamLength: 200
  25. }
  26. */
  28. fastify.register(async (instance, opts) => {
  29.   instance.get('/', async (request, reply) => {
  30.     return instance.initialConfig
  31.     /*
  32.     返回：
  33.     {
  34.       caseSensitive: true,
  35.       https: { allowHTTP1: true },
  36.       ignoreTrailingSlash: true,
  37.       maxParamLength: 200
  38.     }
  39.     */
  40.   })
  42.   instance.get('/error', async (request, reply) => {
  43.     // 会抛出错误
  44.     // 因为 initialConfig 是只读的，不可修改
  45.     instance.initialConfig.https.allowHTTP1 = false
  47.     return instance.initialConfig
  48.   })
  49. })
  51. // 开始监听
  52. fastify.listen(3000, (err) => {
  53.   if (err) {
  54.     fastify.log.error(err)
  55.     process.exit(1)
  56.   }
  57. })