Fastify 中文文档 (latest — v2.14.1)

Fastify

工厂函数

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

http2

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

  • 默认值:false

https

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

http2 选项设置时,https 选项也会被应用。

  • 默认值:null

ignoreTrailingSlash

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

  • 默认值:false
const fastify = require('fastify')({
  ignoreTrailingSlash: true
})

// 同时注册 "/foo" 与 "/foo/"
fastify.get('/foo/', function (req, reply) {
  reply.send('foo')
})

// 同时注册 "/bar" 与 "/bar/"
fastify.get('/bar', function (req, reply) {
  reply.send('bar')
})

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 的构造函数。如果下列属性未在该对象中定义,它们将被相应地添加:

    • genReqId: 一个同步函数,用于生成请求的标识符。默认生成按次序排列的标识符。
    • level: 最低的日志级别。若未被设置,则默认为 'info'
    • serializers: 序列化函数的哈希。默认情况下,序列化函数应用在 req (来访的请求对象)、res (发送的响应对象) 以及 err (标准的 Error 对象) 之上。当一个日志方法接收到含有上述任意属性的对象时,对应的序列化器将会作用于该属性。举例如下:
        fastify.get('/foo', function (req, res) {
          req.log.info({req}) // 日志输出经过序列化的请求对象
          res.send('foo')
        })
      用户提供的序列化函数将会覆盖对应属性默认的序列化函数。
  • loggerInstance:自定义日志工具实例。日志工具必须实现 Pino 的接口,即拥有如下方法:info, error, debug, fatal, warn, trace, child。例如:

    const pino = require('pino')();
    

const customLogger = { info: function (o, ...n) {}, warn: function (o, ...n) {}, error: function (o, ...n) {}, fatal: function (o, ...n) {}, trace: function (o, ...n) {}, debug: function (o, ...n) {}, child: function() { const child = Object.create(this); child.pino = pino.child(...arguments); return child; }, };

const fastify = require('fastify')({logger: customLogger});


<a name="factory-disable-request-logging"></a>
### `disableRequestLogging`
默认情况下当开启日志时,Fastify 会在收到请求与发送该请求的响应时记录 `info` 级别的日志。你可以设置该选项为 `true` 来禁用该功能。这时,通过自定义 `onRequest` 和 `onResponse` 钩子,你能更灵活地记录一个请求的开始与结束。

+ 默认值:`false`

