python封装api给vue_Vue axios api统一管理的封装
axios的封装首先在项目的src目录中,新建一个request文件夹,而后在里面新建一个http.js。http.js文件用来封装咱们的axios。vuehttp.js中axios封装的优化,先直接贴代码: 1.设置请求超时 2.post请求头的设置 3.请求拦截 4.响应的拦截 5.封装get方法和post方法python建立axios实例设置请求超时请求拦截器响应的拦截请求失败后的错误统一处
axios的封装
首先在项目的src目录中,新建一个request文件夹,而后在里面新建一个http.js。http.js文件用来封装咱们的axios。vue
http.js中axios封装的优化,先直接贴代码: 1.设置请求超时 2.post请求头的设置 3.请求拦截 4.响应的拦截 5.封装get方法和post方法python
建立axios实例
设置请求超时
请求拦截器
响应的拦截
请求失败后的错误统一处理
跳转登陆页
提示函数
看项目需求 本身能够修改添加ios
/**
* axios封装
* 请求拦截、响应拦截、错误统一处理
*/
import axios from 'axios';
import router from '../router';
import store from '../store/index';
import { Toast } from 'vant';
/**
* 提示函数
* 禁止点击蒙层、显示一秒后关闭
*/
const tip = msg => {
Toast({
message: msg,
duration: 1000,
forbidClick: true
});
}
/**
* 跳转登陆页
* 携带当前页面路由,以期在登陆页面完成登陆后返回当前页面
*/
const toLogin = () => {
router.replace({
path: '/login',
query: {
redirect: router.currentRoute.fullPath
}
});
}
/**
* 请求失败后的错误统一处理
* @param {Number} status 请求失败的状态码
*/
const errorHandle = (status, other) => {
// 状态码判断
switch (status) {
// 401: 未登陆状态,跳转登陆页
case 401:
toLogin();
break;
// 403 token过时
// 清除token并跳转登陆页
case 403:
tip('登陆过时,请从新登陆');
localStorage.removeItem('token');
store.commit('loginSuccess', null);
setTimeout(() => {
toLogin();
}, 1000);
break;
// 404请求不存在
case 404:
tip('请求的资源不存在');
break;
default:
console.log(other);
}}
// 建立axios实例
var instance = axios.create({ timeout: 1000 * 12});
// 设置post请求头
instance.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
/**
* 请求拦截器
* 每次请求前,若是存在token则在请求头中携带token
*/
instance.interceptors.request.use(
config => {
// 登陆流程控制中,根据本地是否存在token判断用户的登陆状况
// 可是即便token存在,也有可能token是过时的,因此在每次的请求头中携带token
// 后台根据携带的token判断用户的登陆状况,并返回给咱们对应的状态码
// 然后咱们能够在响应拦截器中,根据状态码进行一些统一的操做。
const token = store.state.token;
token && (config.headers.Authorization = token);
return config;
},
error => Promise.error(error))
// 响应拦截器
instance.interceptors.response.use(
// 请求成功
res => res.status === 200 ? Promise.resolve(res) : Promise.reject(res),
// 请求失败
error => {
const { response } = error;
if (response) {
// 请求已发出,可是不在2xx的范围
errorHandle(response.status, response.data.message);
return Promise.reject(response);
} else {
// 处理断网的状况
// eg:请求超时或断网时,更新state的network状态
// network状态在app.vue中控制着一个全局的断网提示组件的显示隐藏
// 关于断网组件中的刷新从新获取数据,会在断网组件中说明
if (!window.navigator.onLine) {
store.commit('changeNetwork', false);
} else {
return Promise.reject(error);
}
}
});
//最后暴露出去
export default instance;
复制代码
axios api接口的封装
一个api文件夹,里面有一个index.js和一个base.js,以及多个根据模块划分的接口js文件。index.js是一个api的出口,base.js管理接口域名,其余js则用来管理各个模块的接口。vuex
先放index.js代码:axios
/**
* api接口的统一出口
*/
// 文章模块接口
import article from '@/api/article';
// 其余模块的接口……
// 导出接口
export default {
article,
// ……
}
复制代码
index.js是一个api接口的出口,这样就能够把api接口根据功能划分为多个模块,利于多人协做开发,好比一我的只负责一个模块的开发等,还能方便每一个模块中接口的命名哦。api
base.js:restful
/**
* 接口域名的管理
*/
const base = {
sq: 'https://xxxx111111.com/api/v1',
bd: 'http://xxxxx22222.com/api'
}
export default base;
复制代码
经过base.js来管理咱们的接口域名,无论有多少个均可以经过这里进行接口的定义。即便修改起来,也是很方便的。app
最后就是接口模块的说明,例如上面的article.js:函数
/**
* article模块接口列表
*/
import base from './base'; // 导入接口域名列表
import axios from '@/utils/http'; // 导入http中建立的axios实例
import qs from 'qs'; // 根据需求是否导入qs模块
const article = {
// 新闻列表
articleList () {
return axios.get(`${base.sq}/topics`);
},
// 新闻详情,演示
articleDetail (id, params) {
return axios.get(`${base.sq}/topic/${id}`, {
params: params
});
},
// post提交
login (params) {
return axios.post(`${base.sq}/accesstoken`, qs.stringify(params));
}
// 其余接口…………
}
export default article;
复制代码
1.经过直接引入咱们封装好的axios实例,而后定义接口、调用axios实例并返回,能够更灵活的使用axios,好比你能够对post请求时提交的数据进行一个qs序列化的处理等。post
2.请求的配置更灵活,你能够针对某个需求进行一个不一样的配置。关于配置的优先级,axios文档说的很清楚,这个顺序是:在 lib/defaults.js 找到的库的默认值,而后是实例的 defaults 属性,最后是请求的 config 参数。后者将优先于前者。
3.restful风格的接口,也能够经过这种方式灵活的设置api接口地址。最后,为了方便api的调用,咱们须要将其挂载到vue的原型上。在main.js中:
import Vue from 'vue'
import App from './App'
import router from './router' // 导入路由文件
import store from './store' // 导入vuex文件
import api from './api' // 导入api接口
Vue.prototype.$api = api; // 将api挂载到vue的原型上
复制代码
而后咱们能够在页面中这样调用接口
methods: {
onLoad(id) {
this.$api.article.articleDetail(id, {
api: 123
}).then(res=> {
// 执行某些操做
})
}
}
复制代码
欢迎你们来看看。
ps:有借鉴,嘻嘻。。。
更多推荐
所有评论(0)