Vue Router 和 组合式 API

引入 setup 和 Vue 的组合式 API,开辟了新的可能性,但要想充分发挥 Vue Router 的潜力,我们需要使用一些新的函数来代替访问 this 和组件内导航守卫。

setup 中访问路由和当前路由

因为我们在 setup 里面没有访问 this,所以我们不能再直接访问 this.$routerthis.$route。作为替代,我们使用 useRouter 函数:

  1. import { useRouter, useRoute } from 'vue-router'
  2. export default {
  3. setup() {
  4. const router = useRouter()
  5. const route = useRoute()
  6. function pushWithQuery(query) {
  7. router.push({
  8. name: 'search',
  9. query: {
  10. ...route.query,
  11. },
  12. })
  13. }
  14. },
  15. }

route 对象是一个响应式对象,所以它的任何属性都可以被监听,但你应该避免监听整个 route 对象:

  1. import { useRoute } from 'vue-router'
  2. export default {
  3. setup() {
  4. const route = useRoute()
  5. const userData = ref()
  6. // 当参数更改时获取用户信息
  7. watch(
  8. () => route.params,
  9. async newParams => {
  10. userData.value = await fetchUser(newParams.id)
  11. }
  12. )
  13. },
  14. }

请注意,在模板中我们仍然可以访问 $router$route,所以不需要在 setup 中返回 routerroute

导航守卫

虽然你仍然可以通过 setup 函数来使用组件内的导航守卫,但 Vue Router 将更新和离开守卫作为 组合式 API 函数公开:

  1. import { onBeforeRouteLeave, onBeforeRouteUpdate } from 'vue-router'
  2. export default {
  3. setup() {
  4. // 与 beforeRouteLeave 相同,无法访问 `this`
  5. onBeforeRouteLeave((to, from) => {
  6. const answer = window.confirm(
  7. 'Do you really want to leave? you have unsaved changes!'
  8. )
  9. // 取消导航并停留在同一页面上
  10. if (!answer) return false
  11. })
  12. const userData = ref()
  13. // 与 beforeRouteLeave 相同,无法访问 `this`
  14. onBeforeRouteUpdate(async (to, from) => {
  15. //仅当 id 更改时才获取用户,例如仅 query 或 hash 值已更改
  16. if (to.params.id !== from.params.id) {
  17. userData.value = await fetchUser(to.params.id)
  18. }
  19. })
  20. },
  21. }

组合式 API 守卫也可以用在任何由 <router-view> 渲染的组件中,它们不必像组件内守卫那样直接用在路由组件上。

useLink

Vue Router 将 RouterLink 的内部行为作为一个组合式 API 函数公开。它提供了与 v-slot API 相同的访问属性:

  1. import { RouterLink, useLink } from 'vue-router'
  2. export default {
  3. name: 'AppLink',
  4. props: {
  5. // 如果使用 TypeScript,请添加 @ts-ignore
  6. ...RouterLink.props,
  7. inactiveClass: String,
  8. },
  9. setup(props) {
  10. const { route, href, isActive, isExactActive, navigate } = useLink(props)
  11. const isExternalLink = computed(
  12. () => typeof props.to === 'string' && props.to.startsWith('http')
  13. )
  14. return { isExternalLink, href, navigate, isActive }
  15. },
  16. }