vue中axios请求的封装

36次阅读

共计 4392 个字符,预计需要花费 11 分钟才能阅读完成。

axios

Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中, 也是 vue 官方推荐使用的 http 库;封装 axios,一方面为了以后维护方便,另一方面也可以对请求进行自定义处理

安装

npm i axios

封装

我把 axios 请求封装在 http.js 中,重新把 get 请求,post 请求封装了一次

首先,引入 axios

import axios from 'axios'

设置接口请求前缀

一般我们开发都会有开发、测试、生产环境,前缀需要加以区分,我们利用 node 环境变量来作判断,

if (process.env.NODE_ENV === 'development') {axios.defaults.baseURL = 'http://dev.xxx.com'} else if (process.env.NODE_ENV === 'production') {axios.defaults.baseURL = 'http://prod.xxx.com'}

在 localhost 调试时,直接用开发地址一般都会有跨域的问题,所以我们还需要配置代理

本项目是 vue cli3 搭建的,代理配置是在 vue.config.js 文件中:

module.exports = {
  devServer: {
    proxy: {
      '/proxyApi': {
        target: 'http://dev.xxx.com',
        changeOrigin: true,
        pathRewrite: {'/proxyApi': ''}
      }
    }
  }
}

这样就成功把/proxyApi 指向了 'http://dev.xxx.com',重启服务

修改一下 http.js 中的配置

if (process.env.NODE_ENV === 'development') {axios.defaults.baseURL = '/proxyApi'} else if (process.env.NODE_ENV === 'production') {axios.defaults.baseURL = 'http://prod.xxx.com'}

拦截器

接着设置超时时间和请求头信息

axios.defaults.timeout = 10000
// 请求头信息是为 post 请求设置
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'

axios 很好用,其中之一就是它的拦截器十分强大,我们就可以为请求和响应设置拦截器,比如请求拦截器可以在每个请求里加上 token,做了统一处理后维护起来也方便,响应拦截器可以在接收到响应后先做一层操作,如根据状态码判断登录状态、授权。

// 请求拦截器
axios.interceptors.request.use(
  config => {
    // 每次发送请求之前判断是否存在 token
    // 如果存在,则统一在 http 请求的 header 都加上 token,这样后台根据 token 判断你的登录情况,此处 token 一般是用户完成登录后储存到 localstorage 里的
    token && (config.headers.Authorization = token)
    return config
  },
  error => {return Promise.error(error)
  })
// 响应拦截器
axios.interceptors.response.use(response => {
  // 如果返回的状态码为 200,说明接口请求成功,可以正常拿到数据
  // 否则的话抛出错误
  if (response.status === 200) {if (response.data.code === 511) {// 未授权调取授权接口} else if (response.data.code === 510) {// 未登录跳转登录页} else {return Promise.resolve(response)
    }
  } else {return Promise.reject(response)
  }
}, error => {
  // 我们可以在这里对异常状态作统一处理
  if (error.response.status) {
    // 处理请求失败的情况
    // 对不同返回码对相应处理
    return Promise.reject(error.response)
  }
})

get post 的封装

httpGet: 一个参数是请求的 url, 一个就携带的请求参数,返回 promise 对象

// get 请求
export function httpGet({
  url,
  params = {}}) {return new Promise((resolve, reject) => {
    axios.get(url, {params}).then((res) => {resolve(res.data)
    }).catch(err => {reject(err)
    })
  })
}

httpPost: 原理和 get 差不多,需要注意,这里多了个 data 参数,post 请求提交前需要对它进行序列号操作,这里是通过 transformRequest 做处理;另外两个参数 url,params 和 get 请求的一样;

// post 请求
export function httpPost({
  url,
  data = {},
  params = {}}) {return new Promise((resolve, reject) => {
    axios({
      url,
      method: 'post',
      transformRequest: [function (data) {
        let ret = ''
        for (let it in data) {ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&'
        }
        return ret
      }],
      // 发送的数据
      data,
      // url 参数
      params

    }).then(res => {resolve(res.data)
    })
  })
}

