Skip to content

Latest commit

 

History

History
186 lines (138 loc) · 6.93 KB

Plugins.md

File metadata and controls

186 lines (138 loc) · 6.93 KB
Raw

Fastify

插件

Fastify 允许用户通过插件的方式扩展自身的功能。 一个插件可以是一组路由，一个服务器装饰器或者其他任意的东西。 在使用一个或者许多插件时，只需要一个 API register。

默认, register 会创建一个 新的作用域( Scope ), 这意味着你能够改变 Fastify 实例(通过decorate), 这个改变不会反映到当前作用域, 只会影响到子作用域。 这样可以做到插件的封装和继承, 我们创建了一个无回路有向图(DAG), 因此不会有交叉依赖的问题。

你已经在起步部分很直观的看到了怎么使用这个 API。

fastify.register(plugin, [options])

插件选项

fastify.register 可选参数列表支持一组预定义的 Fastify 可用的参数, 除了当插件使用了 fastify-plugin。 选项对象会在插件被调用传递进去, 无论这个插件是否用了 fastify-plugin。 当前支持的选项有:

注意：当使用 fastify-plugin 时，这些选项会被忽略

Fastify 有可能在将来会直接支持其他的选项。 因此为了避免冲突, 插件应该考虑给选项加入命名空间。 举个例子, 插件 foo 可以像以下代码一样注册:

fastify.register(require('fastify-foo'), {
  prefix: '/foo',
  foo: {
    fooOption1: 'value',
    fooOption2: 'value'
  }
})

如果不考虑冲突, 插件可以简化成直接接收对象参数:

fastify.register(require('fastify-foo'), {
  prefix: '/foo',
  fooOption1: 'value',
  fooOption2: 'value'
})

options 参数还可以是一个在插件注册时确定的 函数，这个函数的第一位参数是 Fastify 实例：

const fp = require('fastify-plugin')

fastify.register(fp((fastify, opts, done) => {
  fastify.decorate('foo_bar', { hello: 'world' })

  done()
}))

// fastify-foo 的 options 参数会是 { hello: 'world' }
fastify.register(require('fastify-foo'), parent => parent.foo_bar)

传给函数的 Fastify 实例是插件声明时外部 Fastify 实例的最新状态，允许你访问注册顺序在前的插件通过 decorate 注入的变量。这在需要依赖前置插件对于 Fastify 实例的改动时派得上用场，比如，使用已存在的数据库连接来包装你的插件。

请记住，传给函数的 Fastify 实例和传给插件的实例是一样的，不是外部 Fastify 实例的引用，而是拷贝。任何对函数的实例参数的操作结果，都会和在插件函数中操作的结果一致。也就是说，如果调用了 decorate，被注入的变量在插件函数中也是可用的，除非你使用 fastify-plugin 包装了这个插件。

路由前缀选项

如果你传入以 prefix为 key , string 为值的选项, Fastify 会自动为这个插件下所有的路由添加这个前缀, 更多信息可以查询 这里.
注意如果使用了 fastify-plugin 这个选项不会起作用。

错误处理

错误处理是由 avvio 解决的。
一个通用的原则, 我们建议在下一个 after 或 ready 代码块中处理错误, 否则错误将出现在 listen 回调里。

fastify.register(require('my-plugin'))

// `after` 将在上一个 `register` 结束后执行
fastify.after(err => console.log(err))

// `ready` 将在所有 `register` 结束后执行
fastify.ready(err => console.log(err))

// `listen` 是一个特殊的 `ready`,
// 因此它的执行时机与 `ready` 一致
fastify.listen(3000, (err, address) => {
  if (err) console.log(err)
})

async/await

after、ready 与 listen 支持 async/await，同时 fastify 也是一个 Thenable 对象。

await fastify.register(require('my-plugin'))

await fastify.after()

await fastify.ready()

await fastify.listen(3000)

ESM 的支持

自 Node.js v13.3.0 开始， ESM 也被支持了！

// main.mjs
import Fastify from 'fastify'
const fastify = Fastify()

fastify.register(import('./plugin.mjs'))

fastify.listen(3000, console.log)

// plugin.mjs
async function plugin (fastify, opts) {
  fastify.get('/', async (req, reply) => {
    return { hello: 'world' }
  })
}

export default plugin

创建插件

创建插件非常简单, 你只需要创建一个方法, 这个方法接收三个参数: fastify 实例、options 选项和 done 回调。
例子:

module.exports = function (fastify, opts, done) {
  fastify.decorate('utility', () => {})

  fastify.get('/', handler)

  done()
}

你也可以在一个 register 内部添加其他 register:

module.exports = function (fastify, opts, done) {
  fastify.decorate('utility', () => {})

  fastify.get('/', handler)

  fastify.register(require('./other-plugin'))

  done()
}

有时候, 你需要知道这个服务器何时即将关闭, 例如在你必须关闭数据库连接的时候。 要知道什么时候发生这种情况, 你可以用 'onClose' 钩子。

别忘了 register 会创建一个新的 Fastify 作用域, 如果你不需要, 阅读下面的章节。

处理作用域

如果你使用 register 仅仅是为了通过decorate扩展服务器的功能, 你需要告诉 Fastify 不要创建新的上下文, 不然你的改动不会影响其他作用域中的用户。

你有两种方式告诉 Fastify 避免创建新的上下文:

我们建议使用 fastify-plugin 模块, 因为它是专门用来为你解决这个问题, 并且你可以传一个能够支持的 Fastify 版本范围的参数。

const fp = require('fastify-plugin')

module.exports = fp(function (fastify, opts, done) {
  fastify.decorate('utility', () => {})
  done()
}, '0.x')

参考 fastify-plugin 文档了解更多这个模块。

如果你不用 fastify-plugin 模块, 可以使用 'skip-override' 隐藏属性, 但我们不推荐这么做。 如果将来 Fastify API 改变了, 你需要去更新你的模块, 如果使用 fastify-plugin, 你可以对向后兼容放心。

function yourPlugin (fastify, opts, done) {
  fastify.decorate('utility', () => {})
  done()
}
yourPlugin[Symbol.for('skip-override')] = true
module.exports = yourPlugin