文档章节

Axios全攻略

帅的人连bug都讨厌
 帅的人连bug都讨厌
发布于 2017/06/29 17:30
字数 2200
阅读 33
收藏 1

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端,它本身具有以下特征:

Axios全攻略

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

引入方式

$ npm install axios
$ cnpm install axios /*taobao源*/
$ bower install axios
或者使用cdn:
<script src="https:/*unpkg.com/axios/dist/axios.min.js"></script>

例子

执行 GET 请求

/* 向具有指定ID的用户发出请求 */
axios.get('/user?ID=12345')
  .then(function(response){
    console.log(response);
  })
  .catch(function(error){
    console.log(error);
  });
/* 也可以通过 params 对象传递参数*/
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);
  });

执行多个并发请求

functiongetUserAccount(){
  return axios.get('/user/12345');
}
functiongetUserPermissions(){
  return axios.get('/user/12345/permissions');
}
axios.all([getUserAccount(), getUserPermissions()])
    /* 两个请求现已完成 */
  .then(axios.spread(function(acct, perms){

  })
);

axios API

可以通过将相关配置传递给 axios 来进行请求。

axios(config)

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

axios(url[, config])

发送一个 GET 请求 (GET请求是默认请求模式)

axios(‘/user/12345’);

请求方法别名

为了方便起见,已经为所有支持的请求方法提供了别名。

  • 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]])

注意

当使用别名方法时,不需要在config中指定url,method和data属性。

并发

帮助函数处理并发请求。

  • axios.all(iterable)
  • axios.spread(callback)

创建实例

您可以使用自定义配置创建axios的新实例。

axios.create([config])

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

实例方法

可用的实例方法如下所示。 指定的配置将与实例配置合并。

  • 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]])

请求配置

这些是用于发出请求的可用配置选项。 只有url是必需的。 如果未指定方法,请求将默认为GET。

{
  /* `url`是将用于请求的服务器URL*/
  url: '/user',
  /* `method`是发出请求时使用的请求方法 */
  method: 'get', /* 默认*/
  /* `baseURL`将被添加到`url`前面,除非`url`是绝对的。*/
  /* 可以方便地为 axios 的实例设置`baseURL`,以便将相对 URL 传递给该实例的方法。*/
  baseURL: 'https:/*some-domain.com/api/',
  /* `transformRequest`允许在请求数据发送到服务器之前对其进行更改*/
  /* 这只适用于请求方法'PUT','POST'和'PATCH'*/
  /* 数组中的最后一个函数必须返回一个字符串,一个 ArrayBuffer或一个 Stream*/
  transformRequest: [function(data){
    /* 做任何你想要的数据转换*/
    return data;
  }],
  /* `transformResponse`允许在 then / catch之前对响应数据进行更改*/
  transformResponse: [function(data){
    /* Do whatever you want to transform the data*/
    return data;
  }],
  /* `headers`是要发送的自定义 headers*/
  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”和“PATCH”*/
  /* 当没有设置`transformRequest`时,必须是以下类型之一:*/
  /* - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams*/
  /* - Browser only: FormData, File, Blob*/
  /* - Node only: Stream*/
  data: {
    firstName: 'Fred'
  },
  /* `timeout`指定请求超时之前的毫秒数。*/
  /* 如果请求的时间超过'timeout',请求将被中止。*/
  timeout: 1000,
  /* `withCredentials`指示是否跨站点访问控制请求*/
  /* should be made using credentials*/
  withCredentials: false, /* default*/
  /* `adapter'允许自定义处理请求,这使得测试更容易。*/
  /* 返回一个promise并提供一个有效的响应(参见[response docs](#response-api))*/
  adapter: function(config){
    /* ... */
  },
  /* `auth'表示应该使用 HTTP 基本认证,并提供凭据。*/
  /* 这将设置一个`Authorization'头,覆盖任何现有的`Authorization'自定义头,使用`headers`设置。*/
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },
  /* “responseType”表示服务器将响应的数据类型*/
  /* 包括 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', /* default*/
  /*`xsrfCookieName`是要用作 xsrf 令牌的值的cookie的名称*/
  xsrfCookieName: 'XSRF-TOKEN', /* default*/
  /* `xsrfHeaderName`是携带xsrf令牌值的http头的名称*/
  xsrfHeaderName: 'X-XSRF-TOKEN', /* default*/
  /* `onUploadProgress`允许处理上传的进度事件*/
  onUploadProgress: function(progressEvent){
    /* 使用本地 progress 事件做任何你想要做的*/
  },
  /* `onDownloadProgress`允许处理下载的进度事件*/
  onDownloadProgress: function(progressEvent){
    /* Do whatever you want with the native progress event*/
  },
  /* `maxContentLength`定义允许的http响应内容的最大大小*/
  maxContentLength: 2000,
  /* `validateStatus`定义是否解析或拒绝给定的promise*/
  /* HTTP响应状态码。如果`validateStatus`返回`true`(或被设置为`null` promise将被解析;否则,promise将被*/
  /* 拒绝。*/
  validateStatus: function(status){
    return status >= 200 && status < 300; /* default
  },
  /* `maxRedirects`定义在node.js中要遵循的重定向的最大数量。*/
  /* 如果设置为0,则不会遵循重定向。*/
  maxRedirects: 5, /* 默认*/
  /* `httpAgent`和`httpsAgent`用于定义在node.js中分别执行http和https请求时使用的自定义代理。*/
  /* 允许配置类似`keepAlive`的选项,*/
  /* 默认情况下不启用。*/
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),
  /* 'proxy'定义代理服务器的主机名和端口*/
  /* `auth`表示HTTP Basic auth应该用于连接到代理,并提供credentials。*/
  /* 这将设置一个`Proxy-Authorization` header,覆盖任何使用`headers`设置的现有的`Proxy-Authorization` 自定义 headers。*/
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },
  /* “cancelToken”指定可用于取消请求的取消令牌*/
  /* (see Cancellation section below for details)*/
  cancelToken: new CancelToken(function(cancel){
  })
}

