您的位置:

axiosdata:使用Axios轻松获取和管理数据

当我们需要从一个远程服务器获取数据时,想要简洁且易于维护的方法是极其必要的。尤其是在JavaScript中,Axios已经成为了热门的解决方案。然而,管理命令或查询都可能会变得比较复杂。因此,axiosdata是一种用于简化Axios的方法,它可以轻松地运用针对不同使用情景定制的数据访问方法

一、快速开始

获取适用于axiosdata的软件包(npm):


$ npm install axiosdata

如果您未在项目中使用Axios,请同时安装Axios和Vue。 (当然,如果您使用的是其他框架,可以按照官方文档的任何说明进行设置。)


$ npm install axios vue

当软件包安装完成后,要开始使用,您可以简单地在需要的文件中进行加入:


import AxiosData from "axiosdata";

现在,您可以使用以下方法来获取和更改数据:


const axiosData = new AxiosData({
  url: "https://www.example.com/api",
});

axiosData.getData().then((data) => {
  console.log(data);
});

axiosData.putData({name: "New Name"}).then(() => {
  console.log("Data changed!");
});

当然,您可以为方法提供一些用于设置Axios实例的选项。例如,以下代码段将Axios的timeout设置为10秒:


const axiosDataWithTimeout = new AxiosData({
  url: "https://www.example.com/api",
  axiosConfig: {
    timeout: 10000,
  },
});

二、像常规Axios一样使用Interceptors

Axios Interceptors 是React生态系统中经常使用的一种方法。 毕竟,拦截器可以帮助我们在发送/接收请求时检查和修改数据。 axiosdata 允许您使用Interceptors

在axiosdata实例化时加入拦截器 ,您可以像使用普通`Axios`一样使用拦截器。这是一个具体的例子:


import AxiosData from "axiosdata"
import axios from "axios"

const axiosData = new AxiosData({
  url: "https://www.example.com/api",
  axiosConfig: {
    timeout: 5000,
  },
});

axios.interceptors.request.use((config) => {
  config.headers.Authorization = `Bearer ${localStorage.token}`;

  return config;
});

axios.interceptors.response.use(
  (response) => {
    axiosData.loading = false;

    return response;
  },
  (error) => {
    axiosData.loading = false;

    return Promise.reject(error);
  }
);

export default axiosData;

三、自定义Axios方法

axiosdata允许您根据相应需要增加自定义Axios方法。 您可以在实例实例化时即时添加方法(让您在运行时添加方法),或在创建新类时定义本定义方法。

以下是针对实例化后即时添加自定义方法的代码示例:


import AxiosData from "axiosdata";

const axiosData = new AxiosData({
  url: "https://www.example.com/api",
});

axiosData.addApiMethod(
  (id) => `/users/${id}/photos`,
  {
    method: "GET",
  }
);

以下是一个创建自定义本定义方法的代码示例:


import AxiosData from "axiosdata";

class CustomAxiosData extends AxiosData {
  constructor() {
    super({
      url: "https://www.example.com/api",
    });
  }

  getCustomData(id) {
    return this.axiosInstance.get(`/users/${id}/customData`);
  }
}

const customAxiosData = new CustomAxiosData();

customAxiosData.getCustomData(123);

四、简单与方便的特征

axiosdata提供了一些有用的功能,以尽可能方便的方式与在应用程序中经常遇到的任务进行交互。以下是其中一些例子:

1. 自动过滤更新数据:

const axiosData = new AxiosData({
  url: "https://www.example.com/api",
});

axiosData.getData().then((data) => {
  console.log(data);
  console.log(axiosData.data.value); // 这里会输出与"data"一样的内容 
});

axiosData.updateData({ value: "new value" }).then(() => {
  axiosData.getData().then((data) => {
    console.log(data);
    console.log(axiosData.data.value);  // 这里会输出 "new value"
  });
});
2. 面向列表的数据选项

设计任何针对列表数据的应用就像其他框架中所做的那样简单明了


const axiosData = new AxiosData({
  url: "https://www.example.com/api",
  list: true,
});

axiosData.getData().then((data) => {
  console.log(data);
  axiosData.data.forEach(({ value }) => {
    console.log(value);
  });
});
3. 考虑到必要的事件

我们对于数据更新是有兴趣的,因此我们的AxiosData实例提供了可供订阅的事件


const axiosData = new AxiosData({
  url: "https://www.example.com/api",
});

axiosData.on("beforeGet", () => {
  console.log("Getting data...");
});

axiosData.on("afterGet", () => {
  console.log("Data obtained.");
});

axiosData.getData().then((data) => {
  console.log(data);
});

五、总结

总之,axiosdata是一个非常有用的工具,因为它简化了Axios的使用并提供了很多额外的功能。 不仅如此,它还尝试使其尽可能简单,并针对应用特定的使用情况。 因此,在随着您的项目的迭代的过程中, 它被认为是不可少的。