Axios使用方法

axios简介

Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。

axios的优势:

  • 从浏览器中创建 XMLHttpRequests
  • 从 node.js 创建 http 请求
  • 支持 Promise API
  • 拦截请求和响应
  • 转换请求数据和响应数据
  • 取消请求
  • 自动转换 JSON 数据
  • 客户端支持防御 XSRF

axios的基本使用

如何引入axios

可以通过npm安装来进行使用

$ npm install axio

也可以使用 bower进行安装,然后在页面中进行引入:

$ bower install axios

还可以使用CDN来进行引入到页面中去

<script src="http://unpkg.com/axios/dist/axios.min.js"></script>

如何应用axios

当我们引入了axios之后,接下来我们就要开始正式的使用axios了,对于axios的使方法比较多:

1、可以通过向 axios 传递相关配置来创建请求:axios(config)

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

2、在上面的方法的基础上,我们还可以将url作为第一个参数传递给axios方法:axios(url,[config]),对于这样来说,如果我们没有传config,或者config中的method没有传的情况下,axios会默认使用get请求方法来进行请求:

// 发送 GET 请求(默认的方法)
axios('/user/12345');

3、针对于get类的请求(get,delete,head,options)我们还可以使用axiosmethod,这样的形式来进行请求,这样的形似其实和我们所熟知的jquery中的ajax的很类似,但是还是有区别的,对于jquery的来说,我们的针对ajax的请求的传参都是使用data这样的字段来进行传递的,但是对于ajax来说,针对于get类的请求这样的请求,传递的数据,要么我们放在url上面,要么通过config中的params这个参数来进行配置。针对与post类的请求(post,put,patch),这样的请求来说,我们上面的我们可以通过config中的data来进行传递参数,除此之外,我们还可以通过过用以下的形式来进行传递参数:axiosmethod。下面是几个例子:

get请求:

// 为给定 ID 的 user 创建请求
axios.get('/user?ID=12345')
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

// 可选地,上面的请求可以这样做
axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

post 请求