如何使用

我把所有的接口调用都在 api.js 文件中

先引入封装好的方法,再在要调用的接口重新封装成一个方法暴露出去

import {httpGet, httpPost} from './http'
export const getorglist = (params = {}) => httpGet({url: 'apps/api/org/list', params})

在页面中可以这样调用:

// .vue
import {getorglist} from '@/assets/js/api'

getorglist({id: 200}).then(res => {console.log(res)
})

这样可以把 api 统一管理起来,以后维护修改只需要在 api.js 文件操作即可。

完整代码

最后贴上完整代码

// http.js
import axios from 'axios'

// 环境的切换
if (process.env.NODE_ENV === 'development') {axios.defaults.baseURL = '/proxyApi'} else if (process.env.NODE_ENV === 'production') {axios.defaults.baseURL = 'http://prod.xxx.com'}

// 请求拦截器
axios.interceptors.request.use(
  config => {token && (config.headers.Authorization = token)
    return config
  },
  error => {return Promise.error(error)
  })

axios.defaults.timeout = 10000

axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'

// 响应拦截器
axios.interceptors.response.use(response => {if (response.status === 200) {if (response.data.code === 511) {// 未授权调取授权接口} else if (response.data.code === 510) {// 未登录跳转登录页} else {return Promise.resolve(response)
    }
  } else {return Promise.reject(response)
  }
}, error => {
  // 我们可以在这里对异常状态作统一处理
  if (error.response.status) {
    // 处理请求失败的情况
    // 对不同返回码对相应处理
    return Promise.reject(error.response)
  }
})

// get 请求
export function httpGet({
  url,
  params = {}}) {return new Promise((resolve, reject) => {
    axios.get(url, {params}).then((res) => {resolve(res.data)
    }).catch(err => {reject(err)
    })
  })
}

// post 请求
export function httpPost({
  url,
  data = {},
  params = {}}) {return new Promise((resolve, reject) => {
    axios({
      url,
      method: 'post',
      transformRequest: [function (data) {
        let ret = ''
        for (let it in data) {ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&'
        }
        return ret
      }],
      // 发送的数据
      data,
      // url 参数
      params

    }).then(res => {resolve(res.data)
    })
  })
}
// api.js
import {httpGet, httpPost} from './http'
export const getorglist = (params = {}) => httpGet({url: 'apps/api/org/list', params})

export const save = (data) => {
  return httpPost({
    url: 'apps/wechat/api/save_member',
    data
  })
}
// .vue
<script>
import {getorglist} from '@/assets/js/api'
export default {
  name: 'upload-card',
  data() {},
  mounted() {getorglist({ id: 200}).then(res => {// console.log(res)
    })
  },
}
</script>

正文完
 0

vue中axios请求的封装

36次阅读

共计 3295 个字符,预计需要花费 9 分钟才能阅读完成。

1. 发送请求模块目录

2.@/api/url 中存放的是每个模块的 URL
// 商品模块 product.js
const product = {
sku: {
list: ‘/product/product/speclist’,
options: ‘/product/product/options’
}
}
export default product

// 公用请求模块 common.js
const common = {
region: {
provinces: ‘/region/region/list’,
cities: ‘/region/region/list’
},
upload: {
image: ‘/product/product/upload’
}
}
export default common

发送请求的时候只需要指定 key(sku/list),如:this.$ajax(‘sku/list’, param);假定 axios 设置的 baseURL 是 http://prod.storm.com/api/,那么最终的请求地址:http://prod.storm.com/api/pro…
3.requireURLs.js
使用 webpack 提供的 require.context 将 src/api/url 下后缀为 js 的所有文件引入,并整理出一个对象。
let urls = {}
const req = require.context(‘./url’, false, /\.js$/)

