vue options

通常，use hook 只能在 vue 的 setup 中使用，但通过@alova/vue-options提供的辅助函数，你也可以在 vue 的 options 中使用 alova 的 use hook，完美兼容 alova 的几乎所有功能，你可以在 options 下使用alova/client的所有客户端请求策略。

vue2 和 vue3 中均可使用。

安装

npm

npm install alova @alova/vue-options --save

yarn

yarn add alova @alova/vue-options

pnpm

pnpm install alova @alova/vue-options

版本要求

alova 版本 >= 3.0.0

vue 版本 >= 2.17.0

用法

映射 hook 状态和函数到 vue 实例上

先使用vueOptionHook创建 alova 实例。

import { createAlova, Method } from 'alova';
import adapterFetch from 'alova/fetch';
import { VueOptionsHook } from '@alova/vue-options';

// api.js
const alovaInst = createAlova({
  baseURL: 'http://example.com',
  statesHook: VueOptionsHook,
  requestAdapter: adapterFetch(),
  responded: response => response.json()
});

/** @type {() => Method<unknown, unknown, { content: string, time: string }[]>} */
export const getData = () => alovaInst.Get('/todolist');

再使用mapAlovaHook将 use hook 的返回值集合映射到组件实例上，以下是访问响应式状态和操作函数的方法：

1. 可以通过集合的 key 来访问loading/data/error等响应式状态，例如this.key.loading、this.key.data。
2. 可以通过集合的 key 加函数名称来访问操作函数，并使用$拼接，例如this.key$send、this.key$onSuccess。

以下是一个完整的例子。

<template>
  <div>
    <span role="loading">{{ todoRequest.loading ? 'loading' : 'loaded' }}</span>
    <span role="error">{{ todoRequest.error ? todoRequest.error.message : '' }}</span>
    <div role="data">{{ JSON.stringify(todoRequest.data) }}</div>
    <button
      @click="todoRequest$send"
      role="btnSend">
      send
    </button>
  </div>
</template>

<script>
  import { useRequest } from 'alova/client';
  import { mapAlovaHook } from '@alova/vue-options';
  import { getData } from './api';

  export default {
    // mapAlovaHook将返回mixins数组，use hook的用法与之前一致
    mixins: mapAlovaHook(function (vm) {
      // 可以通过this或vm来访问组件实例
      // 使用this时，此回调函数不能为箭头函数
      console.log(this, vm);
      return {
        todoRequest: useRequest(getData)
      };
    }),
    created() {
      this.todoRequest.loading;
      this.todoRequest$send();
      this.todoRequest$onSuccess(event => {
        event.data.match;
        event.args.copyWithin;
      });
      this.todoRequest$onSuccess(event => {
        console.log('success', event);
      });
      this.todoRequest$onError(event => {
        console.log('error', event);
      });
    },
    mounted() {
      this.todoRequest$onComplete(event => {
        console.log('complete', event);
      });
    }
  };
</script>

计算属性

如果你需要定义依赖 hook 相关的请求状态的计算属性，只需要和平时一样编写即可。

export default {
  computed: {
    todoRequestLoading() {
      return this.todoRequest.loading;
    },
    todoRequestData() {
      return this.todoRequest.data;
    }
  }
};

监听 hook 状态变化

监听状态也与 vue 的用法一致。

export default {
  watch: {
    'todoRequest.loading'(newVal, oldVal) {
      // ...
    }
  }
};

函数说明

mapAlovaHook

mapAlovaHook是用于将 alova 的 use hook 返回的状态和函数集合，通过 mixins 映射到 vue 组件实例上。它接收一个回调函数并返回 use hook 的返回值集合。

值得注意的是，回调函数将会在created阶段执行，你可以通过以下方式访问 vue 组件实例。

// 1. 通过 this 访问组件实例，注意回调函数不能为箭头函数
mapAlovaHook(function () {
  console.log(this);
  return {
    todoRequest: useRequest(getData)
  };
});

// =======================
// 2. 通过函数参数访问组件实例，此时可以用箭头函数
mapAlovaHook(vm => {
  console.log(vm);
  return {
    todoRequest: useRequest(getData)
  };
});

类型支持

自动推断

@alova/vue-options提供了完整的 ts 类型支持，无论是否使用 typescript，映射的值类型都会被自动推断，例如：

this.todoRequest.loading; // boolean
this.todoRequest.error; // Error | undefined
this.todoRequest.data; // any
this.todoRequest$send; // (...args: any[]) => Promise<any>
this.todoRequest$onSuccess; // (handler: SuccessHandler) => void
this.todoRequest$onError; // (handler: ErrorHandler) => void
this.todoRequest$onComplete; // (handler: CompleteHandler) => void
// ...

为响应数据添加类型

除了this.todoRequest.data外，其他值都有了正确的类型，那么如何给data也设置类型呢？其实与 alova 在其他环境中使用是相同。

javascript

在 javascript 中可以使用类型注释添加类型，Method 的前两个泛型参数为unknown，第三个泛型参数就是响应数据的类型

import { Method } from 'alova';

/** @type {() => Method<unknown, unknown, { content: string, time: string }[]>} */
export const getData = () => alovaInst.Get('/todolist');

typescript

在 typescript 中添加响应数据类型，请阅读 alova 文档 typescript 章节

限制

1. 暂不支持管理额外的状态。