美文网首页
vue中Axios的封装和API接口的管理

vue中Axios的封装和API接口的管理

作者: 看庭前花开花落_望天上云卷云舒 | 来源:发表于2020-11-05 10:30 被阅读0次

    参考地址:https://juejin.im/post/6844903652881072141

    一、安装axios

    npm install axios; // 安装axios
    

    二、在src目录下建api 文件夹

    在项目的src目录中,新建一个api文件夹,然后在里面新建一个http.js和一个api.js文件。http.js文件用来封装我们的axios,api.js用来统一管理我们的接口。

    三、http.js文件

    引入axios 、qs、vant 等

    import axios from 'axios'; // 引入axios
    import QS from 'qs'; // 引入qs模块,用来序列化post类型的数据,后面会提到
    // vant的toast提示框组件,大家可根据自己的ui组件更改。
    import { Toast } from 'vant'; 
    

    请求超时
    通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s,就会告知用户当前请求超时,请刷新等。

    axios.defaults.timeout = 10000;
    

    post请求头的设置

    axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8';
    //请求拦截器
    //有些请求是需要用户登录之后才能访问的,或者post请求的时候,我们需要序列化我们提交的数据。这时候,我们可以在请求被发送之前进行一个拦截,从而进行我们想要的操作。
    axios.interceptors.request.use(config => {
     // 每次发送请求之前判断是否存在token        
    // 如果存在,则统一在http请求的header都加上token,这样后台根据token判断你的登录情况
    // 即使本地存在token,也有可能token是过期的,所以在响应拦截器中要对返回状态进行判断
    //我这里的token是存储到storage里的 也可以用vuex存储
        let token = '';
        if (Vue.$cookies.isKey('Token')) {
            token = Vue.$cookies.get('Token')
        }
        config.headers['JH-Token'] = token;
        return config;
    }, error => {
        return Promise.error(error);
    })
    

    这里说一下token,一般是在登录完成之后,将用户的token通过localStorage或者cookie存在本地,然后用户每次在进入页面的时候(即在main.js中),会首先从本地存储中读取token,如果token存在说明用户已经登陆过。然后,在每次请求接口的时候,都会在请求的header中携带token,后台人员就可以根据你携带的token来判断你的登录是否过期,如果没有携带,则说明没有登录过。这时候或许有些小伙伴会有疑问了,就是每个请求都携带token,那么要是一个页面不需要用户登录就可以访问的怎么办呢?其实,你前端的请求可以携带token,但是后台可以选择不接收啊!

    响应的拦截

    // 响应拦截器
    axios.interceptors.response.use(response => {
        return response.data //请求正常则返回
    }, err => {
        // 这里跟后台开发人员协商好统一的错误状态码
        if (err && err.response) {
            switch (err.response.status) {
                case 400:
                    err.message = '请求错误(400)';
                    break;
               ...
                default:
                    err.message = `连接出错(${err.response.status})!`
            }
        } else {
            console.log(err)
        }
        return Promise.reject(err)
    });
    

    响应拦截器很好理解,就是服务器返回给我们的数据,我们在拿到之前可以对他进行一些处理。例如上面的思想:如果后台返回的状态码是200,则正常返回数据,否则的根据错误的状态码类型进行一些我们需要的错误,其实这里主要就是进行了错误的统一处理和没登录或登录过期后调整登录页的一个操作。

    封装get方法和post方法
    我们常用的ajax请求方法有get、post、put等方法,相信小伙伴都不会陌生。axios对应的也有很多类似的方法,不清楚的可以看下文档。但是为了简化我们的代码,我们还是要对其进行一个简单的封装。下面我们主要封装两个方法:get和post。

    get方法:我们通过定义一个get函数,get函数有两个参数,第一个参数表示我们要请求的url地址,第二个参数是我们要携带的请求参数。get函数返回一个promise对象,当axios其请求成功时resolve服务器返回 值,请求失败时reject错误值。最后通过export抛出get函数。

    /**
     * get方法,对应get请求
     * @param {String} url [请求的url地址]
     * @param {Object} params [请求时携带的参数]
     */
    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模块来序列化我们的参数。这个很重要,如果没有序列化操作,后台是拿不到你提交的数据的。这就是文章开头我们import QS from 'qs';的原因。如果不明白序列化是什么意思的,就百度一下吧,答案一大堆。

    /** 
     * post方法,对应post请求 
     * @param {String} url [请求的url地址] 
     * @param {Object} params [请求时携带的参数] 
     */
    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)
            })
        });
    }
    
    

    四、api.js

    首先我们在api.js中引入我们封装的get和post方法

    /**   
     * api接口统一管理
     */
    import { get, post } from './http'
    

    封装接口

    export const apiAddress = p => post('api/v1/users/my_address/address_edit_before', p);
    

    我们定义了一个apiAddress方法,这个方法有一个参数p,p是我们请求接口时携带的参数对象。而后调用了我们封装的post方法,post方法的第一个参数是我们的接口地址,第二个参数是apiAddress的p参数,即请求接口时携带的参数对象。最后通过export导出apiAddress。

    在页面中调用这个接口

    import { apiAddress } from '@/request/api';// 导入我们的api接口
    export default {        
        name: 'Address',    
        created () {
            this.onLoad();
        },
        methods: {            
            // 获取数据            
            onLoad() {
                // 调用api接口,并且提供了两个参数                
                apiAddress({                    
                    type: 0,                    
                    sort: 1                
                }).then(res => {
                    // 获取数据成功后的其他操作
                    ………………                
                })            
            }        
        }
    }
    

    相关文章

      网友评论

          本文标题:vue中Axios的封装和API接口的管理

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