axios 封装 (转)

最新推荐文章于 2024-02-24 23:52:30 发布

dog_m

最新推荐文章于 2024-02-24 23:52:30 发布

阅读量529

点赞数 1

分类专栏： axios

原文链接：https://blog.csdn.net/weixin_43216105/article/details/98877960

版权

axios 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

这里写目录标题

转载地址
前言
正文
结语

转载地址

本文转自:
[https://blog.csdn.net/weixin_43216105/article/details/98877960]

前言

在做vue中大型项目的时候，官方推荐使用axios，但是原生的axios可能对项目的适配不友好，所以，在工程开始的来封装一下axios，保持全项目数据处理的统一性。此文主要讲在vue-cil项目中如何封装axios，封装请求，封装公共的api，页面如何调用请求。

正文

一、vue项目的前期配置

新建vue项目，下载axios，并在main.js中导入axios

npm i axios -S

//main.js
import axios from 'axios'

二、配置config文件中的代理地址

在项目config目录下的修改 index.js文件，这里是主要书写配置多个后台接口。

vue cil2旧版本的代理配置——config/index.js

 dev: {
    // Paths
    assetsSubDirectory: 'static',
    assetsPublicPath: '/',
    // 后端请求地址代理，配置后testIp再之后的页面调用时就直接指代 http://197.82.15.15:8088
    proxyTable: {
      '/testIp': {
        target: 'http://197.82.15.15:8088',
        changeOrigin: true,
        pathRewrite: { 
          '^/testIp': ''
        }
      },
      '/elseIp': {
        target: 'http://182.83.19.15:8080',
        changeOrigin: true,
        pathRewrite: { 
          '^/esleIp': ''
        }
      },
    },

    // Various Dev Server settings
    host: 'localhost', // can be overwritten by process.env.HOST
    port: 8080, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined
    autoOpenBrowser: false,
    errorOverlay: true,
    notifyOnErrors: true,
    poll: false, // https://webpack.js.org/configuration/dev-server/#devserver-watchoptions-


    /**
     * Source Maps
     */

    // https://webpack.js.org/configuration/devtool/#development
    devtool: 'cheap-module-eval-source-map',

    // If you have problems debugging vue-files in devtools,
    // set this to false - it *may* help
    // https://vue-loader.vuejs.org/en/options.html#cachebusting
    cacheBusting: true,

    cssSourceMap: true
  }

vuecil 3+ 新版本的代理配置–vue.config.js 文件
关于多代理配置：

devServer: {
         overlay: { // 让浏览器 overlay 同时显示警告和错误
           warnings: true,
           errors: true
         },
         host: "localhost",
         port: 8080, // 端口号
         https: false, // https:{type:Boolean}
         open: false, //配置后自动启动浏览器
         hotOnly: true, // 热更新
         // proxy: 'http://localhost:8080'   // 配置跨域处理,只有一个代理
         proxy: { //配置多个代理
             "/testIp": {
                 target: "http://197.0.0.1:8088",
                 changeOrigin: true,
                 ws: true,//websocket支持
                 secure: false,
                 pathRewrite: {
                     "^/testIp": "/"
                 }
             },
             "/elseIp": {
                 target: "http://197.0.0.2:8088",
                 changeOrigin: true,
                 //ws: true,//websocket支持
                 secure: false,
                 pathRewrite: {
                     "^/elseIp": "/"
                 }
             },
         }
     }

如果有多后台，就可以在api文件夹下另外新建一个elseApi.js ，书写当前ip下的接口请求。方法同上，只是 let resquest = “/elseIp/request/” 调用的时候把端口更改一下。

三、封装axios实例 —— request.js

在项目src目录下新建utils文件夹，然后在其中新建 request.js文件，这个文件是主要书写axios的封装过程。

/****   request.js   ****/
// 导入axios
import axios from 'axios'
// 使用element-ui Message做消息提醒
import { Message} from 'element-ui';
//1. 创建新的axios实例，
const service = axios.create({
  // 公共接口--这里注意后面会讲
  baseURL: process.env.BASE_API,
  // 超时时间 单位是ms，这里设置了3s的超时时间
  timeout: 3 * 1000
})
// 2.请求拦截器
service.interceptors.request.use(config => {
  //发请求前做的一些处理，数据转化，配置请求头，设置token,设置loading等，根据需求去添加
   config.data = JSON.stringify(config.data); //数据转化,也可以使用qs转换
   config.headers = {
     'Content-Type':'application/x-www-form-urlencoded' //配置请求头
   }
   //注意使用token的时候需要引入cookie方法或者用本地localStorage等方法，推荐js-cookie
   const token = getCookie('名称');//这里取token之前，你肯定需要先拿到token,存一下
   if(token){
      config.params = {'token':token} //如果要求携带在参数中
      config.headers.token= token; //如果要求携带在请求头中
    }
  return config
}, error => {
  Promise.reject(error)
})

// 3.响应拦截器
service.interceptors.response.use(response => {
  //接收到响应数据并成功后的一些共有的处理，关闭loading等
  
  return response
}, error => {
   /***** 接收到异常响应的处理开始 *****/
  if (error && error.response) {
    // 1.公共错误处理
    // 2.根据响应码具体处理
    switch (error.response.status) {
      case 400:
        error.message = '错误请求'
        break;
      case 401:
        error.message = '未授权，请重新登录'
        break;
      case 403:
        error.message = '拒绝访问'
        break;
      case 404:
        error.message = '请求错误,未找到该资源'
        window.location.href = "/NotFound"
        break;
      case 405:
        error.message = '请求方法未允许'
        break;
      case 408:
        error.message = '请求超时'
        break;
      case 500:
        error.message = '服务器端出错'
        break;
      case 501:
        error.message = '网络未实现'
        break;
      case 502:
        error.message = '网络错误'
        break;
      case 503:
        error.message = '服务不可用'
        break;
      case 504:
        error.message = '网络超时'
        break;
      case 505:
        error.message = 'http版本不支持该请求'
        break;
      default:
        error.message = `连接错误${error.response.status}`
    }
  } else {
    // 超时处理
    if (JSON.stringify(error).includes('timeout')) {
      Message.error('服务器响应超时，请刷新当前页')
    }
    error.message = '连接服务器失败'
  }

  Message.error(error.message)
  /***** 处理结束 *****/
  //如果不需要错误处理，以上的处理过程都可省略
  return Promise.resolve(error.response)
})
//4.导入文件
export default service

四、封装请求——http.js

在项目src目录下的utils文件夹中新建 http.js文件，这个文件是主要书写几种请求的封装过程。

/****   http.js   ****/
// 导入封装好的axios实例
import request from './request'

const http ={
    /**
     * methods: 请求
     * @param url 请求地址 
     * @param params 请求参数
     */
    get(url,params){
        const config = {
            method: 'get',
            url:url
        }
        if(params) config.params = params
        return request(config)
    },
    post(url,params){
        const config = {
            method: 'post',
            url:url
        }
        if(params) config.data = params
        return request(config)
    },
    put(url,params){
        const config = {
            method: 'put',
            url:url
        }
        if(params) config.params = params
        return request(config)
    },
    delete(url,params){
        const config = {
            method: 'delete',
            url:url
        }
        if(params) config.params = params
        return request(config)
    }
}
//导出
export default http

五、正式封装API，用于发送请求——api.js

在项目src目录下新建api文件夹，然后在其中新建 api.js文件，这个文件是主要书写API的封装过程。

写法一：适合分类导出

import http from '../utils/http'
// 
/**
 *  @parms resquest 请求地址 例如：http://197.82.15.15:8088/request/...
 *  @param '/testIp'代表vue-cil中config，index.js中配置的代理
 */
let resquest = "/testIp/request/"

// get请求
export function getListAPI(params){
    return http.get(`${resquest}/getList.json`,params)
}
// post请求
export function postFormAPI(params){
    return http.post(`${resquest}/postForm.json`,params)
}
// put 请求
export function putSomeAPI(params){
    return http.put(`${resquest}/putSome.json`,params)
}
// delete 请求
export function deleteListAPI(params){
    return http.delete(`${resquest}/deleteList.json`,params)
}

写法二：使用全部导出

import http from '../utils/http'
// 
/**
 *  @parms resquest 请求地址 例如：http://197.82.15.15:8088/request/...
 *  @param '/testIp'代表vue-cil中config，index.js中配置的代理
 */
let resquest = "/testIp/request/"

// get请求
export default{
 	getListAPI(params){
    	return http.get(`${resquest}/getList.json`,params)
	},
	 postFormAPI(params){
    	return http.post(`${resquest}/postForm.json`,params)
	}
}

注意：一个项目中如果后台请求不是同一个ip，而是多个ip的时候，可以在api文件夹下建立多个js，用来调用请求。
我们看下之前遗留的一个问题：

//创建新的axios实例，
const service = axios.create({
  baseURL: process.env.BASE_API,
  timeout: 3 * 1000
})

在之前封装公共接口的baseUrl时候，用了webpack中的全局变量process.env.BASE_API，而不是直接写死ip，也是为了适应多个后台或者开发的时候的api地址和发布的时候的api地址不一样这种情况。

以上关于配置环境和接口基本搭建完毕，下面看一下调用：

六、如何在vue文件中调用

方法一：用到哪个api 就调用哪个接口——适用于上文接口分类导出；

import {getListAPI,postFormAPI, putSomeAPI, deleteListAPI} from '@/api/api'

methods: {
    //promise调用，链式调用， getList()括号内只接受参数；
    //   get不传参
    getList() {
      getListAPI().then(res => console.log(res)).catch(err => console.log(err))
    },
//post传参
    postForm(formData) {
      let data = formData
      postFormAPI(data).then(res => console.log(res)).catch(err => console.log(err))
    },

    //async await同步调用
    async postForm(formData) {
      const postRes = await postFormAPI(formData)
      const putRes = await putSomeAPI({data: 'putTest'})
      const deleteRes = await deleteListAPI(formData.name)
      // 数据处理
      console.log(postRes);
      console.log(putRes);
      console.log(deleteRes);
    },
 }

方法二：把api全部导入，然后用哪个调用哪个api——适用于全部导出

import api from '@/api/api'
 methods: {
   getList() {
      api.getListAPI(data).then(res => {
        //数据处理
      }).catch(err => console.log(err))
    }
  }

结语

以上就详细介绍了，在vue-cil项目中如何封装axios，封装请求，封装公共的api，配置多个接口，页面如何调用请求等问题，都是亲测有用的~ 但是这种封装方法的话，更适合大中型项目，配置比较合理，如果是自己小项目，就直接用axios就完事了

dog_m

关注

1
点赞
踩
10

收藏

觉得还不错? 一键收藏
0
评论
axios 封装 (转)

转载地址本文转自:https://blog.csdn.net/weixin_43216105/article/details/98877960?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522162314340616780264067374%2522%252C%2522scm%2522%253A%252220140713.130102334…%2522%257D&request_id=162314340616780264067374
复制链接

扫一扫