一文读懂之Axios在Vue中的封装

在 Vue.js 中进行网络请求是我们日常开发中经常遇到的需求之一。而 Axios 作为一个强大的 HTTP 客户端，为我们提供了方便快捷的网络请求解决方案。在本文中，我将分享如何在 Vue 项目中封装和使用 Axios，以及一些最佳实践。

1、为什么要封装 Axios？

封装 Axios 主要有以下几个好处：

统一配置：可以在封装过程中统一配置基本的请求地址、超时时间、请求头等信息，避免重复的代码和配置。使用请求拦截器，在其中处理一些业务（开始进度条、请求头携带公共参数）。
简化调用：封装后的 Axios 可以通过简单的方法调用来发送请求，使得代码更加简洁和易读。
增强可维护性：将请求相关的逻辑统一封装在一起，有利于代码的维护和管理，减少重复劳动。

2、Axios 封装步骤

安装 Axios：首先，确保已经在项目中安装了 Axios，可以通过 npm 或 yarn 进行安装：
```
npm install axios
```
或
csharp 复制代码
```
yarn add axios
```
创建封装文件 ：在项目src/utils文件夹创建一个文件，比如 request.js，用于封装 Axios。
编写封装代码 ：在 api.js 中编写 Axios 的封装代码，包括创建 Axios 实例、设置拦截器、封装请求方法等。
导出封装对象：将封装好的 Axios 实例或者封装的请求方法导出，以便在其他文件中使用。

3、示例代码

以下是一个简单的 Axios 封装示例：

javascript 复制代码

/* ./src/until/request.js     */

// 1、引入axios
import axios from 'axios'; //

// 2、创建axios实例，在其中设置公共参数
const instance = axios.create({
  baseURL: 'http://api.example.com',
  timeout: 10000,
  headers: {
    'Content-Type': 'application/json',
  },
});

// 3、设置请求拦截器；可在发送请求前对请求进行处理，如添加 token 等
instance.interceptors.request.use(config => {
    return config;
  },
  error => {
    return Promise.reject(error);
  }
);

// 4、设置响应拦截器；可对响应数据进行处理，如简化数据、处理错误码等
instance.interceptors.response.use(
  response => {
    
    return response.data; // 返回data
  },
  error => {
    return Promise.reject(error);
  }
);

// 5、其他请求方法的封装...

export default instance;

4、在 Vue 组件中使用

javascript 复制代码

import request from '@/utils/request.js';

export default {
  mounted() {
    // 发送 GET 请求
    request.get('/user', { id: 123 }).then(response => {
      console.log(response);
    });

    // 发送 POST 请求
    request.post('/login', { username: 'admin', password: '123456' }).then(response => {
      console.log(response);
    });
  },
};

Tips：在vue2中可以将src/utils的 request.js中暴漏的instance对像挂载在Vue.prototype中，在组件中通过this找到

5、总结

通过对 Axios 进行封装，我们可以在 Vue 项目中更加方便地进行网络请求，并且提高了代码的可维护性和可读性。希望本文对你了解如何在 Vue 中封装和使用 Axios 有所帮助。

附录：

axios的API参考官网，英文：axios-http.com ，中文：www.axios-http.cn/ 。其config参数配置如下：

js 复制代码

{
  // `url` 是用于请求的服务器 URL
  url: '/user',

  // `method` 是创建请求时使用的方法
  method: 'get', // 默认值

  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream
  // 你可以修改请求头。
  transformRequest: [function (data, headers) {
    // 对发送的 data 进行任意转换处理

    return data;
  }],

  // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [function (data) {
    // 对接收的 data 进行任意转换处理

    return data;
  }],

  // 自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是与请求一起发送的 URL 参数
  // 必须是一个简单对象或 URLSearchParams 对象
  params: {
    ID: 12345
  },

  // `paramsSerializer`是可选方法，主要用于序列化`params`
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function (params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },

  // `data` 是作为请求体被发送的数据
  // 仅适用 'PUT', 'POST', 'DELETE 和 'PATCH' 请求方法
  // 在没有设置 `transformRequest` 时，则必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属: FormData, File, Blob
  // - Node 专属: Stream, Buffer
  data: {
    firstName: 'Fred'
  },
  
  // 发送请求体数据的可选语法
  // 请求方式 post
  // 只有 value 会被发送，key 则不会
  data: 'Country=Brasil&City=Belo Horizonte',

  // `timeout` 指定请求超时的毫秒数。
  // 如果请求时间超过 `timeout` 的值，则请求会被中断
  timeout: 1000, // 默认值是 `0` (永不超时)

  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // default

  // `adapter` 允许自定义处理请求，这使测试更加容易。
  // 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。
  adapter: function (config) {
    /* ... */
  },

  // `auth` HTTP Basic Auth
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示浏览器将要响应的数据类型
  // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  // 浏览器专属：'blob'
  responseType: 'json', // 默认值

  // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  // 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // 默认值

  // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称
  xsrfCookieName: 'XSRF-TOKEN', // 默认值

  // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值

  // `onUploadProgress` 允许为上传处理进度事件
  // 浏览器专属
  onUploadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  // 浏览器专属
  onDownloadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  maxContentLength: 2000,

  // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数
  maxBodyLength: 2000,

  // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
  // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，
  // 则promise 将会 resolved，否则是 rejected。
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认值
  },

  // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  // 如果设置为0，则不会进行重定向
  maxRedirects: 5, // 默认值

  // `socketPath` 定义了在node.js中使用的UNIX套接字。
  // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  // 只能指定 `socketPath` 或 `proxy` 。
  // 若都指定，这使用 `socketPath` 。
  socketPath: null, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // `proxy` 定义了代理服务器的主机名，端口和协议。
  // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。
  // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。
  // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https`
  proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // see https://axios-http.com/zh/docs/cancellation
  cancelToken: new CancelToken(function (cancel) {
  }),

  // `decompress` indicates whether or not the response body should be decompressed 
  // automatically. If set to `true` will also remove the 'content-encoding' header 
  // from the responses objects of all decompressed responses
  // - Node only (XHR cannot turn off decompression)
  decompress: true // 默认值