在vue中封装详细的axios,下载方法以及对接口的管理

多看书少吃饭

已于 2022-09-22 09:19:22 修改

阅读量956

点赞数

分类专栏： Vue2 axios 文章标签： vue.js 前端

于 2022-05-17 14:10:08 首次发布

本文链接：https://blog.csdn.net/weixin_56818823/article/details/124684372

版权

Vue2 同时被 2 个专栏收录

39 篇文章 4 订阅

订阅专栏

axios

3 篇文章 0 订阅

订阅专栏

axios的安装

npm install axios

axios的引入,新建一个request.js文件

import axios from 'axios'
import { Notification, MessageBox, Message, Loading } from 'element-ui'
import store from '@/store'
import { getToken } from '@/utils/auth'
import errorCode from '@/utils/errorCode'
import { tansParams, blobValidate } from "@/utils/ruoyi";
import cache from '@/plugins/cache'
import { saveAs } from 'file-saver'
import Cookies from 'js-cookie'

let downloadLoadingInstance;
// 是否显示重新登录
export let isRelogin = { show: false };

axios.defaults.headers['Content-Type'] = 'application/json;charset=utf-8'
// 对应国际化资源文件后缀
axios.defaults.headers['Content-Language'] = 'zh_CN'
// 创建axios实例
const service = axios.create({
  // axios中请求配置有baseURL选项，表示请求URL公共部分
  baseURL: process.env.VUE_APP_BASE_API,
  // 超时
  timeout: 10000
})

// request拦截器
service.interceptors.request.use(config => {
  // 是否需要设置 token
  const isToken = (config.headers || {}).isToken === false
  // 是否需要防止数据重复提交
  const isRepeatSubmit = (config.headers || {}).repeatSubmit === false
  if (getToken() && !isToken) {
    config.headers['Authorization'] = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改
  }
  // get请求映射params参数
  if (config.method === 'get' && config.params) {
    let url = config.url + '?' + tansParams(config.params);
    url = url.slice(0, -1);
    config.params = {};
    config.url = url;
  }
  if (!isRepeatSubmit && (config.method === 'post' || config.method === 'put')) {
    const requestObj = {
      url: config.url,
      data: typeof config.data === 'object' ? JSON.stringify(config.data) : config.data,
      time: new Date().getTime()
    }
    const sessionObj = cache.session.getJSON('sessionObj')
    if (sessionObj === undefined || sessionObj === null || sessionObj === '') {
      cache.session.setJSON('sessionObj', requestObj)
    } else {
      const s_url = sessionObj.url;                  // 请求地址
      const s_data = sessionObj.data;                // 请求数据
      const s_time = sessionObj.time;                // 请求时间
      const interval = 1000;                         // 间隔时间(ms)，小于此时间视为重复提交
      if (s_data === requestObj.data && requestObj.time - s_time < interval && s_url === requestObj.url) {
        const message = '数据正在处理，请勿重复提交';
        console.warn(`[${s_url}]: ` + message)
        return Promise.reject(new Error(message))
      } else {
        cache.session.setJSON('sessionObj', requestObj)
      }
    }
  }
  return config
}, error => {
  console.log(error)
  Promise.reject(error)
})

// 响应拦截器
service.interceptors.response.use(res => {
  // 未设置状态码则默认成功状态
  const code = res.data.code || 200;
  // 获取错误信息
  const msg = errorCode[code] || res.data.msg || errorCode['default']
  // 二进制数据则直接返回
  if (res.request.responseType === 'blob' || res.request.responseType === 'arraybuffer') {
    return res.data
  }
  if (code === 401) {
    if (!isRelogin.show && window.location.href.indexOf("redirect") < 0) {
      isRelogin.show = true;
      MessageBox.confirm('登录状态已过期，您可以继续留在该页面，或者重新登录', '系统提示', {
        confirmButtonText: '重新登录',
        cancelButtonText: '取消',
        type: 'warning'
      }
      ).then(() => {
        isRelogin.show = false;
        store.dispatch('LogOut').then(() => {
          location.href = process.env.VUE_APP_CONTEXT_PATH + 'index'
        })
      }).catch(() => {
        isRelogin.show = false;
      });
    }
    return Promise.reject('无效的会话，或者会话已过期，请重新登录。')
  } else if (code === 500) {
    Message({
      message: msg,
      type: 'error'
    })
    return Promise.reject(new Error(msg))
  } else if (code !== 200) {
    Notification.error({
      title: msg
    })
    return Promise.reject('error')
  } else {
    return res.data
  }
},
  error => {
    console.log('err' + error)
    let { message } = error;
    if (message == "Network Error") {
      message = "后端接口连接异常";
    }
    else if (message.includes("timeout")) {
      message = "系统接口请求超时";
    }
    else if (message.includes("Request failed with status code")) {
      message = "系统接口" + message.substr(message.length - 3) + "异常";
    }
    Message({
      message: message,
      type: 'error',
      duration: 5 * 1000
    })
    return Promise.reject(error)
  }
)

