axios封装与api接口管理

// 在http.js中引入axios

import axios from ‘axios’; // 引入axios

import router from ‘…/router’;

// vant的toast提示框组件,大家可根据自己的ui组件更改。

import { Toast } from ‘vant’;

  1. 环境的切换

我们的项目环境可能有开发环境、测试环境和生产环境。我们通过node的环境变量来匹配我们的默认的接口url前缀。axios.defaults.baseURL可以设置axios的默认请求地址就不多说了。

创建config目录。

目录下创建env.development.js+env.production.js+env.test.js

env.development.js内容如下:

module.exports={

baseUrl:’ http://www.devele.com:4456’ //开发环境用到的baseurl

}

// 环境的切换

const {baseUrl}=require(‘…/config/env.’+process.env.NODE_ENV);

//同时 package.json的scripts需指定测试环境的模式 --mode test

“scripts”: {

“serve”: “vue-cli-service serve”,

“build”: “vue-cli-service build”,

“test”: “vue-cli-service build --mode test”,

“lint”: “vue-cli-service lint”

}

const service = axios.create({

baseURL: baseUrl, // url = base api url + request url

withCredentials: false, // send cookies when cross-domain requests

timeout: 1000*12 // 请求超时

})

4.如上 设置请求超时

通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s,就会告知用户当前请求超时,请刷新等。

  1. post请求头的设置

post请求的时候,我们需要加上一个请求头,所以可以在这里进行一个默认的设置,即设置post的请求头为application/x-www-form-urlencoded;charset=UTF-8

// 设置post请求头

service.defaults.headers.post[‘Content-Type’] = ‘application/x-www-form-urlencoded’;

  1. 请求拦截

我们在发送请求前可以进行一个请求的拦截,为什么要拦截呢,我们拦截请求是用来做什么的呢?比如,有些请求是需要用户登录之后才能访问的,或者post请求的时候,我们需要序列化我们提交的数据。这时候,我们可以在请求被发送之前进行一个拦截,从而进行我们想要的操作。

// 先导入vuex,因为我们要使用到里面的状态对象

// vuex的路径根据自己的路径去写

import store from ‘@/store/index’;

// 请求拦截器

service.interceptors.request.use(

config => {

// 不传递默认开启loading

if (!config.hideloading) {

// 请求是是否开启loading

Toast.loading({

forbidClick: true

})

}

// 每次发送请求之前判断vuex中是否存在token

// 如果存在,则统一在http请求的header都加上token,这样后台根据token判断你的登录情况

// 即使本地存在token,也有可能token是过期的,所以在响应拦截器中要对返回状态进行判断

if (store.state.token) {

config.headers.token = store.state.token;

//有些接口是 config.headers.Authorization = token

}

return config

},

error => {

// do something with request error

console.log(error) // for debug

return Promise.reject(error)

}

)

这里说一下token,一般是在登录完成之后,将用户的token通过localStorage或者cookie存在本地,然后用户每次在进入页面的时候(即在main.js中),会首先从本地存储中读取token,如果token存在说明用户已经登陆过,则更新vuex中的token状态。然后,在每次请求接口的时候,都会在请求的header中携带token,后台人员就可以根据你携带的token来判断你的登录是否过期,如果没有携带,则说明没有登录过。这时候或许有些小伙伴会有疑问了,就是每个请求都携带token,那么要是一个页面不需要用户登录就可以访问的怎么办呢?其实,你前端的请求可以携带token,但是后台可以选择不接收啊!

  1. 响应的拦截

// 响应拦截器

