vue.cli项目封装全局axios，封装请求，封装公共的api和调用请求的全过程

时间 2020-02-09 标签 vue.cli vue cli 项目封装全局 axios 请求公共 api 调用全过程

前言

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

正文

vue项目的前期配置

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

npm i axios -S

//main.js
import axios from "axios";

封装axios实例 —— request.js

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

/**** 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等
   // const token = getCookie('名称');注意使用的时候须要引入cookie方法，推荐js-cookie
   config.data = JSON.stringify(config.data);
   config.headers = {
     'Content-Type':'application/x-www-form-urlencoded'
   }
   // if(token){
   // config.params = {'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(err.message)
  /***** 处理结束 *****/
  //若是不须要错误处理，以上的处理过程均可省略
  return Promise.resolve(error.response)
})
//4.导入文件
export default service

封装请求

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

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

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

封装API，用于发送请求

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

写法一：适合分类导出webpack

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

写法二：使用所有导出ios

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，用来调用请求。
咱们看下以前遗留的一个问题：web

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

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

配置config文件中的地址

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

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
  },

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

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

如何在vue文件中调用

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

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

  methods: {
      //promise调用，链式调用
      // 不传参
      getList() {
        getListAPI().then(res => console.log(res)).catch(err => console.log(err))
      },
		//传参
      getList(formData) {
        let data = formData
        getListAPI(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就完事了。。。

若是本文对你有帮助的话，请不要忘记给我点赞打call哦~o(￣▽￣)ｄo
有其余问题留言 over~