跳到主要内容
版本:v2

method元数据

版本要求

v2.7.0+

method 实例是贯穿 alova 的整个请求生命周期的,并且,在项目中会大量存在不同的 method 实例,有时候我们需要对特定的 method 实例添加附加信息,以便于对它们进行身份标识或额外的信息传递等,此时,我们就需要使用 method 元数据。

使用元数据标识身份

在请求前使用身份标识

例如,你的项目中大部分接口在每次请求时需附带token,但还存在一些接口无需验证的,可能你会在全局的beforeRequest函数中统一处理它们。

const nonvalidateRequiredApi = [
'/api/url1',
'/api/url2',
'/api/url3'
// ...
];

createAlova({
beforeRequest(method) {
if (!nonvalidateRequiredApi.includes(method.url)) {
method.config.headers.token = '...';
}
}
});

这将导致以下两个问题:

  1. 信息没有与 method 实例聚合,可维护性更差;
  2. 编码更麻烦;

为解决这两个问题,我们将使用元数据的方式,在创建特定的 method 实例时对它进行标识。

第一步:在创建 method 实例时定义元数据

const loginAPI = (username, password) => {
const methodInstance = alovaInst.Post('/login', {
username,
password
});
methodInstance.meta = {
ignoreToken: true
};
return methodInstance;
};

[2.18.0+] 你也可以直接在 config 中传入 meta 数据

const loginAPI = (username, password) => {
return alovaInst.Post(
'/login',
{
username,
password
},
{
meta: {
ignoreToken: true
}
}
);
};

第二步:在beforeRequest中通过元数据作为判断依据

createAlova({
// ...
beforeRequest(method) {
if (!method.meta?.ignoreToken) {
method.config.headers.token = '...';
}
}
});

在响应后使用标识身份

这种方式还可以用于在全局的responded中,例如,在绝大部分情况下,请求 api 都将返回 json 数据,但可能存在文件下载接口,它将返回二进制数据流,在这种情况下,你可以在responded中使用不同的元数据分别处理不同的响应。

第一步:创建 method 实例时同样需要分配一个元数据

const downloadAPI = filePath => {
const methodInstance = alovaInst.Post('/download_file', {
filePath
});
methodInstance.meta = {
isDownload: true
};
return methodInstance;
};

第二步:在responded中通过元数据作为判断依据

createAlova({
// ...
responded:
onSuccess: (response, method) => method.meta?.isDownload ? response.blob() : response.json()
onError: (error, method) => {
// 在响应错误时也可以访问method实例的元数据
}
}
});

使用元数据传递信息

在某种情况下,如果你希望为不同的 method 实例添加附加信息,以便在其他地方使用,也可以使用元数据进行保存。以统一生成不同的 method 实例 id 为例。

createAlova({
beforeRequest(method) {
if (!method.meta.generateId) {
method.meta.uid = generateUUID();
}
},

responded: {
onSuccess(response, method) {
// 在请求成功中访问当前method生成的meta数据
const currentMethodUID = method.meta.uid;
},
onError(error, method) {
// 在请求失败中访问当前method生成的meta数据
const currentMethodUID = method.meta.uid;
}
}
});

非 typescript 项目提示

在非 typescript 环境下,你可以使用任意一个属性作为信息载体,而不局限于meta属性。

methodInstance.showResponseMsg = true;
methodInstance.others = 'abc';

只是在 typescript 环境下,任意的属性名将会报不存在属性“$0”。ts(2339),因此在类型中我们指定了meta属性作为信息载体。