nuxt.js使用axios发送http请求

看这篇文章之前,默认你是知道nuxt是什么的,并且知道nuxt怎么使用。
如果不了解的,建议先去看看nuxt的基础知识再来继续阅读本篇文章
nuxt中文官网:https://zh.nuxtjs.org/

nuxt官方推荐使用axios作为http请求的类库。

axios在nuxt中有两种使用场景:

  1. 客户端使用
  2. 服务端使用

nuxt提供了专用的axios的模块:https://axios.nuxtjs.org/,并且支持反向代理等功能
当然你也可以不使用专用模块,以传统模式引入原生axios,这里不做讨论

首先在nuxt.config.js中引入axios模块,代码如下:
(如果需要反向代理等功能,需要引入@nuxtjs/proxy,不过不引入好像也可以用,默认自带的)

  modules: [
    // Doc: https://axios.nuxtjs.org/usage
    '@nuxtjs/axios',
    '@nuxtjs/proxy'
  ]

然后再nuxt.config.js中做如下配置:

  axios: {
    prefix: '/api',
    credentials: true,
    proxy: true
  },
  proxy:
  {
    '/api': 'http://bugchang.com'
  }

axios:

  • prefix:前缀的值,比如请求get articles/1实际请求是经过修饰的 get api/articles/1
  • credentials:是否携带证书,这个我没用到,也不知道具体咋用的,感兴趣的可以去研究一下
  • proxy:是否开启代理,为trueproxy中的配置才能生效

proxy:

  • 将axios请求地址通过反向代理进行请求,如get api/articles/1的最终请求会指向get http://bugchang.com/api/articles/1

这只是最简单的配置,porxy还有其他形式的配置:

proxy: {
     '/api/': {
       target: 'http://bugchang.com/',
       pathRewrite: {
         '^/api/': ''
       }
     }
  },
  • target:将api前缀的地址请求指向target定义的地址
  • pathRewrite:将url中的api替换为空

举个例子,2个后台接口:

  1. get articles/1
  2. get categories/1

这样的接口proxy没法做设置,因为没规律,不能每个接口都加一条规则吧,所以用axios先给地址加个前缀,这样就变成了:

  1. get api/articles/1
  2. get api/categories/1

然后我们只要指定/api/这样的Url都通过代理指向http://bugchang.com这个地址,请求的url就会变成:

  1. get http://bugchang.com/api/articles/1
  2. get http://bugchang.com/api/categories/1

但是实际上我们后台的接口并没有api这个路径,这样访问肯定404,所以我们通过pathRewrite在请求时把/api/这个字符串替换成'':

  1. get http://bugchang.com/articles/1
  2. get http://bugchang.com/categories/1

这样就达到了我们的目的。

axios配置

在nuxt.config.js中的axios代码块中我们可以对axios模块进行基础参数的配置,基本上和原生axios没两样

但是值得注意的一点是,我们用原生axios的时候西关定义baseURL,在nuxt中baseURL的定义需要关注一下,如果你使用了反向代理的功能(也就是proxy: true),那么就不能定义baseURL,这两项之间是冲突的,我们可以使用prefix来代替baseURL

还有一个参数是原生axios没有的,browserBaseURLbrowserBaseURL是客户端的访问的根Url,因为在nuxt中,前端和后端访问的地址可能不一样,比如前端访问线上地址:http://blog.bugchang.com/,但是后台如果和接口服务在一个服务器上,可以直接访问http://localhost:5000,这样可以避免不必要的网络延迟和映射流量

browserBaseURL默认是baseURL的值,若果proxy: true那么默认值就是prefix的值

其他选项配置参考官方文档:https://axios.nuxtjs.org/options

axios的使用

async getCategories () {
      this.categories = await this.$axios.$get('/categories')
}

按照以上的配置后,我们是可以在nuxt的上下文中拿到axios的对象,使用this.$axios获取到axios对象,然后进行get或post等请求即可

有三种方式来使用axios进行请求,无论使用哪种效果都是一样的(本人更偏爱第二种):

  1. 返回 Promise
