vue中Axios的封装和API接口的管理

一、介绍
大家都知道,在Jquery中,我们使用的是它封装的$ajax来与后端交互数据,在vue框架中而推荐的是axios,Axios是一个基于Promise(ES6中用于处理异步的)的HTTP库,用于浏览器和node.js中(http://www.axios-js.com/zh-cn/docs/)。

1.浏览器中创建XMLHttpRequests
2.从node.js中创建http请求
3.支持Promise API
4.拦截请求和响应
5.转换请求数据和响应数据
6.取消请求
7.自动转换JSON数据
8.客户端支持防御XSRF

二、安装

npm install axios; 
yarn add axios;

三、基本用法
在项目中一般会创建一个request.js文件,通过创建一个axios实例,来封装请求,主要运用拦截器做统一处理
1.请求拦截器:会在这里处理request,比如配置token写入头信息中。
2.返回拦截器:会在这里处理response,对http状态码做统一处理。
注意:axios默认为json格式,如果采用form格式需要单独引入qs包

//首先我们来创建一个Axios实例
var axiosIns = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-product': 'h5'}
});

// 请求拦截器(伪代码)
service.interceptors.request.use(config => {
  const { userToken } = store.state
  if (userToken) {
    config.headers.Authorization = `Bearer ${userToken.token}` 
  }
  return config
}, error => {
  Promise.reject(error)
})

//设置response拦截器(伪代码)
service.interceptors.response.use(
  response => {
    return response
  },
  async err => {
    switch (err.response.status) {
      case 400:
        err.message = '不支持的参数(400)'
        break
      case 401: {
        let { userToken } = store.state
        if (!userToken || !userToken.token) {
          return router.replace({
            path: '/login',
            query: {
              // currentRoute:表示当前路由
              redireact: router.currentRoute.fullPath
            }
          })
        }
        break
      case 404:
        err.message = '被访问资源不存在(404)'
        break
      case 500:
        err.message = '服务端内部错误(500)'
        break
    }
    Toast.fail(err.message)
    return Promise.reject(err)
  }
)

四、项目中api管理

脑补一下后台给出的文档,如果后台不傻的话给出的文档肯定分模块的,假设后台给出的文档分为了以下几个模块,例如
资讯模块
问答模块
专栏模块
讲堂模块
圈子模块
发现模块
个人信息模块
用户登录注册模块
...还有其他很多
一般来说,网站的首页都是复杂的,会用到很多其他页面也会用到api,所以接口统一管理可以做到api的复用,这样也便于api的维护,在src目录下创建一个apis文件夹,然后根据项目大小按照模块划分api


image.png

五、项目中跨域
1.Vue-cli3 搭建Vue 项目,创建出的项目和以往的有了很多的变化,目录及命令有也是。尤其是config文件夹已经没有了。而项目中最简单都需要开发环境(dev)和线上环境(pro)

那么我以往中需要在config中文件一些生产环境,或者跨域处理现在得自己在根目录下创建了。 在开发环境中一般要处理跨域
1 创建普通全局变量 .env
2 创建开发环境变量 .env.development
3 创建生产环境变量 .env.production
(1) vue-cli3的devServer
跨域请求devServer代理几种配置
1:先在项目的根目录下新建 vue.config.js 文件
2:在module.exports内设置devServer来处理代理

module.exports = {
  devServer: {
    proxy: {
      '/v1': {
        target: 'http://192.168.1.33:9888', // 目标地址
        changeOrigin: true, //是否跨域
        ws: true,
        //重写路径  需要设置重写的话,要在后面的调用接口前加上/v1 来代替target
        pathRewrite:{
          // '^/v1': '',
        }
      // 可配置多个,如果路径有多个的话
      // '/v2': {
      //  target: 'http://192.168.1.33:9888', // 目标地址
      //  changeOrigin: true, //是否跨域
      //  ws: true,
        //重写路径  需要设置重写的话,要在后面的调用接口前加上/v2 来代替target
      //  pathRewrite:{
          // '^/v2': '',
      //  }
      }
    }
  }
}

如果项目用的是axios,则在axios中配置,只要将baseURL配置为空字符串'',参考链接: 代理跨域

axios.create({ baseURL:'' })
如果axios的baseURL配置为'/v1', 那么需要在proxy中重写路径, 否则不能跨域

pathRewrite:{
  '^/v1': '',
}
如果想要代理所有路径,那么可以在proxy中配置(将'/v1'改为'/):

proxy: {
  '/': { // '/'匹配所有路径,所有请求都会被代理
    target: 'http://192.168.1.33:9888',
    changeOrigin: true,
    ws: true
  }
}

3:后端开启cors跨域,配置header头信息,开启白名单

// 允许跨域访问的域名:若有端口需写全(协议+域名+端口),若没有端口末尾不用加'/'
response.setHeader("Access-Control-Allow-Origin", "http://www.domain1.com"); 

// 允许前端带认证cookie:启用此项后,上面的域名不能为'*',必须指定具体的域名,否则浏览器会提示
response.setHeader("Access-Control-Allow-Credentials", "true"); 

// 提示OPTIONS预检时,后端需要设置的两个常用自定义头
response.setHeader("Access-Control-Allow-Headers", "Content-Type,X-Requested-With");
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,176评论 5 469
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,190评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,232评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,953评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,879评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,177评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,626评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,295评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,436评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,365评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,414评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,096评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,685评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,771评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,987评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,438评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,032评论 2 341

推荐阅读更多精彩内容