Axios
是一个基于Promise
的 HTTP 库,能够用在浏览器和node.js
中,由于尤大大的推荐,axios也变得愈来愈流行。最近项目中使用axios也遇到了一些问题,就借此机会总结一下,若有错误,还请不吝指正。node
XMLHttpRequests
请求node
层发起http
请求Promise
API请求
和响应
请求
和响应
数据JSON
数据XSRF(跨站请求伪造)
npmios
npm install axios
git
bowergithub
bower install axios
npm
cdnjson
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
axios
发起请求segmentfault
axios.get('/user?ID=123') .then( res => { // 请求数据成功并返回数据。 console.info(res) }).catch( e => { if(e.response){ //请求已发出,服务器返回状态码不是2xx。 console.info(e.response.data) console.info(e.response.status) console.info(e.response.headers) }else if(e.request){ // 请求已发出,但没有收到响应 // e.request 在浏览器里是一个XMLHttpRequest实例, // 在node中是一个http.ClientRequest实例 console.info(e.request) }else{ //发送请求时异常,捕捉到错误 console.info('error',e.message) } console.info(e.config) }) // 等同如下写法 axios({ url: '/user', method: 'GET', params: { ID: 123 } }).then( res => { console.info(res) }).catch( e => { console.info(e) })
axios.post('/user', { firstName: 'Mike', lastName: 'Allen' }).then( res => { console.info(res) }).catch( e => { console.info(e) }) // 等同如下写法 axios({ url: '/user', method: 'POST', data: { firstName: 'Mike', lastName: 'Allen' } }).then( res => { console.info(res) }).catch( e => { console.info(e) })
在使用GET
方法传递参数时使用的是params
,而且官方文档中介绍为:params are the URL parameters to be sent with the request. Must be a plain object or a URLSearchParams object
。译为:params
做为URL连接中的参数发送请求,且其必须是一个plain object
或者是URLSearchParams object
。plain object
(纯对象)是指用JSON
形式定义的普通对象或者new Object()
建立的简单对象;而URLSearchParams object
指的是一个能够由URLSearchParams接口定义的一些实用方法来处理 URL 的查询字符串的对象,也就是说params
传参是以/user?ID=1&name=mike&sex=male
形式传递的。浏览器
而在使用POST
时对应的传参使用的是data
,data
是做为请求体发送的,一样使用这种形式的还有PUT
,PATCH
等请求方式。有一点须要注意的是,axios
中POST
的默认请求体类型为Content-Type:application/json
(JSON规范流行),这也是最多见的请求体类型,也就是说使用的是序列化后的json
格式字符串来传递参数,如:{ "name" : "mike", "sex" : "male" }
;同时,后台必需要以支持@RequestBody
的形式接收参数,不然会出现前台传参正确,后台接收不到的状况。
若是想要设置类型为Content-Type:application/x-www-form-urlencoded
(浏览器原生支持),axios
提供了两种方式,以下:服务器
浏览器端
const params = new URLSearchParams(); params.append('param1', 'value1'); params.append('param2', 'value2'); axios.post('/user', params);
不过,并非全部浏览器都支持URLSearchParams
,兼容性查询caniuse.com,可是这里有一个Polyfill (polyfill
:用于实现浏览器并不支持的原生API的代码,能够模糊理解为补丁,同时要确保polyfill
在全局环境中)。
或者,你也能够用qs
这个库来格式化数据。默认状况下在安装完axios后就可使用qs
库。
const qs = require('qs'); axios.post('/user', qs.stringify({'name':'mike'}));
node层
在node
环境中可使用querystring
。一样,也能够用qs
来格式化数据。
const querystring = require('querystring'); axios.post('http://something.com/', querystring.stringify({'name':'mike'}));
常见的请求体类型还有一种方式,即multipart/form-data
(浏览器原生支持),也就是提交表单数据经常使用的一种格式。和x-www-form-urlencoded
对比起来,后者则是数据被编码成以 '&' 分隔的键-值对, 同时以 '=' 分隔键和值。非字母或数字的字符会被Percent-encoding(URL encoding),这也就是为何这种类型不支持二进制数据的缘由 (应使用 multipart/form-data 代替)。
本文只是总结了axios
中一些经常使用的知识点,也是本人平时在开发中遇到过的问题,因此还有些node层的应用以及其余使用场景没有涉及到,更详细的配置请移步axios官方文档,另,推荐一篇翻译不错的中文文档axios译。