欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

vue中axios请求的封装实例代码

程序员文章站 2023-11-05 23:45:10
axios axios 是一个基于 promise 的 http 库,可以用在浏览器和 node.js 中, 也是vue官方推荐使用的http库;封装axios,一方...

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

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对的支持。