美文网首页vue让前端飞
axios封装及api接口统一定义

axios封装及api接口统一定义

作者: CRUD_科科 | 来源:发表于2018-10-11 11:30 被阅读2次

    话不多说,项目中使用axios,参考了多方大神封装代码,有了这篇文章。

    最开始的代码,main.js

    import Vue from 'vue'
    import App from './App'
    import router from './router'
    import VueCropper from 'vue-cropper'
    
    // mint ui
    import Mint from 'mint-ui'
    import 'mint-ui/lib/style.css'
    Vue.use(Mint);
    
    import { Lazyload } from 'mint-ui';
    Vue.use(Lazyload);
    
    // 设置根rem以及相关配置
    import '@/common/js/phoneConfig'
    
    import 'common/scss/index.scss'
    
    // axios
    import axios from '@/request/http.js'
    Vue.prototype.$http = axios;
    
    Vue.config.productionTip = false
    
    /* eslint-disable no-new */
    new Vue({
      el: '#app',
      router,
      components: { App },
      template: '<App/>'
    })
    

    最开始只是在main中把axios挂载到vue实例上,但是这种方法,在合作开发中并不科学,就有了下面的思考

    /**axios封装
     * 请求拦截、响应拦截、错误统一处理
     * Auther: 杨磊
     * Create date: 2018/10/10
     */
    
    import Axios from 'axios'
    import Vue from 'vue'
    
    let axios = Axios.create({
        baseURL: process.env.API_ROOT,
        timeout: 1000 * 12,
        headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
    });
    
    /** 
     * 提示函数 
     * 显示一秒后关闭
     */
    const tip = msg => {
        Vue.$toast({
            message: msg,
            duration: '1000'
        });
    }
    
    /** 
     * 跳转登录页
     * 携带当前页面路由,以期在登录页面完成登录后返回当前页面
     */
    const toLogin = () => {
        router.replace({
            path: '/',
            query: {
                redirect: router.currentRoute.fullPath
            }
        });
    }
    
    /** 
     * 请求失败后的错误统一处理 
     * @param {Number} status 请求失败的状态码
     */
    const errorHandle = (status, other) => {
        switch (status) {
            case 403:
                tip('登录过期,请重新登录');
                // 清除token
                // localStorage.removeItem('token');
                // store.commit('loginSuccess', null);
                setTimeout(() => {
                    toLogin();
                }, 1000);
                break;
            case 404:
                tip('网络请求不存在');
                break;
            default:
                tip(other);
        }
    }
    
    // 请求拦截器
    axios.interceptors.request.use(
        config => {
            // 在发送请求之前做些什么(后期在这里加上token)
            // const token = store.state.token;
            // token && (config.headers.Authorization = token);  
            Vue.$indicator.open();  
            return config;
        },
        error => {
            // 对请求错误做些什么
            return Promise.reject(error);
        }
    )
    
    // 响应拦截器
    axios.interceptors.response.use(
        // 请求成功
        (res) => {
            Vue.$indicator.open(); 
            if(res.status === 200) {
                if (res.data.code !== '0' && res.data.msg) {
                    tip(res.data.msg);
                }
                Promise.resolve(res)
            } else {
                Promise.reject(res)
            }
        },
        // 请求失败
        error => {
            const { response } = error;
            if (response) {
                // 请求已发出,但是不在200的范围 
                errorHandle(response.status, response.data.msg);
                return Promise.reject(response);
            } else {
                // 处理断网的情况
                // eg:请求超时或断网时,更新state的network状态
                // network状态在app.vue中控制着一个全局的断网提示组件的显示隐藏
                // 关于断网组件中的刷新重新获取数据,会在断网组件中说明
                // store.commit('changeNetwork', false);
            }
        }
    )
    
    export default axios;
    
    

    这样封装更加灵活,所有的接口定义在api文件夹下:

    /** 
     * api接口的统一封装
     */
    import request from '@/request/http';
    import Qs from 'qs';
    
    // 发送验证码
    export function SendVerify(query) {
        return request({
            url: 'Common/SendVerify',
            method: 'post',
            data: Qs.stringify(query)
        })
    }
    
    // 邀请码校验
    export function CheckInvitationCode(query) {
        return request({
            url: 'User/CheckInvitationCode',
            method: 'post',
            data: Qs.stringify(query)
        })
    }
    
    // 登录
    export function GetUserLogin(query) {
        return request({
            url: 'User/GetUserLogin',
            method: 'post',
            data: Qs.stringify(query)
        })
    }
    

    组件中使用方法:

    import { CheckInvitationCode } from '@/api/index.js'
    CheckInvitationCode({invitationCode: this.invitationCode}).then((response)=>{
                   console.log(response.data);
                   if(response.data.code == '0'){
                       this.$router.push({
                           name: 'verificationCode',
                           query: {
                               data: escape(JSON.stringify(response.data.data))
                           }
                       })
                   }
               }).catch((error)=>{
                   this.$indicator.close();
                   console.log(error)
               })
    

    参考文章:https://juejin.im/post/5b55c118f265da0f6f1aa354

    相关文章

      网友评论

        本文标题:axios封装及api接口统一定义

        本文链接:https://www.haomeiwen.com/subject/wsxbaftx.html