Nuxt 3 已于 31 July 2026 结束生命周期
此版本将不再接收错误修复或安全补丁。 升级到 Nuxt 4 或获取 HeroDevs 提供的延长支持

useRouter

源码
useRouter 组合函数返回路由实例。

Maschinelle Übersetzung ·0 % geprüft

pages/index.vue
<script setup lang="ts">
const router = useRouter()
</script>

如果你仅仅需要在模板中使用路由实例，可以使用 $router：

pages/index.vue
<template>
  <button @click="$router.back()">返回</button>
</template>

如果你有 pages/ 目录，useRouter 的行为与 vue-router 提供的完全相同。

阅读 vue-router 关于 Router 接口的文档。

基本操作

  • addRoute()：向路由实例添加新路由。可以提供 parentName 将新的路由作为已有路由的子路由添加。
  • removeRoute()：通过名称移除已有路由。
  • getRoutes()：获取所有路由记录的完整列表。
  • hasRoute()：检查是否存在指定名称的路由。
  • resolve()：返回路由位置的规范化版本。同时包含一个包含任何现有基础路径的 href 属性。
示例
const router = useRouter()

router.addRoute({ name: 'home', path: '/home', component: Home })
router.removeRoute('home')
router.getRoutes()
router.hasRoute('home')
router.resolve({ name: 'home' })
router.addRoute() 会将路由详情添加到路由数组中，在构建 Nuxt 插件时很有用；而 router.push() 会立即触发新的导航，在页面、Vue 组件和组合函数中很有用。

基于 History API

  • back()：如果可能，返回历史记录中的上一页，效果与 router.go(-1) 相同。
  • forward()：如果可能，前进到历史记录中的下一页，效果与 router.go(1) 相同。
  • go()：在历史记录中前进或后退，不受 router.back() 和 router.forward() 强制执行的层级限制。
  • push()：通过在历史记录栈中推入一条记录，以编程方式导航到新的 URL。建议改用 navigateTo。
  • replace()：通过替换路由历史记录栈中的当前记录，以编程方式导航到新的 URL。建议改用 navigateTo。
示例
const router = useRouter()

router.back()
router.forward()
router.go(3)
router.push({ path: '/home' })
router.replace({ hash: '#bio' })
了解更多关于浏览器的 History API。

导航守卫

useRouter 组合函数提供了 afterEach、beforeEach 和 beforeResolve 辅助方法，作为导航守卫。

然而，Nuxt 提供了路由中间件的概念，它简化了导航守卫的实现并带来了更好的开发者体验。

Weitere Informationen findest du unter Docs > Directory Structure > Middleware.

Promise 和错误处理

  • isReady()：返回一个 Promise，当路由完成初始导航时解析。
  • onError：添加错误处理器，在导航过程中发生未捕获错误时调用。
Weitere Informationen findest du unter Vue Router 文档.

通用路由实例

如果你没有 pages/ 文件夹，那么 useRouter 将返回一个具有类似辅助方法的通用路由实例，但请注意，并非所有功能都受支持，或者其行为可能与 vue-router 不完全相同。