axios
基于 Promise 的 HTTP 請(qǐng)求客戶(hù)端普筹，可同時(shí)在瀏覽器和 node.js 中使用
功能特性
在瀏覽器中發(fā)送XMLHttpRequests請(qǐng)求
在 node.js 中發(fā)送http請(qǐng)求
支持Promise?API
攔截請(qǐng)求和響應(yīng)
轉(zhuǎn)換請(qǐng)求和響應(yīng)數(shù)據(jù)
自動(dòng)轉(zhuǎn)換 JSON 數(shù)據(jù)
客戶(hù)端支持保護(hù)安全免受XSRF攻擊
瀏覽器支持
安裝
使用 bower:
$ bowerinstallaxios
使用 npm:
$ npminstallaxios
例子
發(fā)送一個(gè)GET請(qǐng)求
// Make a request for a user with a given IDaxios.get('/user?ID=12345').then(function(response){console.log(response);}).catch(function(response){console.log(response);});// Optionally the request above could also be done asaxios.get('/user',{params:{ID:12345}}).then(function(response){console.log(response);}).catch(function(response){console.log(response);});
發(fā)送一個(gè)POST請(qǐng)求
axios.post('/user',{firstName:'Fred',lastName:'Flintstone'}).then(function(response){console.log(response);}).catch(function(response){console.log(response);});
發(fā)送多個(gè)并發(fā)請(qǐng)求
functiongetUserAccount(){returnaxios.get('/user/12345');}functiongetUserPermissions(){returnaxios.get('/user/12345/permissions');}axios.all([getUserAccount(),getUserPermissions()]).then(axios.spread(function(acct,perms){// Both requests are now complete}));
可以通過(guò)給axios傳遞對(duì)應(yīng)的參數(shù)來(lái)定制請(qǐng)求：
// Send a POST requestaxios({method:'post',url:'/user/12345',data:{firstName:'Fred',lastName:'Flintstone'}});
// Sned a GET request (default method)axios('/user/12345');
為方便起見(jiàn)如庭，我們?yōu)樗兄С值恼?qǐng)求方法都提供了別名
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])
當(dāng)使用別名方法時(shí)剂娄，url、method和data屬性不需要在 config 參數(shù)里面指定。
處理并發(fā)請(qǐng)求的幫助方法
你可以用自定義配置創(chuàng)建一個(gè)新的 axios 實(shí)例。
varinstance=axios.create({baseURL:'https://some-domain.com/api/',timeout:1000,headers:{'X-Custom-Header':'foobar'}});
所有可用的實(shí)例方法都列在下面了，指定的配置將會(huì)和該實(shí)例的配置合并说铃。
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])
下面是可用的請(qǐng)求配置項(xiàng)，只有url是必需的嘹履。如果沒(méi)有指定method腻扇，默認(rèn)的請(qǐng)求方法是GET。
{// `url` is the server URL that will be used for the requesturl:'/user',// `method` is the request method to be used when making the requestmethod:'get',// default// `baseURL` will be prepended to `url` unless `url` is absolute. // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs // to methods of that instance.baseURL:'https://some-domain.com/api/',// `transformRequest` allows changes to the request data before it is sent to the server// This is only applicable for request methods 'PUT', 'POST', and 'PATCH'// The last function in the array must return a string or an ArrayBuffertransformRequest:[function(data){// Do whatever you want to transform the datareturndata;}],// `transformResponse` allows changes to the response data to be made before// it is passed to then/catchtransformResponse:[function(data){// Do whatever you want to transform the datareturndata;}],// `headers` are custom headers to be sentheaders:{'X-Requested-With':'XMLHttpRequest'},// `params` are the URL parameters to be sent with the requestparams:{ID:12345},// `paramsSerializer` is an optional function in charge of serializing `params`// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)paramsSerializer:function(params){returnQs.stringify(params,{arrayFormat:'brackets'})},// `data` is the data to be sent as the request body// Only applicable for request methods 'PUT', 'POST', and 'PATCH'// When no `transformRequest` is set, must be a string, an ArrayBuffer or a hashdata:{firstName:'Fred'},// `timeout` specifies the number of milliseconds before the request times out.// If the request takes longer than `timeout`, the request will be aborted.timeout:1000,// `withCredentials` indicates whether or not cross-site Access-Control requests// should be made using credentialswithCredentials:false,// default// `adapter` allows custom handling of requests which makes testing easier.// Call `resolve` or `reject` and supply a valid response (see [response docs](#response-api)).adapter:function(resolve,reject,config){/* ... */},// `auth` indicates that HTTP Basic auth should be used, and supplies credentials.// This will set an `Authorization` header, overwriting any existing// `Authorization` custom headers you have set using `headers`.auth:{username:'janedoe',password:'s00pers3cret'}// `responseType` indicates the type of data that the server will respond with// options are 'arraybuffer', 'blob', 'document', 'json', 'text'responseType:'json',// default// `xsrfCookieName` is the name of the cookie to use as a value for xsrf tokenxsrfCookieName:'XSRF-TOKEN',// default// `xsrfHeaderName` is the name of the http header that carries the xsrf token valuexsrfHeaderName:'X-XSRF-TOKEN',// default// `progress` allows handling of progress events for 'POST' and 'PUT uploads'// as well as 'GET' downloadsprogress:function(progressEvent){// Do whatever you want with the native progress event}}
響應(yīng)的數(shù)據(jù)結(jié)構(gòu)
響應(yīng)的數(shù)據(jù)包括下面的信息：
{// `data` is the response that was provided by the serverdata:{},// `status` is the HTTP status code from the server responsestatus:200,// `statusText` is the HTTP status message from the server responsestatusText:'OK',// `headers` the headers that the server responded withheaders:{},// `config` is the config that was provided to `axios` for the requestconfig:{}}
當(dāng)使用then或者catch時(shí), 你會(huì)收到下面的響應(yīng)：
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);});
你可以為每一個(gè)請(qǐng)求指定默認(rèn)配置砾嫉。
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';
// Set config defaults when creating the instancevarinstance=axios.create({baseURL:'https://api.example.com'});// Alter defaults after instance has been createdinstance.defaults.headers.common['Authorization']=AUTH_TOKEN;
Config will be merged with an order of precedence. The order is library defaults found inlib/defaults.js, thendefaultsproperty of the instance, and finallyconfigargument for the request. The latter will take precedence over the former. Here's an example.
// Create an instance using the config defaults provided by the library// At this point the timeout config value is `0` as is the default for the libraryvarinstance=axios.create();// Override timeout default for the library// Now all requests will wait 2.5 seconds before timing outinstance.defaults.timeout=2500;// Override timeout for this request as it's known to take a long timeinstance.get('/longRequest',{timeout:5000});
你可以在處理then或catch之前攔截請(qǐng)求和響應(yīng)
// 添加一個(gè)請(qǐng)求攔截器axios.interceptors.request.use(function(config){// Do something before request is sentreturnconfig;},function(error){// Do something with request errorreturnPromise.reject(error);});// 添加一個(gè)響應(yīng)攔截器axios.interceptors.response.use(function(response){// Do something with response datareturnresponse;},function(error){// Do something with response errorreturnPromise.reject(error);});
移除一個(gè)攔截器：
varmyInterceptor=axios.interceptors.request.use(function(){/*...*/});axios.interceptors.request.eject(myInterceptor);
你可以給一個(gè)自定義的 axios 實(shí)例添加攔截器：
varinstance=axios.create();instance.interceptors.request.use(function(){/*...*/});
axios.get('/user/12345').catch(function(response){if(responseinstanceofError){// Something happened in setting up the request that triggered an Errorconsole.log('Error',response.message);}else{// The request was made, but the server responded with a status code// that falls out of the range of 2xxconsole.log(response.data);console.log(response.status);console.log(response.headers);console.log(response.config);}});
axios 依賴(lài)一個(gè)原生的 ES6 Promise 實(shí)現(xiàn)幼苛，如果你的瀏覽器環(huán)境不支持 ES6 Promises，你需要引入polyfill
axios 包含一個(gè)TypeScript定義
///
import * as axios from 'axios';
axios.get('/user?ID=12345');