axios.post('/user', {
    firstName: 'Fred',
    lastName: 'Flintstone'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

具体的使用方法我们可以如下:
为方便起见,为所有支持的请求方法提供了别名

  • axios.request(config)
  • axios.get(url[, config])
  • axios.delete(url[, config])
  • axios.head(url[, config])
  • axios.post(url[, data[, config]])
  • axios.put(url[, data[, config]])
  • axios.patch(url[, data[, config]])

4、当然,我们也重新创建一个新的axios实例来进行使用axios,然后通过实例来使用,其使用的方法,和以上三种使用方法类似。

var instance = axios.create({
  baseURL: 'http://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

instance.get('helloword.api')

如何使用axios来进行拦截请求和响应

在谈拦截请求和响应的前,我们先介绍一下拦截器这个概念:
(如果你熟悉中间件,那么就很好理解了,因为它起到的就是基于promise的中间件的作用)拦截器分为请求拦截器和响应拦截器,顾名思义:请求拦截器(interceptors.request)是指可以拦截住每次或指定http请求,并可修改配置项响应拦截器(interceptors.response)可以在每次http请求后拦截住每次或指定http请求,并可修改返回结果项。
针对于axios的拦截器,主要分为请求拦截器和响应拦截器。请求拦截器是指可以拦截住每次请求或者是指定的http请求,并且可以修改其配置项。响应拦截器是指在http请求后,可以拦截住每次的响应或者是指定http的响应,并且可以修改其结果。
具体的使用过程:

/ 添加请求拦截器
const myRequestInterceptor = axios.interceptors.request.use(config => {
    // 在发送http请求之前做些什么
    return config; // 有且必须有一个config对象被返回
}, error => {
    // 对请求错误做些什么
    return Promise.reject(error);
});

// 添加响应拦截器
axios.interceptors.response.use(response => {
  // 对响应数据做点什么
  return response; // 有且必须有一个response对象被返回
}, error => {
  // 对响应错误做点什么
  return Promise.reject(error);
});

// 移除某次拦截器
axios.interceptors.request.eject(myRequestInterceptor);

请求拦截器和响应拦截器的的使用场景。
请求拦截器
1、在我们发送的请求中,我们每次都需要向后端传递的内容,比如说,用户登陆认证的token等相关的内容
2、如果我们需要对请求数据进行加密的情况下我们可以在请求拦截器中添加
3、请求链接的处理
4、统一添加版本号等相关的内容
响应拦截器
1、我们对相应结果需要进行统一处理的
2、我们对相应中的错误进行统一处理,
3、我们对相应的数据进行统一处理
等等

如何使用axios来进行取消请求

当我们发送一个请求,但是在发送过程中希望取消请求,在传统的ajax中使用的,提供有abort()方法来取消ajax请求,但是在axios中,页提供了有关取消请求的方法,具体的使用方法如下:

import axios from 'axios'

// 第一种取消方法
axios.get(url, {
  cancelToken: new axios.CancelToken(cancel => {
    if (/* 取消条件 */) {
      cancel('取消日志');
    }
  })
});

// 第二种取消方法
const CancelToken = axios.CancelToken;
const source = CancelToken.source();
axios.get(url, {
  cancelToken: source.token
});
source.cancel('取消日志');

如何配置axios

在以上的使用方法中我们看到了在axios请求的时,我们可以添加配置项,但是可以配置的内容有哪些呢:

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

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

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

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

    return data;
  }],

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

    return data;
  }],

  // `headers` 是即将被发送的自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是即将与请求一起发送的 URL 参数
  // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
  params: {
    ID: 12345
  },

  // `paramsSerializer` 是一个负责 `params` 序列化的函数
  // (e.g. http://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },

  // `data` 是作为请求主体被发送的数据
  // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
  // 在没有设置 `transformRequest` 时,必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属:FormData, File, Blob
  // - Node 专属: Stream
  data: {
    firstName: 'Fred'
  },

  // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
  // 如果请求话费了超过 `timeout` 的时间,请求将被中断
  timeout: 1000,

  // `withCredentials` 表示跨域请求时是否需要使用凭证
  // 打一个比方如果在跨域请求的时候,如果我们需要向后台发送cookie的情况下,这个时候我们需要将这个字段设置成true
  withCredentials: false, // 默认的

  // `adapter` 允许自定义处理请求,以使测试更轻松
  // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },

  // `auth` 表示应该使用 HTTP 基础验证,并提供凭据
  // 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // 默认的

  // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的

  // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  onDownloadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `maxContentLength` 定义允许的响应内容的最大尺寸
  maxContentLength: 2000,

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

  // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  // 如果设置为0,将不会 follow 任何重定向
  maxRedirects: 5, // 默认的

  // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
  // `keepAlive` 默认没有启用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // 'proxy' 定义代理服务器的主机名称和端口
  // `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
  // 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // `cancelToken` 指定用于取消请求的 cancel token
  // (查看后面的 Cancellation 这节了解更多)
  cancelToken: new CancelToken(function (cancel) {
  })
}

以上就是axois中常用的配置项的内容。其实对于axios还有一个通用的默认配置,就比如说,我们请求超时的时间,如我们不会在每次请求的时候都去设置这个超时时间,那么我们又没方法能够进行统一设置这个超时时间的呢,其实我们可以通过使用default.config的方法来进行设置axios的通用的请求配置的内容。

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

小结

以上就是我自己总结的有关axios的使用方法,可能有些地方存在问题,这些对于axios的基本使用已经算足够的,如果希望更深入的去了解axios,就需要我们在实际的使用过程中,不断的总结。总结我们遇到的实际的场景,并且场景中的具体的表现和实际解决思路。

posted @ 2020-02-14 15:51  曹思源  阅读(...)  评论(...编辑  收藏