Skip to content
On this page

组合式 API

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

setup 中访问路由和当前路由

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

js
import {
  useRouter, 
  useRoute
} from '@/uni-simple-router'

export default {
  setup() {
    const router = useRouter()
    const route = useRoute()

    function pushWithQuery(query) {
      router.push({
        name: 'search',
        query: {
          ...route.value.query,
          ...query,
        },
      })
    }
  },
}

route 对象是一个响应式对象,所以它的任何属性都可以被监听,但你应该避免监听整个 route 对象。在大多数情况下,你应该直接监听你期望改变的参数。

ts
import { useRoute } from '@/uni-simple-router'
import { ref, watch } from 'vue'

export default {
  setup() {
    const route = useRoute()
    const userData = ref()

    // 当参数更改时获取用户信息
    watch(
      () => route.value.params.id,
      async newId => {
        userData.value = await fetchUser(newId)
      }
    )
  },
}

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

导航守卫

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

js
import { 
  onBeforeRouteLeave, 
  onBeforeRouteUpdate
} from '@/uni-simple-router'
import { 
  ref
} from 'vue'

export default {
  setup() {
    // 与 beforeRouteLeave 相同,无法访问 `this`
    onBeforeRouteLeave((to, from) => {
      const answer = window.confirm(
        'Do you really want to leave? you have unsaved changes!'
      )
      // 取消导航并停留在同一页面上
      if (!answer) return false
    })

    const userData = ref()

    // 与 beforeRouteUpdate 相同,无法访问 `this`
    onBeforeRouteUpdate(async (to, from) => {
      //仅当 id 更改时才获取用户,例如仅 query 值已更改
      if (to.params.id !== from.params.id) {
        userData.value = await fetchUser(to.params.id)
      }
    })
  },
}
组合式 API has loaded