使用 then 时,您将收到如下响应:

axios.get('/user/12345')
  .then(function(response){
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
})

配置默认值

您可以指定将应用于每个请求的配置默认值。

全局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';

自定义实例默认值

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

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

配置优先级顺序

配置将与优先顺序合并。 顺序是lib / defaults.js中的库默认值,然后是实例的defaults属性,最后是请求的config参数。 后者将优先于前者。 这里有一个例子。

/*使用库提供的配置默认值创建实例*/
/*此时,超时配置值为`0`,这是库的默认值*/
var instance = axios.create();
 
/*覆盖库的超时默认值*/
/*现在所有请求将在超时前等待2.5秒*/
instance.defaults.timeout = 2500;
 
/*覆盖此请求的超时,因为它知道需要很长时间*/
instance.get('/ longRequest',{
   timeout:5000
})

拦截器

你可以截取请求或响应在被 then 或者 catch 处理之前

/*添加请求拦截器*/
axios.interceptors.request.use(function(config){
     /*在发送请求之前做某事*/
     return config;
   },function(error){
     /*请求错误时做些事*/
     return Promise.reject(error);
   });
 
/*添加响应拦截器*/
axios.interceptors.response.use(function(response){
     /*对响应数据做些事*/
      return response;
   },function(error){
     /*请求错误时做些事*/
     return Promise.reject(error);
   });

如果你以后可能需要删除拦截器。

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

你可以将拦截器添加到axios的自定义实例。

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

消除

您可以使用取消令牌取消请求。

axios cancel token API基于可取消的promise提议,目前处于阶段1。

您可以使用CancelToken.source工厂创建一个取消令牌,如下所示:

var CancelToken = axios.CancelToken;
var source = CancelToken.source();
axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function(thrown){
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    /* 处理错误*/
  }
});
/*取消请求(消息参数是可选的)*/
source.cancel('操作被用户取消。');

您还可以通过将执行器函数传递给CancelToken构造函数来创建取消令牌:

var CancelToken = axios.CancelToken;
var cancel;
 
axios.get('/ user / 12345',{
   cancelToken:new CancelToken(functionexecutor(c){
     /*一个执行器函数接收一个取消函数作为参数*/
     cancel = c;
   })
});
/* 取消请求*/
clear();

注意:您可以使用相同的取消令牌取消几个请求。

使用application / x-www-form-urlencoded格式

默认情况下,axios将JavaScript对象序列化为JSON。 要以应用程序/ x-www-form-urlencoded格式发送数据,您可以使用以下选项之一。

浏览器

在浏览器中,您可以使用URLSearchParams API,如下所示:

var params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/foo', params);

请注意,所有浏览器都不支持URLSearchParams,但是有一个polyfill可用(确保polyfill全局环境)。

或者,您可以使用qs库对数据进行编码:

