axios中文文档

axios

基于http客户端的promise，面向浏览器和nodejs

特色

• 浏览器端发起XMLHttpRequests请求

• node端发起http请求

• 支持Promise API

• 监听请求和返回

• 转化请求和返回

• 取消请求

• 自动转化json数据

• 客户端支持抵御

安装

使用npm：

$ npm i axiso

使用 bower

$ bower instal axios

使用cdn

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

示例

使用一个 GET 请求

1.  
   //发起一个user请求，参数为给定的ID
2.  
   axios.get('/user?ID=1234')
3.  
   .then(function(respone){
4.  
   console.log(response);
5.  
   })
6.  
   .catch(function(error){
7.  
   console.log(error);
8.  
   });
9.  
    
10.  
    //上面的请求也可选择下面的方式来写
11.  
    axios.get('/user',{
12.  
    params:{
13.  
    ID:12345
14.  
    }
15.  
    })
16.  
    .then(function(response){
17.  
    console.log(response);
18.  
    })
19.  
    .catch(function(error){
20.  
    console.log(error)
21.  
    });

发起一个 POST 请求

axios.post('/user',{
    firstName:'friend',
    lastName:'Flintstone'
})
.then(function(response){
    console.log(response);
})
.catch(function(error){
    console.log(error);
});

发起一个多重并发请求

function getUserAccount(){
    return axios.get('/user/12345');
}

function getUserPermissions(){
    return axios.get('/user/12345/permissions');
}

axios.all([getUerAccount(),getUserPermissions()])
    .then(axios.spread(function(acc,pers){
        //两个请求现在都完成
    }));

axios API

axios 能够在进行请求时进行一些设置。

axios(config)

//发起 POST请求

axios({
    method:'post',
    url:'/user/12345',
    data:{
        firstName:'Fred',
        lastName:'Flintstone'
    }
});

axios(url[,config])