const requireAll = requireContext => requireContext.keys().map(i => {
let url = requireContext(i)
Object.assign(urls, url.default)
})
requireAll(req)
export default urls
整合 common.js & product.js,最终得到的对象如下:
urls = {
sku: {
list: ‘/product/product/speclist’,
options: ‘/product/product/options’
},
region: {
provinces: ‘/region/region/list’,
cities: ‘/region/region/list’
},
upload: {
image: ‘/product/product/upload’
}
}

4.ajax.js
import axios from ‘axios’
import qs from ‘qs’
import jsd from ‘js-file-download’
import store from ‘@/store’
import urlObj from ‘./requireURLs’
import {Message, MessageBox} from ‘element-ui’
import {getToken} from ‘@/utils/auth’

const service = axios.create({
baseURL: `${process.env.BASE_API}/api/`, // 不同环境(dev/prod/test)使用不同的 baseURL
timeout: 5000
})
service.interceptors.request.use(
config => {
// 上传文件时,config.data 的数据类型是 FormData,
// qs.stringify(FormData) 的结果是空字符串,导致报出上传文件为空的错误
if (config.method === ‘post’ && config.data.constructor !== FormData) {
config.data = qs.stringify(config.data)
}
if (store.getters.token) {
config.headers.common[‘Auth-Token’] = getToken()
// Auth-Token 登录过期后,重新登录不传 token
if (!config.headers.common[‘Auth-Token’]) {
delete config.headers.common[‘Auth-Token’]
}
}
return config
},
error => {
Promise.reject(error)
}
)
service.interceptors.response.use(
response => {
const res = response.data
if (response.headers[‘content-type’].indexOf(‘application/vnd.ms-excel’) !== -1) {
let fileName = response.headers[‘content-disposition’].split(‘=’)[1]
jsd(res, fileName)
return
}
if (res.code === 0) {// 和后台约定 code:0 代表请求成功
return res
} else {
if (res.code === 18500) {// 和后台约定 code:18500 代表 token 未过期,但是被更新了
handleLogin(‘ 您已被登出,请重新登录 ’)
} else if (res.code === 18501) {// 和后台约定 code:18500 代表 token 过期
handleLogin(‘ 登录已失效,请重新登录 ’)
} else {
// 统一处理接口的报错信息,如果需要具体到页面去处理,可以和后台另外约定一个 code
Message({
message: res.msg,
type: ‘error’,
duration: 3 * 1000
})
}
return Promise.reject(res)
}
},
error => {
console.log(‘err ‘ + error)
let data = error.response.data
Message({
message: data.msg,
type: ‘error’,
duration: 3 * 1000
})
return Promise.reject(data)
}
)

const handleLogin = title => {
MessageBox.confirm(title, ‘ 提示 ’, {
confirmButtonText: ‘ 重新登录 ’,
showCancelButton: false,
showClose: false,
type: ‘warning’
}).then(() => {
store.dispatch(‘FedLogout’).then(() => {
location.reload()
})
})
}

const ajax = (path, data = {}, options = {}) => {
let url = path.indexOf(‘http’) === -1 ? path.split(‘/’).reduce((o, k) => {
return o[k]
}, urlObj) : path
let method = options.method || ‘post’
let params = {url, method}

if (options.method === ‘get’) {
Object.assign(params, { params: data}, options)
} else {
Object.assign(params, { data}, options)
}
return service(params)
}

export default ajax

5. 在 src/plugins 中创建一个 ajaxPlugin.js,并在 src/main.js 中引用
// ajaxPlugin.js
import ajax from ‘@/api/ajax’

let ajaxPlugin = {}

ajaxPlugin.install = Vue => {
Vue.prototype.$ajax = ajax
}

export default ajaxPlugin

// main.js
import ajaxPlugin from ‘@/plugins/ajaxPlugin’

Vue.use(ajaxPlugin)

6. 发送请求:
this.$ajax(‘sku/list’).then(res => {})

正文完
 0