axios的封装(保姆级别)

文章目录

• • 安装
  • api的统一管理

    安装

  打开编译器终端通过 npm install axios; 通过npm命令安装，也可以通过yarn (看自己习惯)

  1.引用：

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

  // 在http.js中引入axiosimport axios from 'axios'; // 引入axiosimport QS from 'qs'; // 引入qs模块，用来序列化post类型的数据，后面会提到// vant的toast提示框组件，大家可根据自己的ui组件更改。import { Toast } from 'vant';  // 环境的切换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';}设置请求超时通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s，就会告知用户当前请求超时，请刷新等。 axios.defaults.timeout = 10000;post请求的时候，我们需要加上一个请求头，所以可以在这里进行一个默认的设置，即设置post的请求头为application/x-www-form-urlencoded;charset=UTF-8请求头可以按照自己的需求进行修改，例如上传文件的时候就需要修改请求头。 axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8';请求拦截（可以到axios官网，具有更加详细的介绍）有些请求是需要用户登录之后才能访问的，或者post请求的时候，我们需要序列化我们提交的数据。这时候，我们可以在请求被发送之前进行一个拦截，从而进行我们想要的操作。 请求拦截// 先导入vuex,因为我们要使用到里面的状态对象（现在vue3的出现vuex不在维护，使用pina更加的方便，看自己的需求）// vuex的路径根据自己的路径去写import store from '@/store/index'; // 请求拦截器axios.interceptors.request.use(        config => {                // 每次发送请求之前判断vuex中是否存在token                // 如果存在，则统一在http请求的header都加上token，这样后台根据token判断你的登录情况        // 即使本地存在token，也有可能token是过期的，所以在响应拦截器中要对返回状态进行判断         const token = store.state.token;                token && (config.headers.Authorization = token);                return config;        },        error => {                return Promise.error(error);    })这里说一下token，一般是在登录完成之后，将用户的token通过localStorage或者cookie存在本地，然后用户每次在进入页面的时候（即在main.js中），会首先从本地存储中读取token，如果token存在说明用户已经登陆过，则更新vuex中的token状态。然后，在每次请求接口的时候，都会在请求的header中携带token，后台人员就可以根据你携带的token来判断你的登录是否过期，如果没有携带，则说明没有登录过。 // 响应拦截器响应拦截器就是服务器返回给我们的数据，我们在拿到之前可以对他进行一些处理，后台返回的状态码是200，则正常返回数据，否则的根据错误的状态码类型进行一些我们需要的错误，其实这里主要就是进行了错误的统一处理和没登录或登录过期后调整登录页的一个操作。axios.interceptors.response.use(        response => {           // 如果返回的状态码为200，说明接口请求成功，可以正常拿到数据             // 否则的话抛出错误        if (response.status === 200) {                        return Promise.resolve(response);                } else {                        return Promise.reject(response);                }        },        // 服务器状态码不是2开头的的情况    // 然后根据返回的状态码进行一些操作，例如登录过期提示，错误提示等等    error => {                    if (error.response.status) {                        switch (error.response.status) {                                // 401: 未登录                // 未登录则跳转登录页面，并携带当前页面的路径                // 在登录成功后返回当前页面，这一步需要在登录页操作。                                case 401:                                        router.replace({                                                path: '/login',                                                query: {                             redirect: router.currentRoute.fullPath                         }                    });                    break;                 // 403 token过期                // 登录过期对用户进行提示                // 清除本地token和清空vuex中token对象                // 跳转登录页面                                case 403:                     Toast({                        message: '登录过期，请重新登录',                        duration: 1000,                        forbidClick: true                    });                    // 清除token                    localStorage.removeItem('token');                    store.commit('loginSuccess', null);                    // 跳转登录页面，并将要浏览的页面fullPath传过去，登录成功后跳转需要访问的页面                     setTimeout(() => {                                                router.replace({                                                        path: '/login',                                                        query: {                                 redirect: router.currentRoute.fullPath                             }                                                });                                        }, 1000);                                        break;                  // 404请求不存在                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);        }    }    });

  2.封装get方法和post方法 

  get请求和post请求的区别：

  1. 参数传递方式：GET请求将参数包含在URL中，即在URL的末尾使用问号（?）将参数和参数值连接起来，多个参数之间使用&符号分隔。而POST请求将参数放在请求体中，不会显示在URL上。

  2. 参数大小限制：由于GET请求的参数是包含在URL中的，URL长度是有限制的，不同的浏览器和服务器对URL长度的限制不同，通常浏览器会限制在2048个字符以内。而POST请求的参数是放在请求体中的，没有URL长度的限制。

  3. 安全性：GET请求的参数会显示在URL中，因此参数是以明文形式传递的，比较不安全，例如登录时，用户名和密码以明文形式显示在URL中，容易被截获。而POST请求的参数在请求体中，相对于GET请求更安全，不会直接显示在URL上。

  4. 幂等性：GET请求是幂等的，也就是说对同一个URL多次请求会返回同样的结果。而POST请求不是幂等的，多次请求会对服务器产生不同的副作用。

  get请求：get函数有两个参数，第一个参数请求的url地址，第二个参数是携带的请求参数。get函数返回一个promise对象，当axios其请求成功时resolve服务器返回 值，请求失败时reject错误值。

  ** * 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);        })});}

  post方法：POST请求适用于参数较多，安全性要求较高，不幂等的场景，如提交表单、发送数据等。

  /**  * 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);        })    });}

  api的统一管理完整代码

  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; // post请求头axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'; // 请求拦截器axios.interceptors.request.use(        config => {        // 每次发送请求之前判断是否存在token，如果存在，则统一在http请求的header都加上token，不用每次请求都手动添加了        // 即使本地存在token，也有可能token是过期的，所以在响应拦截器中要对返回状态进行判断        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);                }        },    // 服务器状态码不是200的情况        error => {                if (error.response.status) {                        switch (error.response.status) {                                // 401: 未登录                                // 未登录则跳转登录页面，并携带当前页面的路径                                // 在登录成功后返回当前页面，这一步需要在登录页操作。                                case 401:                                        router.replace({                                                path: '/login',                                                query: { redirect: router.currentRoute.fullPath }                     });                    break;                // 403 token过期                                // 登录过期对用户进行提示                                // 清除本地token和清空vuex中token对象                                // 跳转登录页面                                case 403:                                         Toast({                                                message: '登录过期，请重新登录',                                                duration: 1000,                                                forbidClick: true                                        });                                        // 清除token                                        localStorage.removeItem('token');                                        store.commit('loginSuccess', null);                                        // 跳转登录页面，并将要浏览的页面fullPath传过去，登录成功后跳转需要访问的页面                    setTimeout(() => {                                                router.replace({                                                        path: '/login',                                                        query: {                                 redirect: router.currentRoute.fullPath                             }                                                });                                        }, 1000);                                        break;                 // 404请求不存在                                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);                }           });/**  * 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);                })            });}/**  * 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);                })            });}