var qs = require('qs');
axios.post('/foo', qs.stringify({ 'bar': 123 });

Node.js

在node.js中,可以使用querystring模块,如下所示:

var querystring = require('querystring');
axios.post('http:/*something.com/', querystring.stringify({ foo: 'bar' });

你也可以使用qs库。

Promise

axios 依赖本机要支持ES6 Promise实现。 如果您的环境不支持ES6 Promises,您可以使用polyfill。

axios包括TypeScript定义。

import axios from 'axios';
axios.get('/user?ID=12345');

axios在很大程度上受到Angular提供的http服务的启发。最终,axios努力提供一个在Angular外使用的独立的http服务的启发。最终,axios努力提供一个在Angular外使用的独立的http-like服务。

© 著作权归作者所有

帅的人连bug都讨厌
粉丝 3
博文 53
码字总数 40134
作品 0
杭州
程序员
私信 提问
Vue中axios的封装(报错、鉴权、跳转、拦截、提示)

前言 做的一个axios的封装及实现的思路 需求及实现 统一捕获接口报错 弹窗提示 报错重定向 基础鉴权 表单序列化 实现的功能 统一捕获接口报错 : 用的axios内置的拦截器 弹窗提示: 引入 的组件...

Mr_Ma
08/20
0
0
webpack+vuex+axios 跨域请求数据的示例

本篇文章主要介绍了webpack+vuex+axios 跨域请求数据,写的十分的全面细致,具有一定的参考价值,对此有需要的朋友可以参考学习下。如有不足之处,欢迎批评指正。 使用vue-li 构建 webpack项...

前端攻城小牛
2018/12/15
0
0
细说vue axios登录请求拦截器

当我们在做接口请求时,比如判断登录超时时候,通常是接口返回一个特定的错误码,那如果我们每个接口都去判断一个耗时耗力,这个时候我们可以用拦截器去进行统一的http请求拦截。 1.安装配置...

前端攻城老湿
2018/12/06
0
0
《RHEL5企业级Linux服务全攻略》8月3日更新

第一章:常规网络管理、配置及系统服务全攻略 http://www.boobooke.com/v/bbk3095 http://www.boobooke.com/v/bbk3096 http://www.boobooke.com/v/bbk3097 第二章:Samba服务全攻略 http://w...

羽飞
2009/08/02
314
0
vue中的ajax请求和axios包详解

在vue中,经常会用到数据请求,常用的有:vue-resourse、axios 首先,引入axios get请求 post请求 配置 axios使用了 axios 的三个配置项,实际上只有 url 是必须的,完整的 api 可以参考使用...

前端攻城老湿
2018/11/25
373
0

没有更多内容

加载失败,请刷新页面

加载更多

64.监控平台介绍 安装zabbix 忘记admin密码

19.1 Linux监控平台介绍 19.2 zabbix监控介绍 19.3/19.4/19.6 安装zabbix 19.5 忘记Admin密码如何做 19.1 Linux监控平台介绍: 常见开源监控软件 ~1.cacti、nagios、zabbix、smokeping、ope...

oschina130111
昨天
64
0
当餐饮遇上大数据,嗯真香!

之前去开了一场会,主题是「餐饮领袖新零售峰会」。认真听完了餐饮前辈和新秀们的分享,觉得获益匪浅,把脑子里的核心纪要整理了一下,今天和大家做一个简单的分享,欢迎感兴趣的小伙伴一起交...

数澜科技
昨天
26
0
DNS-over-HTTPS 的下一代是 DNS ON BLOCKCHAIN

本文作者:PETER LAI ,是 Diode 的区块链工程师。在进入软件开发领域之前,他主要是在做工商管理相关工作。Peter Lai 也是一位活跃的开源贡献者。目前,他正在与 Diode 团队一起开发基于区块...

红薯
昨天
43
0
CC攻击带来的危害我们该如何防御?

随着网络的发展带给我们很多的便利,但是同时也带给我们一些网站安全问题,网络攻击就是常见的网站安全问题。其中作为站长最常见的就是CC攻击,CC攻击是网络攻击方式的一种,是一种比较常见的...

云漫网络Ruan
昨天
27
0
实验分析性专业硕士提纲撰写要点

为什么您需要研究论文的提纲? 首先当您进行研究时,您需要聚集许多信息和想法,研究论文提纲可以较好地组织你的想法, 了解您研究资料的流畅度和程度。确保你写作时不会错过任何重要资料以此...

论文辅导员
昨天
44
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部