预取特性 PreFetch

预取（PreFetch）是 Quasar CLI 提供的一个特性，它可以让被 vue router 选中的组件（在/src/router/routes.js中定义的组件）拥有以下额外能力：

• 预取数据 pre-fetch data
• 验证路由 validate the route
• 当不满足验证条件时进行路由重定向（例如用户未登录时）
• 帮助初始化 Store 数据

上面这些工作都在组件渲染之前完成。

这个特性在所有的开发模式中都可用 (SPA, PWA, SSR, Cordova, Electron)，但是它对 SSR 开发模式尤其有用。

安装

// quasar.config.js
return {
  preFetch: true
}

为什么 PreFetch 对 SSR 很有用

这个特性对 SSR 开发模式尤其有用（但并不是只能用于 SSR 模式中），因为开发 SSR 时，我们相当于渲染了我们应用的“快照”，所以，当应用需要一些异步的数据时，为了使得最终渲染的页面中带有这些数据，我们需要在应用开始渲染之前将这些数据预处理好。

另一个问题是，在客户端，同样的数据需要在我们挂载客户端应用程序之前可用——否则客户端应用程序将使用不同的数据状态渲染，这会导致水合作用（hydration）将失败。

为了解决这个问题，获取的数据需要存储在视图组件之外、一个专用的数据存储 store（Pinia 或 Vuex）中。在服务器上，我们可以在渲染页面之前预取数据并将数据填充到 store 中。在客户端的 store 会在挂载 app 之前同步服务端的数据。

PreFetch 钩子何时被激活

预取preFetch钩子（将在下一节中介绍）由访问的路由确定，该路由还确定渲染哪些组件。事实上，给定路由所需的数据也是在该路由上渲染的组件所需的。因此，只在路由组件内部放置preFetch钩子的逻辑是很自然的（也是必需的）。 这也包括/src/App.vue，在这种情况下，在应用程序启动时只运行一次。

让我们通过一个例子来理解钩子何时被调用。假设我们有这些路由，并为这些组件都编写了preFetch钩子：

// routes
[
  {
    path: '/',
    component: LandingPage
  },
  {
    path: '/shop',
    component: ShopLayout,
    children: [
      {
        path: 'all',
        component: ShopAll
      },
      {
        path: 'new',
        component: ShopNew
      },
      {
        path: 'product/:name',
        component: ShopProduct,
        children: [{
          path: 'overview',
          component: ShopProductOverview
        }]
      }
    ]
  }
]

现在，让我们看看当用户按照下面指定的顺序依次访问这些路由时，钩子是如何被调用的。

用法

这个钩子在路由组件中定义为一个叫做preFetch的静态函数。注意，因为这个函数将在组件实例化之前调用，所以它没有访问权限this。

下面的例子是当使用 Vuex 时：

<!-- 被路由使用的一些.vue 组件 -->
<template>
  <div>{{ item.title }}</div>
</template>

<script>
import { useStore } from 'vuex'

export default {
  // 我们的钩子在这里
  preFetch ({ store, currentRoute, previousRoute, redirect, ssrContext, urlPath, publicPath }) {
    // 在这里可以获取数据，验证路由，重定向路由等等...

    // ssrContext 只有在开发 SSR 模式时才能访问

    // 这里无法访问 this

    // 如果您执行了异步的任务，请返回一个 Promise
    // 示例:
    return store.dispatch('fetchItem', currentRoute.params.id)
  },

  setup () {
    const $store = useStore()

    // 展示 store state 中的 items
    const item = computed(() => $store.state.items[this.$route.params.id])

    return { item }
  }
}
</script>

如果您在使用<script setup>（并且使用 vue3.3+）:

<script setup>
/**
 * 仅支持 vue3.3+，低于 vue3.3+ 的版本可以使用 vue-macros 插件：https://vue-macros.sxzz.moe/macros/define-options.html
 * 这是一个宏定义，选项将会被提升到模块作用域中，无法访问 <script setup> 中不是字面常数的局部变量。
 */
defineOptions({
  preFetch () {
    console.log('running preFetch')
  }
})
</script>

// 执行异步任务相关的示例
// ...

actions: {
  fetchItem ({ commit }, id) {
    return axiosInstance.get(url, id).then(({ data }) => {
      commit('mutation', data)
    })
  }
}

// ...

重定向示例

