插件和中间件
了解如何将 Nuxt 2 的插件和中间件迁移到 Nuxt 3。
插件
插件现在有不同的格式，并且只接受一个参数 (nuxtApp)。
export default (ctx, inject) => {
inject('injected', () => 'my injected function')
}
export default defineNuxtPlugin((nuxtApp) => {
// now available on `nuxtApp.$injected`
nuxtApp.provide('injected', () => 'my injected function')
// You can alternatively use this format, which comes with automatic type support
return {
provide: {
injected: () => 'my injected function',
},
}
})
迁移
- 迁移您的插件以使用
defineNuxtPlugin辅助函数。 - 从您的
nuxt.config插件数组中删除任何位于app/plugins/文件夹中的条目。此目录中顶层的所有文件（以及任何子目录中的 index 文件）将自动注册。您可以在文件名中指示模式，而不是将mode设置为client或server。例如，~/plugins/my-plugin.client.ts将仅在客户端加载。
路由中间件
路由中间件有不同的格式。
export default function ({ store, redirect }) {
// If the user is not authenticated
if (!store.state.authenticated) {
return redirect('/login')
}
}
export default defineNuxtRouteMiddleware((to, from) => {
const auth = useState('auth')
if (!auth.value.authenticated) {
return navigateTo('/login')
}
})
与 Nuxt 2 非常相似，放置在 ~/middleware 文件夹中的路由中间件会自动注册。然后您可以在组件中按名称指定它。但是，这是通过 definePageMeta 而不是作为组件选项完成的。
navigateTo 是众多路由辅助函数之一。
迁移
- 迁移您的路由中间件以使用
defineNuxtRouteMiddleware辅助函数。 - 任何全局中间件（例如在您的
nuxt.config中）都可以放置在您的~/middleware文件夹中，并带有.global扩展名，例如~/middleware/auth.global.ts。