当前位置：首页 > news >正文

Vue Router 编程式导航全攻略：深入掌握 push, replace, go, back, forward,beforeEach 方法

news 来源：原创 2024/9/19 22:13:12

Vue Router 编程式导航全攻略：深入掌握 push, replace, go, back, forward,beforeEach 方法

在Vue Router中，编程式导航是一种通过JavaScript代码来实现路由跳转的方法。与声明式导航（使用<router-link>标签）相比，编程式导航提供了更多的灵活性和控制能力。以下是Vue Router中几种常用的编程式导航方法的详细讲解：

1.`Router.push()`方法

router.push(location, onComplete?, onAbort?) 是 Vue Router 中用于编程式导航的方法之一。它允许你通过编写 JavaScript 代码来实现页面跳转，而不是使用 <router-link> 标签。这个方法非常灵活，因为它可以在任何时候，基于任何条件触发路由的变更。

参数详解

location：
- 必需。
- 类型：可以是字符串路径（如 '/home'），或者是一个对象，描述了目的地的位置（如 { path: '/home' } 或 { name: 'home' }）。
- 描述：指定要导航到的路由地址。如果路由是命名路由，可以使用路由的名称和参数来导航。
onComplete（可选）：
- 类型：函数。
- 描述：导航成功完成时调用的回调函数。导航成功完成是指所有的异步钩子（如路由守卫）都成功解析，并且没有导航被中断。
onAbort（可选）：
- 类型：函数。
- 描述：导航中断时调用的回调函数。导航中断可能是因为发生了错误，或者在导航过程中触发了另一个导航。

返回值

router.push 返回一个 Promise 对象。这意味着你可以使用 .then()、.catch() 方法来处理导航成功或失败的情况，或者使用 async/await 语法。

使用示例

