axios的使用学习
自己封装axios
这里一般使用的时候就是axios 再加上 vue-axios 和react-axios
一般的项目里面是引入axios和vue-axios两个,这里要说一下vue-axios是vue对axios进行了一次封装,这个代码其实很少,可以去看看源码。
我们也可以自己来封一次,但是呢,自己封也是千年老代码,封一次,以后就照着封,要有好的模板。之前的项目就是自己封了一波,但是呢我觉得不太好,因为他只能封一个域名,遇到了换域名的问题呢,就要再封一次,我这里就是简单的用了原生的axios来写,算是偷懒了。得空搞个千年老代码上上。
axios解决跨域问题
这个主要是做了个代理(使用webpack的dev-server的参数poxy),将所有的域全部代理换成自己的本地,这样来绕过浏览器的域名检测
这里这个只是开发时方便开发,跨域问题一般后端解决,其实这个方案就是niginx代理修改请求地址,不过换成了webpack的简单server来做代理,所以上线之后还是要有别的代理方式解决跨域。
备注:
Vue.js 1.0 我们常使用 vue-resource (官方ajax库), Vue 2.0 发布后作者宣告不再对 vue-resource 进行更新, 推荐我们使用 axios (基于 Promise 的 HTTP 请求客户端,可同时在浏览器和 node.js 中使用)
安装
使用 npm:
$ npm install --save axios
使用 bower:
$ bower install axios
使用 cdn:
执行 GET 请求
// 为给定 ID 的 user 创建请求
axios.get('/user?ID=12345')
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
// 上面的请求可以这样做
axios.get('/user', {
params: {
ID: 12345
}
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
})
执行 POST 请求
axios.post('/user', {
firstName: 'Fred',
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([getUserAccount(), getUserPermissions()])
.then(axios.spread(function (acct, perms) {
// 两个请求现在都执行完成
}));
Axios API
可以通过向 axios 传递相关配置来创建请求
axios(config)
// 发送 POST 请求
axios({
method: 'post',
url: '/user/12345',
data: {
firstName: 'Fred',
lastName: 'Flintstone'
}
axios(url[, config])
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]])
NOTE
在使用别名方法时, url、method、data 这些属性都不必在配置中指定。
并发
处理并发请求的助手函数
axios.all(iterable)
axios.spread(callback)
创建实例
可以使用自定义配置新建一个 axios 实例
axios.create([config])
var instance = axios.create({
baseURL: '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 是必需的。如果没有指定 method,请求将默认使用 get 方法。
{
//url是用于请求的服务器 URL
url: '/user',
//method是创建请求时使用的方法
method: 'get', // 默认是 get
//baseURL将自动加在url前面,除非url是一个绝对 URL。
// 它可以通过设置一个baseURL便于为 axios 实例的方法传递相对 URL
baseURL: '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. www.npmjs.com/package/qs, api.jquery.com/jquery.para…)
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) {
}) }
作者:九四年的风
链接:www.jianshu.com/p/cdec60909…
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。