在 Vue 中用 Axios 和异步模式请求API

时间  2021-08-12
标签 javascript css html vue java ios web npm json axios 栏目 JavaScript 繁體版
原文   原文链接

Axios 是 Javascript 中最受欢迎的 HTTP 库之一，咱们能够用它在 Vue 程序中调用API。javascript

在本文中咱们用 Vue 3 和 Axios 写一个侃爷语录小应用，侃爷是国内粉丝对美国当红饶舌歌手 Kanye West 的昵称。能够用这个小程序学习英语，同时也能从侃爷的话中获得一些启发，并且还能够学习用 Vue 异步请求API，一举多得，何乐而不为呢？css

设置基本 HTTP 请求

首先在终端中执行下面的命令把 Axios 安装到项目中：html

install axiosnpm install axios
复制代码

而后，在 Vue 组件中像这样导入axios。vue

//App.vie - importing axios
<script>
import axios from 'axios'

export default {
  setup () {
  
  }
}
</script>
复制代码

接下来用 axios.get 经过 Kanye REST API 的 URL 获取随机语录。以后能够用 Promise.then 等待请求返回响应。java

//App.vue - sending our HTTP request
<script>
import axios from 'axios'

export default {
  setup () {
     axios.get('https://api.kanye.rest/').then(response => {
        // handle response
     })
  }
}
</script>
复制代码

如今能够从 API 中获取响应了，先看一下它的含义。 把它保存成名为 quote 的引用。ios

//App.vue - storing the response
<script>
import axios from 'axios'
import { ref } from 'vue'

export default {
  setup () {
     axios.get('https://api.kanye.rest/').then(response => {
        // handle response
        quote.value = response
     })
     return {
      quote
     }
  }
}
</script>
复制代码

最后将其输出到模板中并以斜体显示，并用引号引发来，另外还须要给这条语录加上引用来源。web

//App.vue - template code
<template>
  <div>
    <i>"{{ quote }}"</i>
    <p>- Kanye West</p>
  </div>
</template>
复制代码

检查一下浏览器中的内容。npm

img

咱们能够看到随机返回的侃爷语录，还有一些额外的信息，例如请求的响应码等。json

对于咱们这个小应用，只对这个 data.quote 值感兴趣，因此要在脚本中指定要访问 response 上的哪一个属性。axios

//App.vue - getting only our quote
axios.get('https://api.kanye.rest/').then(response => {
        // handle response
        quote.value = response.data.quote
})
复制代码

经过上面的代码能够获得想要的内容：

img

Axios 配合 async/await

能够在 Vue 程序中把 Axios 和 async /await 模式结合起来使用。

在设置过程当中，首先注释掉当前的 GET 代码，而后建立一个名为 loadQuote 的异步方法。 在内部，可使用相同的 axios.get 方法，可是咱们想用 async 等待它完成，而后把结果保存在一个名为 response 的常量中。

而后设置 quote 的值。

//App.vue - async Axios
const loadQuote = async () => {
      const response = await KanyeAPI.getQuote()
      quote.value = response.data.quote
}
复制代码

它和前面的代码工做原理彻底同样，但此次用了异步模式。

img

Axios 的错误处理

在 async-await 模式中，能够经过 try 和 catch 来为 API 调用添加错误处理：

//Error handling with async/await
try {
        const response = await KanyeAPI.getQuote()
        quote.value = response.data.quote
} catch (err) {
        console.log(err)
}
复制代码

若是使用原始的 promises 语法，能够在 API 调用以后添加 .catch 捕获来自请求的任何错误。

//Error handling with Promises
axios.get('https://api.kanye.rest/')
      .then(response => {
        // handle response
        quote.value = response.data.quote
      }).catch(err => {
      console.log(err)
})
复制代码

发送POST请求

下面看一下怎样发送 POST 请求。在这里咱们使用 JSONPlaceholder Mock API 调用。

img

他们的文档中提供了一个测试 POST 请求的 /posts 接口。

img

接下来咱们须要建立一个按钮，当点击按钮时将会触发咱们的API调用。在模板中建立一个名为 “Create Post” 的按钮，单击时调用名为 createPost 方法。

<div>
    <i>"{{ quote }}"</i>
    <p>- Kanye West</p>
    <p>
      <button @click="createPost">Create Post</button>
    </p>
  </div>
</template>
复制代码

下面在代码中建立 createPost 方法，而后从 setup 返回。

这个方法，相似于前面的 GET 请求，只须要调用 axios.post 并传入URL（即https://jsonplaceholder.typicode.com/posts ）就能够复制粘贴文档中的数据了。