// 通用下载方法
export function download(url, params, filename) {
  downloadLoadingInstance = Loading.service({ text: "正在下载数据，请稍候", spinner: "el-icon-loading", background: "rgba(0, 0, 0, 0.7)", })
  return service.post(url, params, {
    transformRequest: [(params) => { return tansParams(params) }],
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
    responseType: 'blob'
  }).then(async (data) => {
    const isLogin = await blobValidate(data);
    if (isLogin) {
      const blob = new Blob([data])
      saveAs(blob, filename)
    } else {
      const resText = await data.text();
      const rspObj = JSON.parse(resText);
      const errMsg = errorCode[rspObj.code] || rspObj.msg || errorCode['default']
      Message.error(errMsg);
    }
    downloadLoadingInstance.close();
  }).catch((r) => {
    console.error(r)
    Message.error('下载文件出现错误，请联系管理员！')
    downloadLoadingInstance.close();
  })
}

export default service

然后在项目目录创建一个.env.development文件,文件配置如下

ENV = 'development'

# 接口地址，注意协议，如果你没有配置 ssl，需要将 https 改为 http

#上线
#VUE_APP_BASE_API = 'http://212.222.38.178:9091'
#测试
VUE_APP_BASE_API = 'http://193.16822.98.33:9091'


VUE_APP_AUTO_API = 'http://193.168.98.32:8081'


# 是否启用 babel-plugin-dynamic-import-node插件
VUE_CLI_BABEL_TRANSPILE_MODULES = true

配置完成以后,就可以在src目录下创建api文件夹,这里就是存放各种接口方法的地方,比如我创建了一个baseInfo文件夹,在这个文件夹中有一个workoerMng.js文件,文件中有以下几个接口

import request from '../../request'

//列表接口
export function getList(params) {
	return request({
		url: '/cFaultBill/page',
		method: 'get',
		params
	})
}
//获取设备
export function getSheBei(params) {
	return request({
		url: '/cdevice/getNotSyncList',
		method: 'get',
		params
	})
}

//编辑
export function faultBillEdit(data) {
	return request({
		url: '/cFaultBill/edit',
		method: 'post',
		data
	})
}

export function getOptions(params) {
	return request({
		url: '/faultType/getFaultType',
		method: 'get',
		params
	})
}
// 添加
export function deviceAdd(data) {
	return request({
		url: '/cFaultBill/save',
		method: 'post',
		data
	})
}
//删除
export function deviceDel(id) {
	console.log('删除的id', id)
	return request({
		url: `/cFaultBill/delete?id=${id}`,
		method: 'get',
		// params: {
		// 	id: id
		// }
	})
}

当我们需要调用这些接口的时候,用起来也非常方便,比如我们页面创建时候,需要获取页面的不分页数据,那么直接用以下的方法直接调用就可以获取数据

    initData() {
      getList(this.listQuery).then((res) => {
        console.log("提交的form数据", res);
        this.tableData = res.records;//表格数据消息
        this.count = res.total;//一共多少条数据
      });
    },

如果需要向服务器发起增加数据的请求,直接调用增加的请求接口然后传递增加的数据,这是非常便捷的

deviceAdd(this.specsForm)
            .then((res) => {
              // this.$message({
              //   type: "success",
              //   message: "新增成功!",
              // });
              this.btnLoading = false;
              this.dialogFormVisible = false;
              this.initData();
            })
            .catch((err) => {
              console.log(err);
              this.btnLoading = false;
            });
        }

封装axios是非常必要的,这样有助于我们对于代码的维护,而且大大减少了我们的代码量,一次封装,团队可以永久使用