axios使用-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_38436431/article/details/134012286

1. axios特点

axios（ajax i/o system）不是一种新技术，本质上也是对原生XHR（XMLHttpReques）的封装，只不过它是基于Promise的，是Promise的实现版本，符合最新的ES规范。

支持从浏览器发出XMLHttpRequest
支持从node.js发出http请求
支持 Promise 风格
支持拦截请求和响应
支持自动转换请求和响应数据
支持取消请求
支持JSON数据的自动转换
支持将数据对象自动序列化为 multipart/form-data 或者 x-www-form-urlencoded请求体
客户端防止 XSRF (也称 CSRF, Cross Site Request Forgery ) 攻击

2. axios安装

npm安装

$ npm install axios

<script src="https://cdn.jsdelivr.net/npm/axios@1.1.2/dist/axios.min.js"></script>

导入

import axios, {isCancel, AxiosError} from 'axios';

或

import axios from 'axios';
console.log(axios.isCancel('something'));

3. axios 请求示例

3.1.可以向 axios 传递相关配置来创建请求 axios(config)

demo1

// 发起一个post请求
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

demo2

// 在 node.js 用GET请求获取远程图片
axios({
  method: 'get',
  url: 'http://bit.ly/2mTM3nY',
  responseType: 'stream'
})
  .then(function (response) {
    response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
  });

// 发起一个 GET 请求 (默认请求方式)
axios('/user/12345');

3.2. 请求方式别名

为了简化请求方法配置的AP，已经为所有支持的请求方法提供了别名。

import axios from 'axios';
//const axios = require('axios'); // legacy way

// Make a request for a user with a given ID
axios.get('/user?ID=12345')
  .then(function (response) {
    // handle success
    console.log(response);
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })
  .finally(function () {
    // always executed
  });

// Optionally the request above could also be done as
axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {
    // always executed
  });

// Want to use async/await? Add the `async` keyword to your outer function/method.
async function getUser() {
  try {
    const response = await axios.get('/user?ID=12345');
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

4. Axios 请求配置

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method，请求将默认使用 GET 方法。

4.1. url

// url 是用于请求的服务器 URL
url: ‘/user’,

4.2. method

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

4.2. baseURL

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

4.2. transformRequest

// transformRequest 允许在向服务器发送前，修改请求数据
// 它只能用于 ‘PUT’, ‘POST’ 和 ‘PATCH’ 这几个请求方法
// 数组中最后一个函数必须返回一个字符串，一个Buffer实例，ArrayBuffer，FormData，或 Stream
// 你可以修改请求头。

  transformRequest: [function (data, headers) {
    // 对发送的 data 进行任意转换处理
    return data;
  }],

4.3. transformResponse

// transformResponse 在传递给 then/catch 前，允许修改响应数据

  transformResponse: [function (data) {
   // 对接收的 data 进行任意转换处理
    return data;
  }],

4.4. headers

// 自定义请求头

  headers: {'X-Requested-With': 'XMLHttpRequest'},

4.5. params

// params 是与请求一起发送的 URL 参数
// 必须是一个简单对象或 URLSearchParams 对象

  params: {
    ID: 12345
  },

4.6. paramsSerializer

// 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'})
  },

4.7. data

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’,

4.8. timeout

timeout 指定请求超时的毫秒数。
如果请求时间超过 timeout 的值，则请求会被中断

timeout: 1000, // 默认值是 0 (永不超时)

4.9. withCredentials

// withCredentials 表示跨域请求时是否需要使用凭证

withCredentials: false, // default

4.10. adapter

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

  adapter: function (config) {
    /* ... */
  },

4.11. auth

auth HTTP Basic Auth

  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

4.12. responseType

responseType 表示浏览器将要响应的数据类型, 选项包括: ‘arraybuffer’, ‘document’, ‘json’, ‘text’, ‘stream’

responseType: ‘json’, // 默认值

4.13. responseEncoding

responseEncoding 表示用于解码响应的编码 (Node.js 专属)
注意：忽略 responseType 的值为 ‘stream’，或者是客户端请求

responseEncoding: ‘utf8’, // 默认值

4.14. onUploadProgress

onUploadProgress 允许为上传处理进度事
- 浏览器专属

  onUploadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

4.15. onDownloadProgress

onDownloadProgress 允许为下载处理进度事件
浏览器专属

  onDownloadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

4.16. maxContentLength

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

maxContentLength: 2000,

4.17. maxBodyLength

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

maxBodyLength: 2000,

4.18. cancelToken

see https://axios-http.com/zh/docs/cancellation

 cancelToken: new CancelToken(function (cancel) {
  }),

5. 响应结构

data 由服务器提供的响应

data: {},
status 来自服务器响应的 HTTP 状态码

status: 200,
statusText 来自服务器响应的 HTTP 状态信息

statusText: ‘OK’,
headers 是服务器响应头, 所有的 header 名称都是小写，而且可以使用方括号语法访问. 例如: response.headers['content-type']

headers: {},
config 是 axios 请求的配置信息

config: {},
request 是生成此响应的请求, 在node.js中它是最后一个ClientRequest实例 (in redirects)，在浏览器中则是 XMLHttpRequest 实例

request: {}

6. 默认配置

您可以指定默认配置，它将作用于每个请求。

全局 axios 默认值

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

自定义实例默认值

// 创建实例时配置默认值
const instance = axios.create({
  baseURL: 'https://api.example.com'
});

// 创建实例后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

配置的优先级
配置将会按优先级进行合并。它的顺序是：
在lib/defaults.js中库的默认值 < 实例的 defaults 属性 < 请求的 config 参数。

// 使用库提供的默认配置创建实例
// 此时超时配置的默认值是 `0`
const instance = axios.create();

// 重写库的超时默认值
// 现在，所有使用此实例的请求都将等待2.5秒，然后才会超时
instance.defaults.timeout = 2500;

// 重写此请求的超时时间，因为该请求需要很长时间
instance.get('/longRequest', {
  timeout: 5000
});

7. 拦截器

在请求或响应被 then 或 catch 处理前拦截它们。

 // 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么
    return Promise.reject(error);
  });

如果你稍后需要移除拦截器，可以这样：

const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

可以给自定义的 axios 实例添加拦截器。

const instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

8. 错误处理

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // 请求成功发出且服务器也响应了状态码，但状态代码超出了 2xx 的范围
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
      // 请求已经成功发起，但没有收到响应
      // `error.request` 在浏览器中是 XMLHttpRequest 的实例，
      // 而在node.js中是 http.ClientRequest 的实例
      console.log(error.request);
    } else {
      // 发送请求时出了点问题
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

使用 validateStatus 配置选项，可以自定义抛出错误的 HTTP code。

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 处理状态码小于500的情况
  }
})

9. 取消请求

AbortController
从 v0.22.0 开始，Axios 支持以 fetch API 方式—— AbortController 取消请求：

const controller = new AbortController();

axios.get('/foo/bar', {
   signal: controller.signal
}).then(function(response) {
   //...
});
// 取消请求
controller.abort()