//发起一个GET请求
axios('/user/12345/);

请求方法的重命名。

为了方便，axios提供了所有请求方法的重命名支持

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 特性不需要在config中设置。

并发 Concurrency

有用的方法

axios.all(iterable)

axios.spread(callback)

创建一个实例

你可以使用自定义设置创建一个新的实例

axios.create([config])

var instance = axios.create({
    baseURL:'http://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 .

1.  
   {
2.  
   //`url`是服务器链接，用来请求用
3.  
   url:'/user',
4.  
    
5.  
   //`method`是发起请求时的请求方法
6.  
   method:`get`,
7.  
    
8.  
   //`baseURL`如果`url`不是绝对地址，那么将会加在其前面。
9.  
   //当axios使用相对地址时这个设置非常方便
10.  
    //在其实例中的方法
11.  
    baseURL:'http://some-domain.com/api/',
12.  
     
13.  
    //`transformRequest`允许请求的数据在传到服务器之前进行转化。
14.  
    //这个只适用于`PUT`,`GET`,`PATCH`方法。
15.  
    //数组中的最后一个函数必须返回一个字符串，一个`ArrayBuffer`,或者`Stream`
16.  
    transformRequest:[function(data){
17.  
    //依自己的需求对请求数据进行处理
18.  
    return data;
19.  
    }],
20.  
     
21.  
    //`transformResponse`允许返回的数据传入then/catch之前进行处理
22.  
    transformResponse:[function(data){
23.  
    //依需要对数据进行处理
24.  
    return data;
25.  
    }],
26.  
     
27.  
    //`headers`是自定义的要被发送的头信息
28.  
    headers:{'X-Requested-with':'XMLHttpRequest'},
29.  
     
30.  
    //`params`是请求连接中的请求参数，必须是一个纯对象，或者URLSearchParams对象
31.  
    params:{
32.  
    ID:12345
33.  
    },
34.  
     
35.  
    //`paramsSerializer`是一个可选的函数，是用来序列化参数
36.  
    //例如：（https://ww.npmjs.com/package/qs,http://api.jquery.com/jquery.param/)
37.  
    paramsSerializer: function(params){
38.  
    return Qs.stringify(params,{arrayFormat:'brackets'})
39.  
    },
40.  
     
41.  
    //`data`是请求提需要设置的数据
42.  
    //只适用于应用的'PUT','POST','PATCH'，请求方法
43.  
    //当没有设置`transformRequest`时，必须是以下其中之一的类型（不可重复？）：
44.  
    //-string,plain object,ArrayBuffer,ArrayBufferView,URLSearchParams
45.  
    //-仅浏览器：FormData,File,Blob
46.  
    //-仅Node：Stream
47.  
    data:{
48.  
    firstName:'fred'
49.  
    },
50.  
    //`timeout`定义请求的时间，单位是毫秒。
51.  
    //如果请求的时间超过这个设定时间，请求将会停止。
52.  
    timeout:1000,
53.  
     
54.  
    //`withCredentials`表明是否跨域请求，
55.  
    //应该是用证书
56.  
    withCredentials:false //默认值
57.  
     
58.  
    //`adapter`适配器，允许自定义处理请求，这会使测试更简单。
59.  
    //返回一个promise，并且提供验证返回（查看[response docs](#response-api)）
60.  
    adapter:function(config){
61.  
    /*...*/
62.  
    },
63.  
     
64.  
    //`auth`表明HTTP基础的认证应该被使用，并且提供证书。
65.  
    //这个会设置一个`authorization` 头（header），并且覆盖你在header设置的Authorization头信息。
66.  
    auth:{
67.  
    username:'janedoe',
68.  
    password:'s00pers3cret'
69.  
    },
70.  
     
71.  
    //`responsetype`表明服务器返回的数据类型，这些类型的设置应该是
72.  
    //'arraybuffer','blob','document','json','text',stream'
73.  
    responsetype:'json',
74.  
     
75.  
    //`xsrfHeaderName` 是http头（header）的名字，并且该头携带xsrf的值
76.  
    xrsfHeadername:'X-XSRF-TOKEN'，//默认值
77.  
     
78.  
    //`onUploadProgress`允许处理上传过程的事件
79.  
    onUploadProgress: function(progressEvent){
80.  
    //本地过程事件发生时想做的事
81.  
    },
82.  
     
83.  
    //`onDownloadProgress`允许处理下载过程的事件
84.  
    onDownloadProgress: function(progressEvent){
85.  
    //下载过程中想做的事
86.  
    },
87.  
     
88.  
    //`maxContentLength` 定义http返回内容的最大容量
89.  
    maxContentLength: 2000,
90.  
     
91.  
    //`validateStatus` 定义promise的resolve和reject。
92.  
    //http返回状态码，如果`validateStatus`返回true（或者设置成null/undefined），promise将会接受；其他的promise将会拒绝。
93.  
    validateStatus: function(status){
94.  
    return status >= 200 && stauts < 300;//默认
95.  
    },
96.  
     
97.  
    //`httpAgent` 和 `httpsAgent`当产生一个http或者https请求时分别定义一个自定义的代理，在nodejs中。
98.  
    //这个允许设置一些选选个，像是`keepAlive`--这个在默认中是没有开启的。
99.  
    httpAgent: new http.Agent({keepAlive:treu}),
100.  
     httpsAgent: new https.Agent({keepAlive:true}),
101.  
      
102.  
     //`proxy`定义服务器的主机名字和端口号。
103.  
     //`auth`表明HTTP基本认证应该跟`proxy`相连接，并且提供证书。
104.  
     //这个将设置一个'Proxy-Authorization'头(header)，覆盖原先自定义的。
105.  
     proxy:{
106.  
     host:127.0.0.1,
107.  
     port:9000,
108.  
     auth:{
109.  
     username:'cdd',
110.  
     password:'123456'
111.  
     }
112.  
     },
113.  
      
114.  
     //`cancelTaken` 定义一个取消，能够用来取消请求
115.  
     //（查看 下面的Cancellation 的详细部分）
116.  
     cancelToke: new CancelToken(function(cancel){
117.  
     })
118.  
     }

返回响应概要 Response Schema

一个请求的返回包含以下信息

1.  
   {
2.  
   //`data`是服务器的提供的回复（相对于请求）
3.  
   data{},
4.  
    
5.  
   //`status`是服务器返回的http状态码
6.  
   status:200,
7.  
    
8.  
    
9.  
   //`statusText`是服务器返回的http状态信息
10.  
    statusText: 'ok',
11.  
     
12.  
    //`headers`是服务器返回中携带的headers
13.  
    headers:{},
14.  
     
15.  
    //`config`是对axios进行的设置，目的是为了请求（request）
16.  
    config:{}
17.  
    }

使用 then ，你会接受打下面的信息

1.  
   axios.get('/user/12345')
2.  
   .then(function(response){
3.  
   console.log(response.data);
4.  
   console.log(response.status);
5.  
   console.log(response.statusText);
6.  
   console.log(response.headers);
7.  
   console.log(response.config);
8.  
   });

使用 catch 时，或者传入一个 reject callback 作为 then 的第二个参数，那么返回的错误信息将能够被使用。

默认设置（Config Default)

你可以设置一个默认的设置，这设置将在所有的请求中有效。

全局默认设置 Global axios defaults

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

实例中自定义默认值 Custom instance default

//当创建一个实例时进行默认设置
var instance = axios.create({
    baseURL:'https://api.example.com'
});

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

设置优先级 Config order of precedence

设置(config)将按照优先顺序整合起来。首先的是在 lib/defaults.js 中定义的默认设置，其次是 defaults 实例属性的设置，最后是请求中 config 参数的设置。越往后面的等级越高，会覆盖前面的设置。

看下面这个例子：

//使用默认库的设置创建一个实例，
//这个实例中，使用的是默认库的timeout设置，默认值是0。
var instance = axios.create();

//覆盖默认库中timeout的默认值
//此时，所有的请求的timeout时间是2.5秒
instance.defaults.timeout = 2500;

//覆盖该次请求中timeout的值，这个值设置的时间更长一些
instance.get('/longRequest',{
    timeout:5000
});

拦截器 interceptors

你可以在 请求 或者 返回 被 then 或者 catch 处理之前对他们进行拦截。

1.  
   //添加一个请求拦截器
2.  
   axios.interceptors.request.use(function(config){
3.  
   //在请求发送之前做一些事
4.  
   return config;
5.  
   },function(error){
6.  
   //当出现请求错误是做一些事
7.  
   return Promise.reject(error);
8.  
   });
9.  
    
10.  
    //添加一个返回拦截器
11.  
    axios.interceptors.response.use(function(response){
12.  
    //对返回的数据进行一些处理
13.  
    return response;
14.  
    },function(error){
15.  
    //对返回的错误进行一些处理
16.  
    return Promise.reject(error);
17.  
    });

如果你需要在稍后移除拦截器,你可以

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

你可以在一个axios实例中使用拦截器

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

错误处理 Handling Errors

1.  
   axios.get('user/12345')
2.  
   .catch(function(error){
3.  
   if(error.response){
4.  
   //存在请求，但是服务器的返回一个状态码
5.  
   //他们都在2xx之外
6.  
   console.log(error.response.data);
7.  
   console.log(error.response.status);
8.  
   console.log(error.response.headers);
9.  
   }else{
10.  
    //一些错误是在设置请求时触发的
11.  
    console.log('Error',error.message);
12.  
    }
13.  
    console.log(error.config);
14.  
    });

你可以使用 validateStatus 设置选项自定义HTTP状态码的错误范围。

1.  
   axios.get('user/12345',{
2.  
   validateStatus:function(status){
3.  
   return status < 500;//当返回码小于等于500时视为错误
4.  
   }
5.  
   });

取消 Cancellation

你可以使用 cancel token 取消一个请求

axios的cancel token API是基于**cnacelable promises proposal**，其目前处于第一阶段。

你可以使用 CancelToke.source 工厂函数创建一个cancel token，如下：

1.  
   var CancelToke = axios.CancelToken;
2.  
   var source = CancelToken.source();
3.  
    
4.  
   axios.get('/user/12345', {
5.  
   cancelToken:source.toke
6.  
   }).catch(function(thrown){
7.  
   if(axiso.isCancel(thrown)){
8.  
   console.log('Rquest canceled', thrown.message);
9.  
   }else{
10.  
    //handle error
11.  
    }
12.  
    });
13.  
     
14.  
    //取消请求(信息参数设可设置的)
15.  
    source.cancel("操作被用户取消");

你可以给 CancelToken 构造函数传递一个executor function来创建一个cancel token:

1.  
   var CancelToken = axios.CancelToken;
2.  
   var cancel;
3.  
    
4.  
   axios.get('/user/12345', {
5.  
   cancelToken: new CancelToken(function executor(c){
6.  
   //这个executor 函数接受一个cancel function作为参数
7.  
   cancel = c;
8.  
   })
9.  
   });
10.  
     
11.  
    //取消请求
12.  
    cancel();

注意：你可以使用同一个cancel token取消多个请求。

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

默认情况下，axios串联js对象为 JSON 格式。为了发送 application/x-wwww-form-urlencoded格式数据，

你可以使用一下的设置。

浏览器 Browser

在浏览器中你可以如下使用 URLSearchParams API:

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

注意： URLSearchParams 不支持所有的浏览器，但是这里有个 垫片

（poly fill）可用（确保垫片在浏览器全局环境中）

其他方法：你可以使用 qs 库来格式化数据。

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

Node.js

在nodejs中，你可以如下使用 querystring :

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

你同样可以使用 qs 库。

promises

axios 基于原生的ES6 Promise 实现。如果环境不支持请使用 垫片 .