一、axios 简介
axios 是一个基于Promise用于浏览器和 nodejs 的 HTTP 客户端,它本身具有以下特征:
- 从浏览器中创建
XMLHttpRequest
- 从
node.js 发出 http 请求
- 支持
Promise api
- 拦截请求和响应
- 转换请求和响应数据
- 取消请求
- 自动转换
JSON数据
- 客户端支持防止
CSRF/XSRF
二、axios基础
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 [,data [,config]])
axios.patch(url [,data [,config]])
三、执行 GET 请求
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
| axios.get('/user?ID=12345') .then(function (res) { console.log(res); }) .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 请求
1 2 3 4 5 6 7 8 9 10 11 12 13
| axios.post('/user', { userId:"123" },{ headers:{ token:"abc" } }) .then(function (res) { console.log(res); }) .catch(function (error) { console.log(error); });
|
五、通过配置方式发送请求
get请求是发送参数,在params中定义。而POST请求是发送request body,需要在data中定义
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
| axios({ url:"pakage.json", method:"get", params:{ userId:"123" }, headers:{ token:"http-test" } }).then(res=>{ console.log(res.data); })
axios({ url:"pakage.json", method:"post", data:{ userId:"123" }, headers:{ token:"http-test" } }).then(res=>{ console.log(res.data); })
|
六、执行多个并发请求
1 2 3 4 5 6 7 8 9 10 11 12 13 14
| function getUserAcount(){ return axios.get("/user/1234"); } function getUserPermissions(){ return axios.get("/user/1234/getUserPermissions"); }
axios.all([getUserAccount(),getUserPerssions()]).then(axios.spread((acct, perms) => { }))
|
七、全局拦截
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
| new Vue({ el:"app", data:{ msg:"" }, mounted:function(){ axios.interceptors.request.use(config=>{ return config; }) axios.interceptors.response.use(response=>{ return response; }) },
methods: { get: function() { }, post:function() { } } })
|
八、请求封装、异常统一处理
vue中采用axios处理网络请求,避免请求接口重复代码,以及各种网络情况造成的异常情况的判断,采用axios请求封装和异常拦截操作
8.1 axios 请求封装
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
| import axios from 'axios'
export const postRequest = (url, params) => { return axios({ method: 'post', url: url, data: params, transformRequest: [function (data) { let ret = '' for (let it in data) { ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&' } return ret }], headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }); }
export const uploadFileRequest = (url, params) => { return axios({ method: 'post', url: url, data: params, headers: { 'Content-Type': 'multipart/form-data' } }); }
export const getRequest = (url) => { return axios({ method: 'get', url: url }); }
export const putRequest = (url, params) => { return axios({ method: 'put', url: url, data: params, transformRequest: [function (data) { let ret = '' for (let it in data) { ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&' } return ret }], headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }); }
export const deleteRequest = (url) => { return axios({ method: 'delete', url: url }); }
|
8.2 axios请求异常统一处理
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
| import axios from 'axios' import {Message} from 'element-ui'
axios.interceptors.request.use(config=> { return config; }, err=> { Message.error({message: '请求超时!'}); return Promise.resolve(err); })
axios.interceptors.response.use(data=> {
switch (data.code) { case '0': if (isIOS()) { setTimeout(() => { document.body.scrollTop += 1 }, 0) } return data
case 'SHIRO_E5001': if (isWeChat() && IS_PRODUCTION) { axios.get(apis.common.wechat.authorizeUrl).then(({ result }) => { location.replace(global.decodeURIComponent(result)) }) } else { const search = encodeSearchParams({ next: location.href, })
location.replace(`/user/login`) }
data.description = '' break
default: } const err = new Error(data.description)
err.data = data err.response = response
if (data.status && data.status == 200 && data.data.status == 'error') { Message.error({message: data.data.msg}); return; } return data; }, err=> {
if (err && err.response) { switch (err.response.status) { case 400: err.message = '请求错误(400)'; break; case 401: err.message = '未授权,请重新登录(401)'; break; case 403: err.message = '拒绝访问(403)'; break; case 404: err.message = '请求出错(404)'; break; case 408: err.message = '请求超时(408)'; break; case 500: err.message = '服务器错误(500)'; break; case 501: err.message = '服务未实现(501)'; break; case 502: err.message = '网络错误(502)'; break; case 503: err.message = '服务不可用(503)'; break; case 504: err.message = '网络超时(504)'; break; case 505: err.message = 'HTTP版本不受支持(505)'; break; default: err.message = `连接出错(${err.response.status})!`; } } else { err.message = '连接服务器失败!' } Message.err( {message: err.message } ) return Promise.resolve(err); })
|
请求出错的时候执行的是:Promise.resolve(err);,而不是Promise.reject(err);,这样无论请求成功还是失败,在成功的回调中都能收到通知
8.3 vue 项目中使用该方法
在main.js中导入所有请求方法
1 2
| import {getRequest,postRequest,deleteRequest,putRequest} from './utils/api'
|
将请求方法添加至 Vue.prototype 上
1 2 3 4 5
| Vue.prototype.getRequest = getRequest; Vue.prototype.postRequest = postRequest; Vue.prototype.deleteRequest = deleteRequest; Vue.prototype.putRequest = putRequest;
|
发送请求(请求方法的调用)
1 2 3 4 5
| this.postRequest('/login', {userName,password}).then(resp=> { ... } });
|
九、接口封装处理
vue中axios的封装与api接口的管理详解
9.1 axios的封装
在vue项目中,和后台交互获取数据这块,我们通常使用的是axios库,它是基于promise的http库,可运行在浏览器端和node.js中。他有很多优秀的特性,例如拦截请求和响应、取消请求、转换json、客户端防御XSRF等
- 一般我会在项目的
src目录中,新建一个request文件夹,然后在里面新建一个http.js和一个api.js文件。http.js文件用来封装我们的axios,api.js用来统一管理我们的接口
1 2 3 4 5
| import axios from 'axios'; import QS from 'qs';
import { Toast } from 'vant';
|
9.2 环境的切换
我们的项目环境可能有开发环境、测试环境和生产环境。我们通过node的环境变量来匹配我们的默认的接口url前缀。axios.defaults.baseURL可以设置axios的默认请求地址就不多说了
1 2 3 4 5 6 7 8 9
| if (process.env.NODE_ENV == 'development') { axios.defaults.baseURL = 'https://www.baidu.com';} else if (process.env.NODE_ENV == 'debug') { axios.defaults.baseURL = 'https://www.ceshi.com'; } else if (process.env.NODE_ENV == 'production') { axios.defaults.baseURL = 'https://www.production.com'; }
|
9.3 设置请求超时
通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s,就会告知用户当前请求超时,请刷新等
1
| axios.defaults.timeout = 10000;
|
post请求头的设置post请求的时候,我们需要加上一个请求头,所以可以在这里进行一个默认的设置,即设置post的请求头为application/x-www-form-urlencoded;charset=UTF-8
1
| axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencode
|
9.4 请求拦截
我们在发送请求前可以进行一个请求的拦截,为什么要拦截呢,我们拦截请求是用来做什么的呢?比如,有些请求是需要用户登录之后才能访问的,或者post请求的时候,我们需要序列化我们提交的数据。这时候,我们可以在请求被发送之前进行一个拦截,从而进行我们想要的操作
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
|
import store from '@/store/index';
config => { const token = store.state.token; token && (config.headers.Authorization = token); return config; }, error => { return Promise.error(error); })
|
一般是在登录完成之后,将用户的token通过localStorage或者cookie存在本地,然后用户每次在进入页面的时候(即在main.js中),会首先从本地存储中读取token,如果token存在说明用户已经登陆过,则更新vuex中的token状态。然后,在每次请求接口的时候,都会在请求的header中携带token,后台人员就可以根据你携带的token来判断你的登录是否过期,如果没有携带,则说明没有登录过。这时候或许有些小伙伴会有疑问了,就是每个请求都携带token,那么要是一个页面不需要用户登录就可以访问的怎么办呢?其实,你前端的请求可以携带token,但是后台可以选择不接收啊!
9.5 响应的拦截
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
| axios.interceptors.response.use( response => { if (response.status === 200) { return Promise.resolve(response); } else { return Promise.reject(response); } }, error => { if (error.response.status) { switch (error.response.status) { case 401: router.replace({ path: '/login', query: { redirect: router.currentRoute.fullPath } }); break;
case 403: Toast({ message: '登录过期,请重新登录', duration: 1000, forbidClick: true }); localStorage.removeItem('token'); store.commit('loginSuccess', null); setTimeout(() => { router.replace({ path: '/login', query: { redirect: router.currentRoute.fullPath } }); }, 1000); break;
case 404: Toast({ message: '网络请求不存在', duration: 1500, forbidClick: true }); break; default: Toast({ message: error.response.data.message, duration: 1500, forbidClick: true }); } return Promise.reject(error.response); } } });
|
响应拦截器很好理解,就是服务器返回给我们的数据,我们在拿到之前可以对他进行一些处理。例如上面的思想:如果后台返回的状态码是200,则正常返回数据,否则的根据错误的状态码类型进行一些我们需要的错误,其实这里主要就是进行了错误的统一处理和没登录或登录过期后调整登录页的一个操作
- 要注意的是,上面的
Toast()方法,是我引入的vant库中的toast轻提示组件,你根据你的ui库,对应使用你的一个提示组件
9.6 封装get方法和post方法
我们常用的ajax请求方法有get、post、put等方法。axios对应的也有很多类似的方法,不清楚的可以看下文档。但是为了简化我们的代码,我们还是要对其进行一个简单的封装。下面我们主要封装两个方法:get和post
get方法:我们通过定义一个get函数,get函数有两个参数,第一个参数表示我们要请求的url地址,第二个参数是我们要携带的请求参数。get函数返回一个promise对象,当axios其请求成功时resolve服务器返回值,请求失败时reject错误值。最后通过export抛出get函数
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
|
export function get(url, params){ return new Promise((resolve, reject) =>{ axios.get(url, { params: params }).then(res => { resolve(res.data); }).catch(err =>{ reject(err.data) }) });}
|
post方法:原理同get基本一样,但是要注意的是,post方法必须要使用对提交从参数对象进行序列化的操作,所以这里我们通过node的qs模块来序列化我们的参数。这个很重要,如果没有序列化操作,后台是拿不到你提交的数据的
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
|
export function post(url, params) { return new Promise((resolve, reject) => { axios.post(url, QS.stringify(params)) .then(res => { resolve(res.data); }) .catch(err =>{ reject(err.data) }) }); }
|
axios.get()方法和axios.post()在提交数据时参数的书写方式还是有区别的。区别就是,get的第二个参数是一个{},然后这个对象的params属性值是一个参数对象的。而post的第二个参数就是一个参数对象
9.7 api的统一管理
首先我们在api.js中引入我们封装的get和post方法
1 2 3 4
|
import { get, post } from './http'
|
在api.js中
1
| export const apiAddress = param => post('api/v1/users',param)
|
在我们的页面中可以这样调用我们的api接口
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
| import { apiAddress } from '@/request/api'; export default { name: 'Address', created () { this.onLoad(); }, methods: { onLoad() { apiAddress({ type: 0, sort: 1 }).then(res => { ……………… }) } } }
|
9.8 完整封装代码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
import axios from 'axios'; import QS from 'qs'; import { Toast } from 'vant'; import store from '../store/index'
if (process.env.NODE_ENV == 'development') { axios.defaults.baseURL = '/api'; } else if (process.env.NODE_ENV == 'debug') { axios.defaults.baseURL = ''; } else if (process.env.NODE_ENV == 'production') { axios.defaults.baseURL = 'http://api.123dailu.com/'; }
axios.defaults.timeout = 10000;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8';
axios.interceptors.request.use( config = > { const token = store.state.token; token && (config.headers.Authorization = token); return config; }, error = > { return Promise.error(error); })
axios.interceptors.response.use( response = > { if (response.status === 200) { return Promise.resolve(response); } else { return Promise.reject(response); } },
error = > { if (error.response.status) { switch (error.response.status) { case 401: router.replace({ path: '/login', query: { redirect: router.currentRoute.fullPath } }); break; case 403: Toast({ message: '登录过期,请重新登录', duration: 1000, forbidClick: true }); localStorage.removeItem('token'); store.commit('loginSuccess', null); setTimeout(() = > { router.replace({ path: '/login', query: { redirect: router.currentRoute.fullPath } }); }, 1000); break; case 404: Toast({ message: '网络请求不存在', duration: 1500, forbidClick: true }); break; default: Toast({ message: error.response.data.message, duration: 1500, forbidClick: true }); } return Promise.reject(error.response); } });
export function get(url, params) { return new Promise((resolve, reject) = > { axios.get(url, { params: params }).then(res = > { resolve(res.data); }). catch (err = > { reject(err.data) }) }); }
export function post(url, params) { return new Promise((resolve, reject) = > { axios.post(url, QS.stringify(params)).then(res = > { resolve(res.data); }). catch (err = > { reject(err.data) }) }); }
|