<h3 id="axios">axios
- 基于promise用于浏览器和node.js的http客户端
- 支持浏览器和node.js
- 支持promise
- 能拦截请求和响应
- 能转换请求和响应数据
- 能取消请求
- 自动转换JSON数据
- 浏览器端支持防止CSRF(跨站请求伪造)
-
npm安装
$ npm install axios
npm install axios --save//本地
npm install axios -s
- 在vue中全局引用
- 以vue-cli为例,在main.js中
- 因为axios并不是vue自带的,所以我们不能用Vue.use()
-
只能将其赋值给vue的prototype,已达到所有页面都能使用axios的目的
import axios from 'axios';
Vue.prototype.axios = axios;
-
使用this.axios
methods:{
myajax:function(){
this.axios({
method:'post',url: '接口地址',data:{}
})
.then(function(res){
console.log(res.data)
})
.catch(function(err){
console.log(err)
})
}
}
-
bower安装
$ bower install axios
-
通过cdn引入
- axios.request(config)
- axios.get(url[,config])
- axios.delete(url[,config])
- axios.head(url[,config])
- axios.options(url[,config])
- axios.post(url[,data[,config]])
- axios.put(url[,config]])
- axios.patch(url[,config]])
- 注释:当使用以上别名方法时,url,method和data等属性不用在config重复声明。
this.axios.get('/user',{
params: {
ID: 12345
}
})
.then(function (res) {
console.log(res);
})
.catch(function (err) {
console.log(err);
});
this.axios({
method:'get',url:'',params: {
ID: 12345
},responseType:'stream'
})
.then(function(response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
this.axios.post('url',{
firstName: 'Fred',//属性:属性值
lastName: 'Flintstone'
})
.then(function (res) {
console.log(res);
})
.catch(function (err) {
console.log(err);
});
axios({
method: 'post',url: '',data: {
firstName: 'Fred',lastName: 'Flintstone'
})
.then(function (res) {
console.log(res);
})
.catch(function (err) {
console.log(err);
});
this.axios.all([
this.axios.get('url'),this.axios.get('url')
])
.then(this.axios.spread(function (userResp,reposResp) {
// 上面两个请求都完成后,才执行这个回调方法
console.log('User',userResp.data);
console.log('Repositories',reposResp.data);
}));
<h4 id="同时发生的请求">(3)、同时发生的请求
<h5 id="以下两个用来处理同时发生多个请求的辅助函数">以下两个用来处理同时发生多个请求的辅助函数
- axios.all(iterable)
- axios.spread(callback)
{
// `url` 是用于请求的服务器 URL
url: '/user',// `method` 是创建请求时使用的方法
method: 'get',// 默认是 get
// baseURL 将自动加在 url 前面,除非 url 是一个绝对 URL。
// 它可以通过设置一个 baseURL 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',// transformRequest 允许在向服务器发送前,修改请求数据
// 只能用在 'PUT','POST' 和 'PATCH' 这几个请求方法
// 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
transformRequest: [function (data) {
// 对 data 进行任意转换处理
return data;
}],// transformResponse 在传递给 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. 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 时,必须是以下类型之一:
// - string,plain object,ArrayBuffer,ArrayBufferView,URLSearchParams
// - 浏览器专属:FormData,File,Blob
// - Node 专属: Stream
data: {
firstName: 'Fred'
},// timeout 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 timeout 的时间,请求将被中断
timeout: 1000,// withCredentials 表示跨域请求时是否需要使用凭证
withCredentials: false,// 默认的
// adapter 允许自定义处理请求,以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 response docs).
adapter: function (config) {
/ ... /
},// auth 表示应该使用 HTTP 基础验证,并提供凭据
// 这将设置一个 Authorization 头,覆写掉现有的任意使用 headers 设置的自定义 Authorization 头
auth: {
username: 'janedoe',password: 's00pers3cret'
},// responseType 表示服务器响应的数据类型,可以是 'arraybuffer','blob','document','json','text','stream'
responseType: 'json',// 默认的
// xsrfCookieName 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN',// default
// xsrfHeaderName 是承载 xsrf token 的值的 HTTP 头的名称
xsrfHeaderName: 'X-XSRF-TOKEN',// 默认的
// onUploadProgress 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// 对原生进度事件的处理
},// onDownloadProgress 允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
// 对原生进度事件的处理
},// 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) {
})
}
<h4 id="post">post


{
// `data` 由服务器提供的响应
data: {},// `status` 来自服务器响应的 HTTP 状态码
status: 200,// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',// `headers` 服务器响应的头
headers: {},// `config` 是为请求提供的配置信息
config: {}
}

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);
});
var instance = axios.create({
baseURL:"https://some-domain.com/api/",timeout:1000,headers: {'X-Custom-Header':'foobar'}
});
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';
// 创建实例时设置配置的默认值
var instance = axios.create({
baseURL: 'https://api.example.com'
});
// 在实例已创建后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
<h4 id="配置的优先顺序">(5)、配置的优先顺序
-
配置会以一个优先顺序进行合并。这个顺序是:在 lib/defaults.js 找到的库的默认值,然后是实例的 defaults 属性,最后是请求的 config 参数。后者将优先于前者。
// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();
// 覆写库的超时默认值
// 现在,在超时前,所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;
// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest',{
timeout: 5000
});
// 添加请求拦截器
axios.interceptors.request.use(function (config) {
// 在发送请求之前做些什么
return config;
},function (error) {
// 对请求错误做些什么
return Promise.reject(error);
});
// 添加响应拦截器
axios.interceptors.response.use(function (response) {
// 对响应数据做点什么
return response;
},function (error) {
// 对响应错误做点什么
return Promise.reject(error);
});
<h5 id="如果你想在稍后移除拦截器可以这样">2.如果你想在稍后移除拦截器,可以这样
var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);
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.headers);
} else {
// Something happened in setting up the request that triggered an Error
console.log('Error',error.message);
}
console.log(error.config);
});
axios.get('/user/12345',{
validateStatus: function (status) {
return status < 500; // 状态码在大于或等于500时才会 reject
}
})
- Axios 的 cancel token API 基于cancelable promises proposal(),它还处于第一阶段。
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('Operation canceled by the user.');
<h5 id="还可以通过传递一个-executor-函数到-canceltoken-的构造函数来创建-cancel-token">3.还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token:
var CancelToken = axios.CancelToken;
var cancel;
axios.get('/user/12345',{
cancelToken: new CancelToken(function executor(c) {
// executor 函数接收一个 cancel 函数作为参数
cancel = c;
})
});
// 取消请求
cancel();
- 注意: 可以使用同一个 cancel token 取消多个请求
(编辑:李大同)
【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!
|