配置
nuxt.config
Nuxt 应用的起始点仍然是你的 nuxt.config
文件。
迁移
- 你应该迁移到新的
defineNuxtConfig
函数,它提供了一个类型化的配置架构。export default { // ... }
- 如果你正在使用
router.extendRoutes
,你可以迁移到新的pages:extend
钩子export default { router: { extendRoutes (routes) { // } } }
- 如果你正在使用
router.routeNameSplitter
,你可以通过更新新的pages:extend
钩子中的路由名称生成逻辑来实现相同的结果export default { router: { routeNameSplitter: '/' } }
ESM 语法
Nuxt 3 是一个 ESM 原生框架。虽然 unjs/jiti
在加载 nuxt.config
文件时提供半兼容性,但应避免在此文件中使用任何 require
和 module.exports
。
- 将
module.exports
更改为export default
- 将
const lib = require('lib')
更改为import lib from 'lib'
异步配置
为了使 Nuxt 加载行为更具可预测性,异步配置语法已被弃用。请考虑使用 Nuxt 钩子进行异步操作。
Dotenv
Nuxt 内置了加载 .env
文件的支持。避免直接从 nuxt.config
中导入它。
模块
Nuxt 和 Nuxt 模块现在仅在构建时使用。
迁移
- 将所有
buildModules
移动到modules
。 - 检查模块的 Nuxt 3 兼容性。
- 如果你有任何指向目录的本地模块,你应该更新它以指向入口文件
export default defineNuxtConfig({
modules: [
- '~/modules/my-module'
+ '~/modules/my-module/index'
]
})
目录更改
static/
(用于存储静态资源)已重命名为 public/
。你可以将 static
目录重命名为 public
,或者通过在 nuxt.config
中设置 dir.public
来保留名称。
TypeScript
如果你使用 Nuxt 的 TypeScript 集成,迁移应用程序会更容易。这并不意味着你需要用 TypeScript 编写你的应用程序,只是 Nuxt 会为你的编辑器提供自动类型提示。
你可以在文档中阅读更多关于 Nuxt 的 TypeScript 支持的信息。
vue-tsc
和 nuxi typecheck
命令来类型检查你的应用程序。迁移
- 创建一个包含以下内容的
tsconfig.json
{ "extends": "./.nuxt/tsconfig.json" }
- 运行
npx nuxi prepare
来生成.nuxt/tsconfig.json
。 - 按照文档中的说明安装 Volar。
Vue 更改
在推荐的 Vue 最佳实践方面有很多更改,并且 Vue 2 和 3 之间有很多重大更改。
建议阅读Vue 3 迁移指南,特别是重大更改列表。
目前无法在 Nuxt 3 中使用Vue 3 迁移构建。
Vuex
Nuxt 不再提供 Vuex 集成。相反,官方 Vue 建议使用 pinia
,它通过Nuxt 模块内置了 Nuxt 支持。在此处了解有关 pinia 的更多信息。
使用 pinia 提供全局状态管理的一个简单方法是
安装@pinia/nuxt
模块
yarn add pinia @pinia/nuxt
在你的 nuxt 配置中启用该模块
import { defineNuxtConfig } from 'nuxt/config';
export default defineNuxtConfig({
modules: ['@pinia/nuxt']
})
在你的应用程序的根目录创建一个 store
文件夹
import { defineStore } from 'pinia'
export const useMainStore = defineStore('main', {
state: () => ({
counter: 0,
}),
actions: {
increment() {
// `this` is the store instance
this.counter++
},
},
})
创建一个插件文件来全局化你的 store
import { useMainStore } from '~/store'
export default defineNuxtPlugin(({ $pinia }) => {
return {
provide: {
store: useMainStore($pinia)
}
}
})
如果您想继续使用 Vuex,您可以按照这些步骤手动迁移到 Vuex 4。
完成后,您需要在您的 Nuxt 应用程序中添加以下插件
import store from '~/store'
export default defineNuxtPlugin(nuxtApp => {
nuxtApp.vueApp.use(store);
})
对于较大的应用程序,此迁移可能需要大量工作。如果更新 Vuex 仍然遇到障碍,您可能需要使用社区模块:nuxt3-vuex-module,它应该可以开箱即用。