路由
Nuxt 文件系统路由为 pages/ 目录中的每个文件创建对应的路由。
Nuxt 的一个核心特性是文件系统路由器。pages/
目录中的每一个 Vue 文件都会创建一个对应的 URL(或路由),用于显示该文件的内容。通过对每个页面使用动态导入,Nuxt 利用代码分割来只传输请求路由所需的最少 JavaScript 代码。
页面
Nuxt 的路由基于 vue-router,并根据 pages/
目录 中每个组件的文件名生成路由。
此文件系统路由使用命名约定来创建动态和嵌套路由:
-| pages/
---| about.vue
---| index.vue
---| posts/
-----| [id].vue
{
"routes": [
{
"path": "/about",
"component": "pages/about.vue"
},
{
"path": "/",
"component": "pages/index.vue"
},
{
"path": "/posts/:id",
"component": "pages/posts/[id].vue"
}
]
}
导航
<NuxtLink>
组件用于在页面之间链接。它会渲染一个带有指向页面路由的 href
属性的 <a>
标签。应用程序完成水化后,页面切换通过 JavaScript 更新浏览器 URL 来执行。这避免了整页刷新,并支持动画过渡效果。
当 <NuxtLink>
在客户端视口内出现时,Nuxt 会自动预取链接页面的组件及其载荷(生成的页面),从而实现更快的导航。
pages/app.vue
<template>
<header>
<nav>
<ul>
<li><NuxtLink to="/about">关于</NuxtLink></li>
<li><NuxtLink to="/posts/1">文章 1</NuxtLink></li>
<li><NuxtLink to="/posts/2">文章 2</NuxtLink></li>
</ul>
</nav>
</header>
</template>
路由参数
useRoute()
组合函数可以在 <script setup>
块或 Vue 组件的 setup()
方法中使用,以访问当前路由详情。
pages/posts/[id].vue
<script setup lang="ts">
const route = useRoute()
// 访问 /posts/1 时,route.params.id 的值为 1
console.log(route.params.id)
</script>
路由中间件
Nuxt 提供了一个可自定义的路由中间件框架,可在应用中随处使用,非常适合提取需要在导航到特定路由前执行的代码。
路由中间件运行在 Nuxt 应用的 Vue 部分。虽然名字相似,但它们与运行于应用 Nitro 服务器部分的服务器中间件完全不同。
路由中间件分为三类:
- 匿名(或内联)路由中间件,直接定义在使用它们的页面中。
- 命名路由中间件,放在
middleware/
目录中,当在页面使用时会通过异步导入自动加载。(注意:路由中间件名称会标准化为 kebab-case,例如someMiddleware
会变成some-middleware
。) - 全局路由中间件,放在
middleware/
目录中,文件名带有.global
后缀,会在每次路由变化时自动运行。
下面是 auth
中间件保护 /dashboard
页面示例:
export default defineNuxtRouteMiddleware((to, from) => {
// isAuthenticated() 是一个示例方法,用于验证用户是否已认证
if (isAuthenticated() === false) {
return navigateTo('/login')
}
})
<script setup lang="ts">
definePageMeta({
middleware: 'auth'
})
</script>
<template>
<h1>欢迎来到您的仪表盘</h1>
</template>
路由校验
Nuxt 通过每个页面中 definePageMeta()
的 validate
属性提供路由校验功能。
validate
属性接受当前路由作为参数。你可以返回布尔值以判断该路由是否为此页面的有效路由。如果返回 false
,将触发 404 错误。你也可以直接返回包含 statusCode
/statusMessage
的对象来自定义错误响应。
如果你的需求更复杂,可以改为使用匿名路由中间件。
pages/posts/[id].vue
<script setup lang="ts">
definePageMeta({
validate: async (route) => {
// 校验 id 是否由数字组成
return typeof route.params.id === 'string' && /^\d+$/.test(route.params.id)
}
})
</script>