//App.vue
const createPost = () => {
      axios.post('https://jsonplaceholder.typicode.com/posts', JSON.stringify({
          title: 'foo',
          body: 'bar',
          userId: 1,
      })).then(response => {
        console.log(response)
      })
}
复制代码

单击按钮试一下，能够看到控制台输出了大量信息，告诉咱们 POST 请求已成功完成。

img

用 Axios 编写可复用的 API 调用

在项目中经过建立一个 src/services 目录，用它来组织全部 api 调用。

目录中包含 2 种类型的文件：

  • API.js ：用来建立一个带有定义的 baseURL 的 Axios 实例，这个实例会用于全部的路由
  • *{specific functionality}*API.js ：更具体的文件，可用于将 api 调用组织成可重用的模块

这样作的好处是能够方便的在开发和生产服务器之间进行切换，只需修改一小段代码就好了。

建立 services/API.js 文件，并将 Axios baseURL 设置为默认为 Kanye REST API。

API.jsimport axios from 'axios'

export default(url='https://api.kanye.rest') => {
    return axios.create({
        baseURL: url,
    })
}
复制代码

接下来建立一个 KanyeAPI.js 文件并从 ./API 中导入 API。 在这里咱们要导出不一样的 API 调用。

调用 API() 会给获得一个 Axios 实例，能够在其中调用 .get 或 .post。

//KanyeAPI.js
import API from './API'

export default {
    getQuote() {
        return API().get('/')
    },
}
复制代码

而后在 App.vue 内部，让咱们的组件经过可复用的 API 调用来使用这个新文件，而不是本身再去建立 Axios。

//App.vue
const loadQuote = async () => {
      try {
        const response = await KanyeAPI.getQuote() // <--- THIS LINE
        quote.value = response.data.quote
      } catch (err) {
        console.log(err)
      }
}
复制代码

下面把 createPost 移到其本身的可重用方法中。

回到 KanyeAPI.js 在导出默认设置中添加 createPost，这会将 POST 请求的数据做为参数传递给咱们的 HTTP 请求。

与GET请求相似，经过 API 获取 axios 实例，但此次须要覆盖默认 URL 值并传递 JSONplaceholder url。 而后就能够像过去同样屌用 Axios POST 了。

//KanyeAPI.js
export default {
    getQuote() {
        return API().get('/')
    },
    createPost(data) {
        return API('https://jsonplaceholder.typicode.com/').post('/posts', data)
    }
}
复制代码

如此简单

回到 App.vue ，能够像这样调用新的 post 方法。

//App.vue 
const createPost = () => {
      const response = await KanyeAPI.createPost(JSON.stringify({
          title: 'foo',
          body: 'bar',
          userId: 1,
      }))

      console.log(response)
}
复制代码

如今单击按钮时，能够看到专用的 API 可以正常工做。

把 API 调用移出这些 Vue 组件并放在它本身的文件的好处在于，能够在整个程序中的任何位置使用这些 API 调用。这样能够建立更多可重用和可伸缩的代码。

最终代码

// App.vue
<template>
  <div>
    <i>"{{ quote }}"</i>
    <p>- Kanye West</p>
    <p>
      <button @click="createPost">Create Post</button>
    </p>
  </div>
</template>

<script> import axios from 'axios' import { ref } from 'vue' import KanyeAPI from './services/KanyeAPI' export default { setup () { const quote = ref('') const loadQuote = async () => { try { const response = await KanyeAPI.getQuote() quote.value = response.data.quote } catch (err) { console.log(err) } } loadQuote() // axios.get('https://api.kanye.rest/') // .then(response => { // // handle response // quote.value = response.data.quote // }).catch(err => { // console.log(err) // }) const createPost = () => { const response = await KanyeAPI.createPost(JSON.stringify({ title: 'foo', body: 'bar', userId: 1, })) console.log(response) // axios.post('https://jsonplaceholder.typicode.com/posts', JSON.stringify({ // title: 'foo', // body: 'bar', // userId: 1, // })).then(response => { // console.log(response) // }) } return { createPost, quote } } } </script>

<style> #app { font-family: Avenir, Helvetica, Arial, sans-serif; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; text-align: center; color: #2c3e50; margin-top: 60px; } </style>
复制代码
//API.js
import axios from 'axios'

export default(url='https://api.kanye.rest') => {
    return axios.create({
        baseURL: url,
    })
}

复制代码
//KanyeAPI.js
import API from './API'
export default {
    getQuote() {
        return API().get('/')
    },
    createPost(data) {
        return API('https://jsonplaceholder.typicode.com/').post('/posts', data)
    }
}
复制代码

写在最后

近期在提高 Vue 的过程当中，发现一个高逼格的 Vue3+TS 教程。 无偿分享给掘仔们，戳我看教程

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程