function test1(){
this.$axios.get(`http://blog.bugchang.com/articles/1`)
  .then((res) => {
    console.log(res)
})
}
  1. 使用 async或await
function test2(){
    const { data } = await this.$axios.get(`http://blog.bugchang.com/articles/1`)
    console.log(data)
}
  1. 使用 回调函数
function test3(callback){
    this.$axios.get(`http://blog.bugchang.com/articles/1`)
      .then((res) => {
        callback(null, { title: res.data.title })
      })
}

以上示例代码是在客户端模式下使用的,也就是no-ssr模式,那么服务器端如何使用呢?以nuxt的asyncData方法为例
了解nuxt的生命周期的话,们知道asyncData方法中是没有this对象的,我们可以把$axios作为参数传递到asyncData方法
代码如下:

  async asyncData ({ params, $axios }) {
    const { data } = await $axios.get(`/articles/index?pageIndex=1`)
    return { data, page: 1 }
  }

服务端如果需要同时请求多个接口怎么写呢,普通的写法是不生效的,要这么写:

async asyncData ({ params, $axios }) {
    const [articles, category] = await Promise.all([
      $axios.$get(`/articles/category/${params.id}`),
      $axios.$get(`/categories/${params.id}`)
    ])
    ...
  }

关于$axios.$get和$axios.get的坑

一开始我没注意到这块的问题,后来遇到了一些坑才发现是咋回事

$get直接返回responsebody的内容,其他相关信息比如header、cookie什么的上下文信息是不返回的
get与$get正相反,包括上下文信息和消息体在内的内容都会返回

const { data } = await $axios.get(`/articles/index?pageIndex=1\`)
const  data  = await $axios.$get(`/articles/index?pageIndex=1\`)
const  data  = await $axios.get(`/articles/index?pageIndex=1\`).data

以上三种写法返回的对象是一致的,注意{}的区别

自定义全局过滤器

如果以上配置无法满足你的要求,或者你要定义一些全局过滤器,做一些额外操作的话,可以以插件的形式加载
plugins文件夹下新建axios.js,这些配置和原生的axios一样,不再赘述:

import Cookie from 'js-cookie'
export default function (app) {
  const axios = app.$axios
  // 基本配置
  axios.defaults.timeout = 10000
  axios.defaults.headers.post['Content-Type'] = 'application/json'
  axios.defaults.headers.patch['Content-Type'] = 'application/json'
  axios.defaults.headers.put['Content-Type'] = 'application/json'

  // 请求回调
  axios.onRequest((config) => {
    const token = Cookie.get('token')
    config.headers.Authorization = `Bearer ${token}`
  })

  // 返回回调
  axios.onResponse((res) => {
    if (res.headers.refreshtoken) {
      Cookie.set('token', res.headers.refreshtoken)
    }
  })

  // 错误回调
  axios.onError((error) => {
    switch (error.response.status) {
      case 401:
        location.href = '/login'
        break
    }
  })
}

然后在axios.config.js中将@/plugins/axios注册到plugins代码块中:

  plugins: [
    '@/plugins/vue-mavon-editor',
    '@/plugins/axios',
    '@/plugins/bdtj.js' /* 百度统计 */
  ]

自定义局部设置

上面说了全局的拦截和配置,如果说某几个功能需要一些特殊的header啊或者其他的配置怎么办呢

    this.$axios.setHeader('token', token)
    this.$axios.setHeader('key', key)
    for (const item of data.defaultPaper.questionGroupList) {
      for (const question of item.questionWrapperList) {
        const { data } = await $axios.get('https://ecs.qmth.com.cn:8878/api/ecs_oe_student/examQuestion/getQuestionContent?questionId=' + question.questionId + '&exam_record_id= ')
        console.log(data)
        result.push(data)
      }
    }

总结

以上就是个人总结的nuxt使用axios模块的一些经验,希望能帮到你

原文地址:http://blog.bugchang.com/article/9

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

推荐阅读更多精彩内容