最近在写Vue
的时候,小小的尝试了一下Axios
,总结一下自己的使用吧。
##背景
Axios
是一个基于Promise
的 HTTP
库,可以用在浏览器和node.js
中,因为尤大大的推荐,Axios
也变得越来越流行。
可能很多人不太清除Promise
是什么?举个例子,像我们之前写前端的时候想要和后端进行交互,无非就是xhr
或是ajax
,现在Promise
和Fetch
横空出世,也慢慢的占据了交互领域的市场。
$.ajax({
type: 'POST',
url: url,
data: data,
dataType: dataType,
success: function() {},
error: function() {}
})
它是对原生XHR
的封装,还支持JSONP
,非常方便;真的是用过的都说好。但是随着react
,vue
等前端框架的兴起,jquery
早已不复当年之勇。很多情况下我们只需要使用ajax
,但是却需要引入整个jquery
,这非常的不合理,于是便有了fetch
的解决方案。
2. fetch
fetch号称是ajax的替代品,它的API是基于Promise设计的,旧版本的浏览器不支持Promise,需要使用polyfill es6-promise
// 原生XHR
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
console.log(xhr.responseText) // 从服务器获取数据
}
}
xhr.send()
// fetch
fetch(url)
.then(response => {
if (response.ok) {
response.json()
}
})
.then(data => console.log(data))
.catch(err => console.log(err))
看起来好像是方便点,then
链就像之前熟悉的callback
。
再搭配上async/await
将会让我们的异步代码更加优雅:
async function test() {
let response = await fetch(url);
let data = await response.json();
console.log(data)
}
看起来是不是像同步代码一样?简直完美!好吧,其实并不完美,async/await
是ES7
的API
,目前还在试验阶段,还需要我们使用babel
进行转译成ES5
代码。
还要提一下的是,fetch
是比较底层的API
,很多情况下都需要我们再次封装。 比如:
// jquery ajax
$.post(url, {name: 'test'})
// fetch
fetch(url, {
method: 'POST',
body: Object.keys({name: 'test'}).map((key) => {
return encodeURIComponent(key) + '=' + encodeURIComponent(params[key]);
}).join('&')
})
axios
是尤雨溪大神推荐使用的,它也是对原生XHR
的封装。它有以下几大特性:
node.js
中使用Promise API
axios({
method: 'GET',
url: url,
})
.then(res => {console.log(res)})
.catch(err => {console.log(err)})
写法有很多种,自行查看文档
并发请求
function getUserAccount() {
return axios.get('/user/12345');
}
function getUserPermissions() {
return axios.get('/user/12345/permissions');
}
axios.all([getUserAccount(), getUserPermissions()])
.then(axios.spread(function (acct, perms) {
// Both requests are now complete
}));
这是官方的并发案例,好像是挺厉害的样子。不过感觉它的all
方法应该是基于Promise.all()
的
axios
体积比较小,也没有上面fetch
的各种问题,我认为是当前最好的请求方式 。
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'}));