service.interceptors.response.use(

response => {

// 如果返回的状态码为200,说明接口请求成功,可以正常拿到数据

// 否则的话抛出错误

if (response.status === 200) {

return Promise.resolve(response);

} else {

return Promise.reject(response);

}

},

// 服务器状态码不是2开头的的情况

// 这里可以跟你们的后台开发人员协商好统一的错误状态码

// 然后根据返回的状态码进行一些操作,例如登录过期提示,错误提示等等

// 下面列举几个常见的操作,其他需求可自行扩展

error => {

if (error.response.status) {

switch (error.response.status) {

// 401: 未登录

// 未登录则跳转登录页面,并携带当前页面的路径

// 在登录成功后返回当前页面,这一步需要在登录页操作。

case 401:

router.replace({

path: ‘/login’,

query: {

redirect: router.currentRoute.fullPath

}

});

break;

// 403 token过期

// 登录过期对用户进行提示

// 清除本地token和清空vuex中token对象

// 跳转登录页面

case 403:

Toast({

message: ‘登录过期,请重新登录’,

duration: 1000,

forbidClick: true

});

// 清除token

store.dispatch(‘FedLogOut’).then(() => {

// 跳转登录页面,并将要浏览的页面fullPath传过去,登录成功后跳转需要访问的页面

router.replace({

path: ‘/login’,

query: {

redirect:router.currentRoute.fullPath

}

}) })

break;

// 404请求不存在

case 404:

Toast({

message: ‘网络请求不存在’,

duration: 1500,

forbidClick: true

});

break;

// 其他错误,直接抛出错误提示

default:

Toast({

message: error.response.data.message,

duration: 1500,

forbidClick: true

});

}

return Promise.reject(error.response);

}else {

// 处理断网的情况

// eg:请求超时或断网时,更新state的network状态

// network状态在app.vue中控制着一个全局的断网提示组件的显示隐藏

// 关于断网组件中的刷新重新获取数据,会在断网组件中说明

store.commit(‘changeNetwork’, false);

}

});

//最后导出实例

export default service;

响应拦截器很好理解,就是服务器返回给我们的数据,我们在拿到之前可以对他进行一些处理。例如上面的思想:如果后台返回的状态码是200,则正常返回数据,否则的根据错误的状态码类型进行一些我们需要的错误,其实这里主要就是进行了错误的统一处理没登录登录过期后调整登录页的一个操作。

到此处, axios的封装基本就完成了,下面再简单说下api的统一管理

三、api接口统一管理


新建了一个api文件夹,里面有一个index.js,以及多个根据模块划分的接口js文件。index.js是一个api的出口,其他js则用来管理各个模块的接口。

例如下面的article.js:

/**

  • article模块接口列表

*/

import request from ‘@/network/http’; // 导入http中创建的axios实例

import qs from ‘qs’; // 根据需求是否导入qs模块

const article = {

// 新闻列表

articleList () {

return request({

url: ‘/artical’,

method: ‘get’,

params,

hideloading: false //设置不隐藏加载loading

})

},

// 新闻详情,演示

articleDetail (id, params) {

return request({

url: ‘/detail’,

method: ‘get’,

params:{

goodsId

},

hideloading: true

})

},

// post提交

login (data) {

return request({

url:‘/adduser’,

method:‘post’,

data:qs.stringify(data), //注意post提交用data参数

hideloading: true

})

}

// 其他接口…………

}

export default article;

index.js代码:

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数前端工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)

结尾

正式学习前端大概 3 年多了,很早就想整理这个书单了,因为常常会有朋友问,前端该如何学习,学习前端该看哪些书,我就讲讲我学习的道路中看的一些书,虽然整理的书不多,但是每一本都是那种看一本就秒不绝口的感觉。

以下大部分是我看过的,或者说身边的人推荐的书籍,每一本我都有些相关的推荐语,如果你有看到更好的书欢迎推荐呀。

戳这里获取前端学习资料

合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!**

[外链图片转存中…(img-D0v4YGWN-1712397884142)]

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)

结尾

正式学习前端大概 3 年多了,很早就想整理这个书单了,因为常常会有朋友问,前端该如何学习,学习前端该看哪些书,我就讲讲我学习的道路中看的一些书,虽然整理的书不多,但是每一本都是那种看一本就秒不绝口的感觉。

以下大部分是我看过的,或者说身边的人推荐的书籍,每一本我都有些相关的推荐语,如果你有看到更好的书欢迎推荐呀。

戳这里获取前端学习资料

前端学习书籍导图-1

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值