下面是在某些情况下重定向页面的示例，比如当未登录的用户试图访问只有经过身份验证的用户才能看到的页面时。

// 这里假设我们已经编写了身份验证逻辑
// 在 Vuex store 中
preFetch ({ store, redirect }) {
  if (!store.state.authenticated) {
    redirect({ path: '/login' })
  }
}

如果调用了 redirect(false)（仅在客户端支持！），则将中止当前的路由跳转。请注意，如果在src/app.vue中这样的使用，vue 将停止应用程序启动，这是不可取的。

redirect()函数可以接受一个 Vue Router 的 location 对象作为参数。

使用预取 preFetch 来初始化 Pinia 或 Vuex

当 app 启动时preFetch钩子只会运行一次，所以您可以借助这个机会来初始化 Pinia 或者 Vuex Store。

// -- Pinia on Non SSR --

// App.vue - handling Pinia stores
// example with a store named "myStore"
// placed in /src/stores/myStore.js|ts

import { useMyStore } from 'stores/myStore'

export default {
  // ...
  preFetch () {
    const myStore = useMyStore()
    // do something with myStore
  }
}

// -- Pinia on SSR --

// App.vue - handling Pinia stores
// example with a store named "myStore"
// placed in /src/stores/myStore.js|ts

import { useMyStore } from 'stores/myStore'

export default {
  // ...
  preFetch ({ store }) {
    const myStore = useMyStore(store)
    // do something with myStore
  }
}

// App.vue - handling Vuex store

export default {
  // ...
  preFetch ({ store }) {
    // initialize something in store here
  }
}

Vuex Store 代码拆分

在大型应用程序中，Vuex Store 可能会被拆分为多个模块。当然，也可以将这些模块编码为相应的路由组件块。假设我们有以下 store 模块：

// src/store/foo.js
// we've merged everything into one file here;
// an initialized Quasar project splits every component of a Vuex module
// into separate files, but for the sake of the example
// here in the docs, we show this module as a single file

export default {
  namespaced: true,
  // IMPORTANT: state must be a function so the module can be
  // instantiated multiple times
  state: () => ({
    count: 0
  }),
  actions: {
    inc: ({ commit }) => commit('inc')
  },
  mutations: {
    inc: state => state.count++
  }
}

Now, we can use store.registerModule() to lazy-register this module in a route component’s preFetch() hook:

// inside a route component
<template>
  <div>{{ fooCount }}</div>
</template>

<script>
import { useStore } from 'vuex'
import { onMounted, onUnmounted } from 'vue'

// import the module here instead of in `src/store/index.js`
import fooStoreModule from 'store/foo'

export default {
  preFetch ({ store }) {
    store.registerModule('foo', fooStoreModule)
    return store.dispatch('foo/inc')
  },

  setup () {
    const $store = useStore()

    onMounted(() => {
      // Preserve the previous state if it was injected from the server
      $store.registerModule('foo', fooStoreModule, { preserveState: true })
    })

    onUnmounted(() => {
      // IMPORTANT: avoid duplicate module registration on the client
      // when the route is visited multiple times.
      $store.unregisterModule('foo')
    })

    const fooCount = computed(() => {
      return $store.state.foo.count
    })

    return {
      fooCount
    }
  }
}
</script>

还要注意的是，由于该模块现在是路由组件的一个依赖项，它将被 Vite 移到路由组件的异步块中。

Vuex 搭配 Typescript

您可以使用preFetch的类型工具来标注store参数的类型（否则为 any）：

import { preFetch } from 'quasar/wrappers'
import { Store } from 'vuex'

interface StateInterface {
  // ...
}

export default {
  preFetch: preFetch<StateInterface>(({ store }) => {
    // Do something with your newly-typed store parameter
  }),
}

加载状态

一个好的用户体验包括提示用户有一些运行在后台的工作在页面准备就绪之前需要等待。针对于此，Quasar 提供了两种开箱即用的选项。

LoadingBar

当您为您的 app 添加了 Quasar 的LoadingBar插件时，Quasar 默认会自动在 preFetch 钩子运行时调用 loadingBar。

Loading

也可以使用 Quasar 的Loading插件。 示例：

// a route .vue component
import { Loading } from 'quasar'

export default {
  // ...
  preFetch ({ /* ... */ }) {
    Loading.show()

    return new Promise(resolve => {
      // do something async here
      // then call "resolve()"
    }).then(() => {
      Loading.hide()
    })
  }
}