```js
// 例子:通过钩子再造被禁用的请求日志功能。
fastify.addHook('onRequest', (req, reply, done) => {
  req.log.info({ url: req.req.url, id: req.id }, 'received request')
  done()
})

fastify.addHook('onResponse', (req, reply, done) => {
  req.log.info({ url: req.req.originalUrl, statusCode: reply.res.statusCode }, 'request completed')
  done()
})

serverFactory

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

const serverFactory = (handler, opts) => {
  const server = http.createServer((req, res) => {
    handler(req, res)
  })

  return server
}

const fastify = Fastify({ serverFactory, modifyCoreObjects: false })

fastify.get('/', (req, reply) => {
  reply.send({ hello: 'world' })
})

fastify.listen(3000)

Fastify 内在地使用 Node 原生 http server 的 API。因此,如果你使用一个自定义的 server,你必须保证暴露了相同的 API。不这么做的话,你可以在 serverFactory 函数内部 return 语句之前,向 server 实例添加新的属性。
要注意的是,我们也设置了 modifyCoreObjects: false。这是因为在诸如 Google Cloud Functions 等无服务器 (serverless) 环境下,一些 Node.js 核心的属性是不可写的。

caseSensitive

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

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

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

要注意的是,将该选项设为 falseRFC3986 相悖。

requestIdHeader

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

  • 默认值:'request-id'

requestIdLogLabel

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

  • 默认值:'reqId'

genReqId

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

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

注意:当设置了 requestIdHeader 中定义的 header (默认为 'request-id') 时,genReqId 不会 被调用。

trustProxy

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

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
      function myTrustFn(address, hop) {
        return address === '1.2.3.4' || hop === 1
      }

更多示例详见 proxy-addr

你还可以通过 request 对象获取 ipipshostname 的值。

fastify.get('/', (request, reply) => {
  console.log(request.ip)
  console.log(request.ips)
  console.log(request.hostname)
})

pluginTimeout

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

  • 默认值:10000

    querystringParser

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

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

versioning

默认情况下,find-my-way 使用 semver 版本号规范来为路由设置版本号。你也可以使用自定义的版本号策略。更多信息请看 find-my-way 的文档。

const versioning = {
  storage: function () {
    let versions = {}
    return {
      get: (version) => { return versions[version] || null },
      set: (version, store) => { versions[version] = store },
      del: (version) => { delete versions[version] },
      empty: () => { versions = {} }
    }
  },
  deriveVersion: (req, ctx) => {
    return req.headers['accept']
  }
}
 const fastify = require('fastify')({
  versioning
})

modifyCoreObjects

  • 默认值:true

默认情况下,Fastify 会向 Node 原生的 request 对象添加 ipipshostname 以及 log 属性 (参见 Request),向原生的 response 对象添加 log 属性。你可以将 modifyCoreObjects 设为 false 来避免上述行为。

const fastify = Fastify({ modifyCoreObjects: true }) // 默认值

fastify.get('/', (request, reply) => {
  console.log(request.raw.ip)
  console.log(request.raw.ips)
  console.log(request.raw.hostname)
  request.raw.log('Hello')
  reply.res.log('World')
})

在诸如 Google Cloud Functions 等无服务器 (serverless) 环境下,禁用该选项是有用的。因为在这些环境中,ipips 并不可写。

请注意,我们不建议使用这些属性。它们将会在 Fastify 的下个主要版本中,与该选项一起去除。作为替代,我们推荐使用 Fastify 的 RequestReply 对象上相同的属性。

const fastify = Fastify({ modifyCoreObjects: false })

fastify.get('/', (request, reply) => {
  console.log(request.ip)
  console.log(request.ips)
  console.log(request.hostname)
  request.log('Hello')
  reply.log('World')
})

return503OnClosing

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

  • 默认值:true

ajv

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

  • 默认值:
{
  customOptions: {
    removeAdditional: true,
    useDefaults: true,
    coerceTypes: true,
    allErrors: true,
    nullable: true
  },
  plugins: []
}
const fastify = require('fastify')({
  ajv: {
    customOptions: {
      nullable: false // 参见 [ajv 的配置选项](https://ajv.js.org/#options)
    },
    plugins: [
      require('ajv-merge-patch')
      [require('ajv-keywords'), 'instanceof'];
      // 用法: [plugin, pluginOptions] - 插件与选项
      // 用法: plugin - 仅插件
    ]
  }
})

http2SessionTimeout

为每个 http2 会话设置默认超时时间。超时后,会话将关闭。默认值:5000 毫秒。

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

frameworkErrors

  • 默认值:null

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

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

const fastify = require('fastify')({
  frameworkErrors: function (error, req, res) {
    if (error instanceof FST_ERR_BAD_URL) {
      res.code(400)
      return res.send("Provided url is not valid")
    } else {
      res.send(err)
    }
  }
})

实例

服务器方法

服务器

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

after

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

fastify
  .register((instance, opts, done) => {
    console.log('当前插件')
    done()
  })
  .after(err => {
    console.log('当前插件之后')
  })
  .register((instance, opts, done) => {
    console.log('下一个插件')
    done()
  })
  .ready(err => {
    console.log('万事俱备')
  })

ready

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

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

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

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

listen

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

fastify.listen(3000, (err, address) => {
  if (err) {
    fastify.log.error(err)
    process.exit(1)
  }
})

指定监听的地址:

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

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

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

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

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

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

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

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

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

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

route

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

close

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

如果无参调用,它会返回一个 Promise:

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

decorate*

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

register

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

use

向 Fastify 添加中间件,请看这里

addHook

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

prefix

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

示例:

fastify.register(function (instance, opts, done) {
  instance.get('/foo', function (request, reply) {
    // 输出:"prefix: /v1"
    request.log.info('prefix: %s', instance.prefix)
    reply.send({prefix: instance.prefix})
  })

  instance.register(function (instance, opts, done) {
    instance.get('/bar', function (request, reply) {
      // 输出:"prefix: /v1/v2"
      request.log.info('prefix: %s', instance.prefix)
      reply.send({prefix: instance.prefix})
    })

    done()
  }, { prefix: '/v2' })

  done()
}, { prefix: '/v1' })

pluginName

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

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

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

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

log

日志的实例,详见这里

inject

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

addSchema

fastify.addSchema(schemaObj),向 Fastify 实例添加可共用的 schema,用于验证数据。你可以通过该 schema 的 id 在应用的任意位置使用它。
请看验证和序列化一文中的范例

setReplySerializer

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

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

setSchemaCompiler

为所有的路由设置 schema 编译器 (schema compiler),请看这里了解更多信息。

setSchemaResolver

为所有的路由设置 schema $ref 解析器 (schema $ref resolver),请看这里了解更多信息。

schemaCompiler

setSchemaCompiler 方法的简写。用于设置 schema 编译器函数,也可用于返回全部路由的 schema 编译器。

setNotFoundHandler

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

你也可以为 404 处理函数注册一个 preValidationpreHandler 钩子。

fastify.setNotFoundHandler({
  preValidation: (req, reply, done) => {
    // 你的代码
    done()
  } ,
  preHandler: (req, reply, done) => {
    // 你的代码
    done()
  }  
}, function (request, reply) {
    // 设置了 preValidation 与 preHandler 钩子的默认 not found 处理函数
})

fastify.register(function (instance, options, done) {
  instance.setNotFoundHandler(function (request, reply) {
    // '/v1' 开头的 URL 的 not found 处理函数,
    // 未设置 preValidation 与 preHandler 钩子
  })
  done()
}, { prefix: '/v1' })

setErrorHandler

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

fastify.setErrorHandler(function (error, request, reply) {
  // 记录错误
  // 发送错误响应
})

当没有设置错误处理函数时,Fastify 会调用一个默认函数,并根据 statusCode 相应地记录日志:

var statusCode = error.statusCode
if (statusCode >= 500) {
  log.error(error)
} else if (statusCode >= 400) {
  log.info(error)
} else {
  log.error(error)
}

printRoutes

fastify.printRoutes():打印路由的基数树 (radix tree),可作调试之用。
记得在 ready 函数的内部或之后调用它。

fastify.get('/test', () => {})
fastify.get('/test/hello', () => {})
fastify.get('/hello/world', () => {})

fastify.ready(() => {
  console.log(fastify.printRoutes())
  // └── /
  //   ├── test (GET)
  //   │   └── /hello (GET)
  //   └── hello/world (GET)
})