xrequestedwithphp简书看到的技巧文档异常具体说明了axios技巧值得珍藏

一、安装

1、利用npm安装npm install axios --save

2、利用bower安装bower install axios --save

xrequestedwithphp简书看到的技巧文档异常具体说明了axios技巧值得珍藏 JavaScript

3、直策应用cdn引入<script src=\"大众https://unpkg.com/axios/dist/axios.min.js\"大众></script>

二、例子

1、发送一个GET要求

//通过给定的ID来发送要求axios.get('/user?ID=12345') .then(function(response){ console.log(response); }) .catch(function(err){ console.log(err); });//以上要求也可以通过这种办法来发送axios.get('/user',{ params:{ ID:12345 }}).then(function(response){ console.log(response);}).catch(function(err){ console.log(err);});

2、发送一个POST要求

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

3、一次性并发多个要求

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){ //当这两个要求都完成的时候会触发这个函数，两个参数分别代表返回的结果 }))

三、axios的API

（一） axios可以通过配置（config）来发送要求

1、 axios(config)

//发送一个`POST`要求axios({ method:\公众POST\公众, url:'/user/12345', data:{ firstName:\"大众Fred\"大众, lastName:\公众Flintstone\公众 }});

2、 axios(url[,config])

//发送一个`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]])把稳：当我们在利用别名方法的时候，url,method,data这几个参数不须要在配置中声明

（三）、并发要求（concurrency）,即是帮助处理并发要求的赞助函数

//iterable是一个可以迭代的参数如数组等axios.all(iterable)//callback要等到所有要求都完成才会实行axios.spread(callback)

（四）、创建一个axios实例，并且可以自定义其配置

1、 axios.create([config])

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

2、实例的方法

一下是实例方法，把稳已经定义的配置将和利用create创建的实例的配置合并

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

四、要求的配置（request config）

以下便是要求的配置选项，只有url选项是必须的，如果method选项未定义，那么它默认因此GET的办法发出要求

{ //`url`是要求的做事器地址 url:'/user', //`method`是要求资源的办法 method:'get'//default //如果`url`不是绝对地址，那么`baseURL`将会加到`url`的前面 //当`url`是相对地址的时候，设置`baseURL`会非常的方便 baseURL:'https://some-domain.com/api/', //`transformRequest`选项许可我们在要求发送到做事器之前对要求的数据做出一些改动 //该选项只适用于以下要求办法：`put/post/patch` //数组里面的末了一个函数必须返回一个字符串、-一个`ArrayBuffer`或者`Stream` transformRequest:[function(data){ //在这里根据自己的需求改变数据 return data; }], //`transformResponse`选项许可我们在数据传送到`then/catch`方法之前对数据进行改动 transformResponse:[function(data){ //在这里根据自己的需求改变数据 return data; }], //`headers`选项是须要被发送的自定义要求头信息 headers: {'X-Requested-With':'XMLHttpRequest'}, //`params`选项是要随要求一起发送的要求参数----一样平常链接在URL后面 //他的类型必须是一个纯工具或者是URLSearchParams工具 params: { ID:12345 }, //`paramsSerializer`是一个可选的函数，起浸染是让参数（params）序列化 //例如(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`选项时dada必须因此下几种类型之一 //string/plain/object/ArrayBuffer/ArrayBufferView/URLSearchParams //仅仅浏览器：FormData/File/Bold //仅node:Stream data { firstName:\"大众Fred\"大众 }, //`timeout`选项定义了要求发出的延迟毫秒数 //如果要求花费的韶光超过延迟的韶光，那么要求会被终止 timeout:1000, //`withCredentails`选项表明了是否是跨域要求 withCredentials:false,//default //`adapter`适配器选项许可自定义处理要求，这会使得测试变得方便 //返回一个promise,并供应验证返回 adapter: function(config){ /........../ }, //`auth`表明HTTP根本的认证该当被利用，并供应证书 //这会设置一个authorization头（header）,并覆盖你在header设置的Authorization头信息 auth: { username:\公众zhangsan\"大众, password: \"大众s00sdkf\"大众 }, //返回数据的格式 //其可选项是arraybuffer,blob,document,json,text,stream responseType:'json',//default // xsrfCookieName: 'XSRF-TOKEN',//default xsrfHeaderName:'X-XSRF-TOKEN',//default //`onUploadProgress`上传进度事宜 onUploadProgress:function(progressEvent){ //下载进度的事宜onDownloadProgress:function(progressEvent){} }, //相应内容的最大值 maxContentLength:2000, //`validateStatus`定义了是否根据http相应状态码，来resolve或者reject promise //如果`validateStatus`返回true(或者设置为`null`或者`undefined`),那么promise的状态将会是resolved,否则其状态便是rejected validateStatus:function(status){ return status >= 200 && status <300;//default }, //`maxRedirects`定义了在nodejs中重定向的最大数量 maxRedirects: 5,//default //`httpAgent/httpsAgent`定义了当发送http/https要求要用到的自定义代理 //keeyAlive在选项中没有被默认激活 httpAgent: new http.Agent({keeyAlive:true}), httpsAgent: new https.Agent({keeyAlive:true}), //proxy定义了主机名字和端口号， //`auth`表明http基本认证该当与proxy代理链接，并供应证书 //这将会设置一个`Proxy-Authorization` header,并且会覆盖掉已经存在的`Proxy-Authorization` header proxy: { host:'127.0.0.1', port: 9000, auth: { username:'skda', password:'radsd' } }, //`cancelToken`定义了一个用于取消要求的cancel token //详见cancelation部分 cancelToken: new cancelToken(function(cancel){ })}

五、要求返回的内容

{ data:{}, status:200, //从做事器返回的http状态文本 statusText:'OK', //相应头信息 headers: {}, //`config`是在要求的时候的一些配置信息 config: {}}你可以这样来获取相应信息

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

六、默认配置

你可以设置默认配置，对所有要求都有效

1、全局默认配置

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

2、自定义的实例默认设置

//当创建实例的时候配置默认配置var instance = axios.create({ baseURL: 'https://api.example.com'});//当实例创建时候修正配置instance.defaults.headers.common[\"大众Authorization\"大众] = AUTH_TOKEN;

3、配置中的有优先级

config配置将会以优先级别来合并，顺序是lib/defauts.js中的默认配置，然后是实例中的默认配置，末了是要求中的config参数的配置，越今后等级越高，后面的会覆盖前面的例子。

//创建一个实例的时候会利用libray目录中的默认配置//在这里timeout配置的值为0，来自于libray的默认值var instance = axios.create();//回答盖掉library的默认值//现在所有的要求都要等2.5S之后才会发出instance.defaults.timeout = 2500;//这里的timeout回答盖之前的2.5S变成5sinstance.get('/longRequest',{ timeout: 5000});

七、拦截器

你可以在要求、相应在到达then/catch之前拦截他们

//添加一个要求拦截器

axios.interceptors.request.use(function(config){

//在要求发出之提高行一些操作

return config;

},function(err){

//Do something with request error

return Promise.reject(error);

});

//添加一个相应拦截器

axios.interceptors.response.use(function(res){

//在这里对返回的数据进行处理

return res;

},function(err){

//Do something with response error

return Promise.reject(error);

})

2、取消拦截器

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

3、给自定义的axios实例添加拦截器

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

八、缺点处理

axios.get('/user/12345') .catch(function(error){ if(error.response){ //要求已经发出，但是做事器相应返回的状态吗不在2xx的范围内 console.log(error.response.data); console.log(error.response.status); console.log(error.response.header); }else { //一些缺点是在设置要求的时候触发 console.log('Error',error.message); } console.log(error.config); });

九、取消

你可以通过一个cancel token来取消一个要求你可以通过CancelToken.source工厂函数来创建一个cancel token

var cancelToken = axios.CancelToken;var cance;axios.get('/user/12345',{ cancelToken: new CancelToken(function(c){ //这个executor函数接管一个cancel function作为参数 cancel = c; })})//取消要求cancel();