Axios学习笔记

Axios说明

Axios是一个基于promise的HTTP库，可以用在浏览器和node.js中。

安装

使用npm:

$ npm install axios

使用bower

$ bower install axiso

使用cdn：

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

例子

执行GET请求

//为给定ID的user创建请求
axiso.get('/user?ID=12345').then(
    function(res){
        console.log(res);
        }).catch(function(err){
            console.log(err)
        });
//可选地，上面的请求可以这样做
axios.get('/user',{
    params:{
        ID:12345,
    }
}).then(
    function(res){
        console.log(res);
    }
).catch(function(err){})

执行POST请求

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

执行多个并发请求,.then以后使用axios.spread方法分割请求的数据，一一对应。

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
可以通过向axiso传递相关配置来创建请求
axios(config)
//发送post请求

axios({
    method:'post',
    url:'/user/12345',
    data:{
        first:1,
        last:2
    }
})

为方便起见，为所有支持的请求方法提供了别名
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]])

创建实例
axios.create([config])

var instance = axios.create({
    baseUrl:'https://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是用于请求服务器的url
    url:'/user',
    //method是创建请求时使用的方法
    method:'get',
    //baseUrl将自动加在url前面，除非url是一个绝对url。
    //它可以通过设置一个baseUrl便于axios实例的方法传递相对URL
    baseUrl:'https://some-domain.com/api/',
    //transformRequest允许在向服务器发送前，修改请求的数据。
    //只能用在post，put，patch这几个请求方法
    //后面数组中的函数必须返回一个字符串，或ArrayBuffer，或Stream
    transformRequest:[function(data){
       //对data进行任意转换处理。
       return data;
    }],
    //Transform Response在传递给then/catch钱，允许修改响应的数据
    transformResponse：[function(data){
        //对data进行任意转换处理
        return data;
    }],
    //headers是即将被发送的自定义请求头
    headers:{'X-Requested-With': 'XMLHttpRequest'},
    //params是即将与请求一起发送的url参数
    //必须是一个无格式对象plain object或URLSearchParams对象
    params:{
        ID:12345
    },
    //paramsSerializer是一个负责params序列化的函数。
    //（e.g.http://www.npmjs.com/package/qs,http://api.jquery.com/jquery.param/）
    paramsSerializer:function(params){
        return Qs.stringfy(params,{arrayFormat:'brackets'})
    },
    //data是作为请求主体被发送的数据
    //只适用与put，post，和patch
    //在没有设置transformRequest时，必须是以下类型之一：string，plain object，ArrayBuffer，ArrayBufferView，URLSearchParams
    data: {
        firstName: 'Fred'
    },
    //timeout指定了请求超时的毫秒数，
    //如果请求超过了timeout的时间，请求将被中断，
    timeout:1000,
    //withCredentials表示跨域请求时是否需要使用凭证，
    withCredentials:false,//默认值
    //adapter允许自定义处理请求，以使测试更轻松，
    //返回一个promise并应用一个有效的响应。
    adapter:function(config){},
    //auth表示应该使用http基础验证，并提供数据。
    //这将设置一个Authorization头，覆盖掉现有的任意使用headers设置的自定义Authorization头。
    auth:{
        username:'janedoe',
        password:'s00pers3cret'
    },
    //responseType表示服务器响应的数据类型，可以是arraybuffer，blod，document，json，text，stream，
    responseType:json,//默认值
    //xsrfHeaderName是承载xsrf token的值的http头的名称。
    xsrfHeaderName:'X-XSRF-TOKEN',//默认值
    //onUploadProgress允许为上传处理进度事件。
    onUploadProgress：function(progressEvent){
        //对原生进度事件的处理
    },
    //onDownloadProgress允许为下载处理进度事件。
    onDownloadProgress:function(){
        //对原生进度事件的处理
    },
    //maxContentLength定义允许的响应内容的最大尺寸。
    maxContentLength：2000,
    //validateStatus定义与给定的http相应状态码是resolve或reject promise。如果validateStatus返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte。
    validateStatus: function (status) {
        return status >= 200 && status < 300; // 默认的
    },
    // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
    // 如果设置为0，将不会 follow 任何重定向
    maxRedirects: 5, // 默认的

    // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
    // `keepAlive` 默认没有启用
    httpAgent: new http.Agent({ keepAlive: true }),
    httpsAgent: new https.Agent({ keepAlive: true }),
    // 'proxy' 定义代理服务器的主机名称和端口
    // `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
    // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
    proxy: {
      host: '127.0.0.1',
      port: 9000,
      auth: : {
        username: 'mikeymike',
        password: 'rapunz3l'
      }
    },
    // `cancelToken` 指定用于取'消请求的 cancel token
    // （查看后面的 Cancellation 这节了解更多）
    cancelToken: new CancelToken(function (cancel) {
   })
}

名词讲解：
http协议基本认证 Authorization。
在浏览网页的时候，浏览器会弹出一个登陆验证的对话框，如下图，这就是使用HTTP基本renzheng。
图片描述
HTTP基本认证的过程。
第一步：客户端发送http request给服务器。
第二步：因为request中没有包含Authorization header，服务器会返回一个401 Unauthozied给客户端，并且在Response的header“WWW-Authenticate”中添加信息。

第三步：客户端把用户名和密码用BASE64编码后，放在Authorization header中发送给服务器，认证成功。
图片描述
第四步：服务器将Authorization header中的用户名密码取出，进行验证，如果验证通过，将根据请求，发送资源给客户端/。

HTTP OAuth认证。
OAuth 对于Http来说，就是放在Authorization header中的不是用户名密码，而是一个token.

配置的默认值/defaults

你可以指定将被用在各个请求的配置默认值
全局的axios默认值

axios.defaults.baseURl = 'http://api';
aixos.defaults.headers.common['Authorization']=AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

自定义实例默认值

// 创建实例时设置配置的默认值
var instance = axios.create({
  baseURL: 'https://api.example.com'
});

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

配置的优先顺序
配置会以一个优先顺序进行合并。这个顺序是：在lib/defaults.js找到库的默认值，然后是实例的defaults属性，最后是请求的config参数。后者将优先于前者。这里是一个例子：

//使用由库提供的配置的默认值来创建实例
//此时超时配置的默认值是0
var instance= axios.create();
//覆写库的超时默认值
//现在，在超时前，所有的请求都会等待2.5秒
instance.defaults.timeout = 2500;
//为已知需要花费很长时间的请求覆写超时设置
instance.get('/url',{
    timeout:5000
})

拦截器

在请求或响应被then或catch处理前拦截它们

//添加请求拦截器
axios.interceptors.request.use(function(config){
        //在发送请求前做些什么
        return config;
    },functoin(err){
        //对请求错误做些什么
        return Promise.reject(err);
});
//添加响应拦截器
axios.interceptors.response.use(function(res){
        //对响应数据做点什么
        return res;
    },function(err){
        //对响应错误做点什么
        return Promise.reject(err)
    }
)

如果你想在稍后移除拦截器，可以这样：

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

可以为自定义axios实例添加拦截器

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

取消

使用cancel token取消请求。可以使用CancelToken.source工厂方法创建cancel token，像这样：

var CancelToken = axios.CancelToken;
var source = CancelToken.source();
axios.get('/user/12345',{
    cancelToken:source.token
}).catch(function(thrown){
    if(axios.isCancel(thrown)){
        console.log('Request canceled',thrown.message)
    }else{
        //处理错误
    }
});
//取消请求（message参数是可选的）
source.cancel('sadsad')

还可以通过传递一个executor函数到CancelToken的构造函数来创建cancle token：

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

Axios学习笔记

Axios说明

安装

例子

配置的默认值/defaults

拦截器

取消

Lessong

引用和评论

js面向对象及原型继承学习笔记。

腾讯新闻中心首页改版啦

前端如何入门 Go 语言

前站 - 前端导航，搜索社区，阅读文章，提升技术

前端开发工具

100个React最佳实践小技巧

开发插件集合