// 通过路径跳转
router.push('/home').then(() => {// 导航成功
}).catch(err => {// 导航失败
});// 通过命名路由跳转，并传递参数
router.push({ name: 'user', params: { userId: 123 }}).then(() => {// 导航成功
}).catch(err => {// 导航失败
});// 通过编程式导航传递查询参数
router.push({ path: '/search', query: { keyword: 'vue' }}).then(() => {// 导航成功
}).catch(err => {// 导航失败
});// 在组件内部使用
export default {methods: {navigateAway() {this.$router.push('/new-path').then(() => {// 导航成功}).catch(err => {// 导航失败});}}
};

注意事项

响应式数据：如果你在 onComplete 或 onAbort 回调中使用了响应式数据，确保在 Vue 的响应式系统内修改这些数据，以触发视图更新。
导航守卫：router.push 会触发路由守卫（如 beforeEach、beforeEnter 等）。如果守卫中的异步操作被拒绝（例如，通过 next(false) 调用），则导航会被中断。
错误处理：在 .catch() 块或 onAbort 回调中处理错误，可以捕获导航过程中的异常情况。
Promises：由于 router.push 返回一个 Promise，你可以在连续的导航操作中使用 await，但要注意处理可能的异常。

router.push 是 Vue 应用中实现导航的常用方法，它为开发者提供了在不同视图间导航的编程方式，使得导航逻辑可以根据应用的业务需求灵活控制。

2.`Router.replace()`方法

router.replace 是 Vue Router 中用于实现编程式导航的方法之一。它与 router.push 类似，但在历史记录中的行为不同。

功能描述

router.replace 不会向浏览器的历史记录中添加新记录，而是替换掉当前的历史记录。这意味着用户在导航后使用浏览器的后退按钮将不会返回到先前的页面。
当需要在应用中触发一个不会留下历史记录的路由变更时，可以使用 router.replace。

语法

router.replace(location, onComplete?, onAbort?);

参数

location：可以是描述目标位置的字符串路径或对象。
onComplete（可选）：导航成功完成后的回调函数。
onAbort（可选）：导航中断时的回调函数。

使用场景

表单提交：在用户提交表单后，可能需要导航到一个确认页面，并且不希望用户能够通过后退按钮返回到表单页面。
错误页面：在发生错误后，可能需要导航到一个错误页面，并且不希望这个错误页面出现在历史记录中。
更新操作：在用户更新了某些信息后，可能需要导航到一个显示更新结果的页面，并且不希望这个页面可以被后退。

示例代码

// 通过路径替换当前路由
router.replace('/new-path');// 通过命名路由替换当前路由，并传递参数
router.replace({ name: 'user', params: { userId: '123' } });// 通过对象替换当前路由，并传递查询参数
router.replace({ path: '/search', query: { keyword: 'vue' } });

注意事项

使用 router.replace 时，如果目标路由与当前路由相同（仅参数不同），则不会触发组件的重新渲染。
router.replace 返回一个 Promise，可以用来监听导航的成功或失败。

与 `router.push` 的区别

router.push 会向历史记录中添加一个新记录，用户可以使用后退按钮返回到之前的页面。
router.replace 则替换掉当前的历史记录，用户无法通过后退按钮返回到被替换的页面。

编程式导航与声明式导航

声明式导航使用 <router-link :to="..."> 实现，它在模板中定义导航链接。
编程式导航使用 router.push 或 router.replace 在 JavaScript 代码中实现导航。

结论

router.replace 是 Vue Router 中一个非常有用的编程式导航方法，它允许开发者在特定情况下控制路由跳转时不留下历史记录。这在某些业务逻辑中非常有用，如表单提交、错误页面展示等场景。通过使用 router.replace，可以提供更加符合用户预期的导航体验。

3.`Router.go()`方法

router.go(n) 是 Vue Router 中用于编程式导航的方法之一，它允许你在浏览器的历史记录中向前或向后跳跃指定的步数。这个方法模拟了 window.history.go(n) 的行为，其中 n 是一个整数，表示要跳跃的历史记录数。

功能描述

router.go(n)：通过传递一个整数 n 来控制历史记录的跳跃。正值表示向前跳跃，负值表示向后跳跃。
如果跳跃的步数超过了历史记录的范围，那么操作将静默失败，不会有任何效果。

语法

router.go(n);

参数

n：一个整数，表示在历史记录中向前或向后跳跃的步数。

使用案例

后退一步：router.go(-1)，相当于调用 router.back()，也等同于浏览器的后退按钮。
前进一步：router.go(1)，相当于调用 router.forward()，也等同于浏览器的前进按钮。
向前跳跃多步：router.go(3)，向前跳跃三步历史记录。
静默失败：如果尝试跳跃的步数超出了历史记录的范围，比如 router.go(100) 或 router.go(-100)，操作将不会执行任何动作。

注意事项

router.go(n) 方法不会触发路由守卫，因为它只是历史记录的简单跳跃，不涉及实际的路由变化。
与 router.push 和 router.replace 不同，router.go(n) 不会创建新的历史记录或替换现有记录。

代码示例

// 向后跳跃一步
router.go(-1);// 向前跳跃两步
router.go(2);// 跳跃到特定的历史记录，如果步数超出范围，则静默失败
router.go(5);

结论

router.go(n) 是一个简单而强大的方法，用于在 Vue 应用中控制用户的浏览历史。它特别适用于需要精细控制路由历史记录的场景，例如，实现自定义的后退和前进按钮，或者在特定操作后调整用户的浏览历史。

4. `router.back()`方法

router.back() 方法是 Vue Router 中用于编程式导航的辅助函数，它提供了一个便捷的方式来执行后退操作，即在浏览器的历史记录中回退到上一个记录。这个方法是 router.go(-1) 的语法糖，也就是说，它相当于调用 router.go 方法并传入 -1 作为参数。

功能描述

router.back()：模拟用户点击浏览器的后退按钮，向后跳跃一步历史记录。

语法

router.back();

参数

无参数。

使用案例

用户操作：在用户执行了某个操作后，如果你想提供一个按钮让用户返回到之前的页面，可以使用 router.back() 来实现这一功能。

注意事项

router.back() 会检查历史记录的深度，如果当前是第一个历史记录（即没有可以后退的历史记录），则不会有任何效果。
这个方法不会触发路由守卫中的 beforeEach 或 beforeRouteLeave，因为它只是简单地回退了一步历史记录，并没有触发新的路由解析过程。

代码示例

// 在 Vue 组件中使用
export default {methods: {goBack() {this.$router.back();}}
};

结论

router.back() 是 Vue Router 中用于后退导航的简便方法。它非常适合在需要提供“返回”功能的交互场景中使用，例如，用户填写完表单后，可能需要返回到表单列表页面。使用 router.back() 可以轻松实现这一功能，同时保持代码的简洁和可读性。

5. `router.forward()`方法

router.forward() 方法是 Vue Router 中用于编程式导航的辅助函数，它提供了一个便捷的方式来执行前进操作，即在浏览器的历史记录中前进到下一个记录。这个方法是 router.go(1) 的语法糖，也就是说，它相当于调用 router.go 方法并传入 1 作为参数。

功能描述

router.forward()：模拟用户点击浏览器的前进按钮，向前跳跃一步历史记录。

语法

router.forward();

参数

无参数。

使用案例

用户操作：在用户执行了某个操作后，如果你想提供一个按钮让用户前进到之前的页面，可以使用 router.forward() 来实现这一功能。

注意事项

router.forward() 会检查历史记录的深度，如果当前是最后一个历史记录（即没有可以前进的历史记录），则不会有任何效果。
这个方法不会触发路由守卫中的 beforeEach 或 beforeRouteEnter，因为它只是简单地前进了一步历史记录，并没有触发新的路由解析过程。

代码示例

// 在 Vue 组件中使用
export default {methods: {goForward() {this.$router.forward();}}
};

结论

router.forward() 是 Vue Router 中用于前进导航的简便方法。它非常适合在需要提供“前进”功能的交互场景中使用，例如，用户在查看某个页面后，可能需要返回到之前浏览的页面。使用 router.forward() 可以轻松实现这一功能，同时保持代码的简洁和可读性。然而，需要注意的是，由于大多数用户不经常使用浏览器的前进按钮，因此在设计用户界面时应谨慎考虑是否真的需要提供前进功能。

6.router.beforeEach()方法

Vue Router 的 router.beforeEach 方法是一种全局前置守卫，它在每次路由跳转前被调用，可以用来执行权限检查、页面跳转前的验证等操作。以下是 router.beforeEach 方法的详细解释：

功能描述

router.beforeEach 允许你注册一个全局前置守卫，它会在路由跳转开始时被触发。这个守卫可以用来检查用户权限、验证用户身份、记录日志、操作浏览器历史等。

语法

router.beforeEach((to, from, next) => {// ...逻辑next(); // 必须调用 next 方法
});

参数

to：即将去往的路由对象。
from：来自哪个路由。
next：是一个函数，用来决定路由操作的结束或是取消。

返回值

调用 next() 继续路由跳转。
调用 next(false) 取消当前的导航。
调用 next('/') 或 next({ path: '/' }) 跳转到一个不同的地址。
抛出一个错误，取消当前的导航并调用 router.onError() 注册的错误处理函数。

使用示例

router.beforeEach((to, from, next) => {if (to.matched.some(record => record.meta.requiresAuth) && !auth.isAuthenticated()) {next({ path: '/login' });} else {next();}
});