跳到主要内容
版本:v2

vue2/3 options

通常,use hook 只能在 vue 的 setup 中使用,但通过@alova/vue-options提供的辅助函数,你也可以在 vue 的 options 中使用 alova 的 use hook,完美兼容 alova 的几乎所有功能。

vue2 和 vue3 中均可使用。

npm build coverage status typescript license

安装

npm install alova @alova/vue-options --save
alova 版本要求

alova 版本 >= 2.13.2

用法

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

先使用vueOptionHook创建 alova 实例。

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

// api.js
const alovaInst = createAlova({
baseURL: 'http://example.com',
statesHook: VueOptionsHook,
requestAdapter: GlobalFetch(),
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.loadingthis.key.data
  2. 可以通过集合的 key 加函数名称来访问操作函数,并使用$拼接,例如this.key$sendthis.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';
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.sendArgs.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 状态变化

由于 vue2 的限制,所有 hook 状态都是挂载在一个名叫alovaHook$的对象上,因此在监听时需要添加alovaHook$前缀。

export default {
watch: {
// ❌无法监听
'todoRequest.loading'(newVal, oldVal) {
// ...
},
// ✅监听正常
'alovaHook$.todoRequest.loading'(newVal, oldVal) {
// ...
}
}
};

但这样稍显麻烦,因此提供了一个mapWatcher辅助函数,不仅可以自动添加前缀、嵌套监听,还可以批量监听。

设置单个监听函数

export default {
watch: mapWatcher({
// 用法1
'todoRequest.loading'(newVal, oldVal) {},

// 用法2
todoRequest: {
loading(newVal, oldVal) {},
data(newVal, oldVal) {}
}
})
};

同时也支持监听器对象。

export default {
watch: mapWatcher({
todoRequest: {
data: {
handler(newVal, oldVal) {},
deep: true
}
}
})
};

批量设置监听函数

多个监听 key 使用,分隔。

export default {
watch: mapWatcher({
// 用法1
'todoRequest1.data, todoRequest2.data'(newVal, oldVal) {},

// 用法2
'todoRequest1, todoRequest2': {
loading(newVal, oldVal) {},
data(newVal, oldVal) {}
},

// 用法3
todoRequest1: {
'loading, data'(newVal, oldVal) {}
},

// 用法4
'todoRequest1, todoRequest2': {
'loading, data'(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)
};
});

mapWatcher

mapWatcher是用于快速定义 hook 状态变化的辅助函数,它接收一个对象,键为 hook 状态的 key 或嵌套值的字符串表示,值为监听函数或监听器对象。

// 1. 监听单个状态
mapWatcher({
'todoRequest.loading'(newVal, oldVal) {
//...
},
todoRequest: {
data(newVal, oldVal) {
//...
}
},
todoRequest: {
'loading, data'(newVal, oldVal) {
//...
}
}
}

mapWatcher除了支持对 alova useHook 的监听辅助外,你还可以使用它批量设置普通状态值的监听。

export default {
data() {
state1: '',
state2: 0
},

// 第二个参数传入false即可监听普通状态
watch: mapWatcher({
'state1, state2'(newVal, oldVal) {
//...
}
}, false)
}

类型支持

自动推断

@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. 暂不支持管理额外的状态
  2. 目前只支持 alova 的useRequest/useWatcher/useFetcher三个核心 useHook,以及你在自己项目中基于核心 useHook 的封装,暂不支持@alova/scene内的扩展 useHook。