在 Vue 中用 Axios 异步请求API

时间:2022-09-21 16:22:05

Axios 是 Javascript 中最受欢迎的 HTTP 库之一,我们可以用它在 Vue 程序中调用API

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

在 Vue 中用 Axios 异步请求API

设置基本 HTTP 请求

 

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

  1. install axiosnpm install axios 

然后,在 Vue 组件中像这样导入axios。

  1. //App.vie - importing axios 
  2. <script> 
  3. import axios from 'axios' 
  4.  
  5. export default { 
  6.   setup () { 
  7.    
  8.   } 
  9. </script> 

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

  1. //App.vue - sending our HTTP request 
  2. <script> 
  3. import axios from 'axios' 
  4.  
  5. export default { 
  6.   setup () { 
  7.      axios.get('https://api.kanye.rest/').then(response => { 
  8.         // handle response 
  9.      }) 
  10.   } 
  11. </script> 

现在可以从 API 中获取响应了,先看一下它的含义。把它保存成名为 quote 的引用。

  1. //App.vue - storing the response 
  2. <script> 
  3. import axios from 'axios' 
  4. import { ref } from 'vue' 
  5.  
  6. export default { 
  7.   setup () { 
  8.      axios.get('https://api.kanye.rest/').then(response => { 
  9.         // handle response 
  10.         quote.value = response 
  11.      }) 
  12.      return { 
  13.       quote 
  14.      } 
  15.   } 
  16. </script> 

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

  1. //App.vue - template code 
  2. <template> 
  3.   <div> 
  4.     <i>"{{ quote }}"</i> 
  5.     <p>- Kanye West</p> 
  6.   </div> 
  7. </template> 

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

在 Vue 中用 Axios 异步请求API

我们可以看到随机返回的侃爷语录,还有一些额外的信息,例如请求的响应码等。

对于我们这个小应用,只对这个 data.quote 值感兴趣,所以要在脚本中指定要访问 response 上的哪个属性。

  1. //App.vue - getting only our quote 
  2. axios.get('https://api.kanye.rest/').then(response => { 
  3.         // handle response 
  4.         quote.value = response.data.quote 
  5. }) 

通过上面的代码可以得到想要的内容:

在 Vue 中用 Axios 异步请求API

Axios 配合 async/await

 

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

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

然后设置 quote 的值。

  1. //App.vue - async Axios 
  2. const loadQuote = async () => { 
  3.       const response = await KanyeAPI.getQuote() 
  4.       quote.value = response.data.quote 

它和前面的代码工作原理完全一样,但这次用了异步模式。

在 Vue 中用 Axios 异步请求API

Axios 的错误处理

 

在 async-await 模式中,可以通过 try 和 catch 来为 API 调用添加错误处理:

  1. //Error handling with async/await 
  2. try { 
  3.         const response = await KanyeAPI.getQuote() 
  4.         quote.value = response.data.quote 
  5. } catch (err) { 
  6.         console.log(err) 

如果使用原始的 promises 语法,可以在 API 调用之后添加 .catch 捕获来自请求的任何错误。

  1. //Error handling with Promises 
  2. axios.get('https://api.kanye.rest/') 
  3.       .then(response => { 
  4.         // handle response 
  5.         quote.value = response.data.quote 
  6.       }).catch(err => { 
  7.       console.log(err) 
  8. }) 

发送POST请求

 

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

在 Vue 中用 Axios 异步请求API

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

在 Vue 中用 Axios 异步请求API

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

  1. <div> 
  2.   <i>"{{ quote }}"</i> 
  3.   <p>- Kanye West</p> 
  4.   <p> 
  5.     <button @click="createPost">Create Post</button> 
  6.   </p> 
  7. </div> 
  8. template> 

下面在代码中创建 createPost 方法,然后从 setup 返回。

这个方法,类似于前面的 GET 请求,只需要调用 axios.post 并传入URL(即https://jsonplaceholder.typicode.com/posts )就可以复制粘贴文档中的数据了。

  1. //App.vue 
  2. const createPost = () => { 
  3.       axios.post('https://jsonplaceholder.typicode.com/posts', JSON.stringify({ 
  4.           title: 'foo', 
  5.           body: 'bar', 
  6.           userId: 1, 
  7.       })).then(response => { 
  8.         console.log(response) 
  9.       }) 

单击按钮试一下,可以看到控制台输出了大量信息,告诉我们 POST 请求已成功完成。

在 Vue 中用 Axios 异步请求API

用 Axios 编写可复用的 API 调用

 

在项目中通过创建一个 src/services 目录,用它来组织所有 api 调用。

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

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

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

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

  1. API.jsimport axios from 'axios' 
  2.  
  3. export default(url='https://api.kanye.rest') => { 
  4.     return axios.create({ 
  5.         baseURL: url, 
  6.     }) 

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

调用 API() 会给得到一个 Axios 实例,可以在其中调用 .get 或 .post。

  1. //KanyeAPI.js 
  2. import API from './API' 
  3.  
  4. export default { 
  5.     getQuote() { 
  6.         return API().get('/') 
  7.     }, 

然后在 App.vue 内部,让我们的组件通过可复用的 API 调用来使用这个新文件,而不是自己再去创建 Axios。

  1. //App.vue 
  2. const loadQuote = async () => { 
  3.       try { 
  4.         const response = await KanyeAPI.getQuote() // <--- THIS LINE 
  5.         quote.value = response.data.quote 
  6.       } catch (err) { 
  7.         console.log(err) 
  8.       } 

下面把 createPost 移到其自己的可重用方法中。

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

与GET请求类似,通过 API 获取 axios 实例,但这次需要覆盖默认 URL 值并传递 JSONplaceholder url。然后就可以像过去一样屌用 Axios POST 了。

  1. //KanyeAPI.js 
  2. export default { 
  3.     getQuote() { 
  4.         return API().get('/') 
  5.     }, 
  6.     createPost(data) { 
  7.         return API('https://jsonplaceholder.typicode.com/').post('/posts', data) 
  8.     } 

如此简单!

回到 App.vue ,可以像这样调用新的 post 方法。

  1. //App.vue  
  2. const createPost = () => { 
  3.       const response = await KanyeAPI.createPost(JSON.stringify({ 
  4.           title: 'foo', 
  5.           body: 'bar', 
  6.           userId: 1, 
  7.       })) 
  8.  
  9.       console.log(response) 

现在单击按钮时,可以看到专用的 API 能够正常工作。

把 API 调用移出这些 Vue 组件并放在它自己的文件的好处在于,可以在整个程序中的任何位置使用这些 API 调用。这样可以创建更多可重用和可伸缩的代码。

最终代码

 

  1. // App.vue 
  2. <template> 
  3.   <div> 
  4.     <i>"{{ quote }}"</i> 
  5.     <p>- Kanye West</p> 
  6.     <p> 
  7.       <button @click="createPost">Create Post</button> 
  8.     </p> 
  9.   </div> 
  10. </template> 
  11.  
  12. <script> 
  13. import axios from 'axios' 
  14. import { ref } from 'vue' 
  15. import KanyeAPI from './services/KanyeAPI' 
  16. export default { 
  17.   setup () { 
  18.  
  19.     const quote = ref('') 
  20.  
  21.     const loadQuote = async () => { 
  22.       try { 
  23.         const response = await KanyeAPI.getQuote() 
  24.         quote.value = response.data.quote 
  25.       } catch (err) { 
  26.         console.log(err) 
  27.       } 
  28.     } 
  29.  
  30.     loadQuote() 
  31.      
  32.     // axios.get('https://api.kanye.rest/') 
  33.     //   .then(response => { 
  34.     //     // handle response 
  35.     //     quote.value = response.data.quote 
  36.     //   }).catch(err => { 
  37.     //   console.log(err) 
  38.     // }) 
  39.  
  40.     const createPost = () => { 
  41.       const response = await KanyeAPI.createPost(JSON.stringify({ 
  42.           title: 'foo', 
  43.           body: 'bar', 
  44.           userId: 1, 
  45.       })) 
  46.  
  47.       console.log(response) 
  48.       // axios.post('https://jsonplaceholder.typicode.com/posts', JSON.stringify({ 
  49.       //     title: 'foo', 
  50.       //     body: 'bar', 
  51.       //     userId: 1, 
  52.       // })).then(response => { 
  53.       //   console.log(response) 
  54.       // }) 
  55.        
  56.     } 
  57.      
  58.     return { 
  59.       createPost, 
  60.       quote 
  61.     } 
  62.   } 
  63. </script> 
  64.  
  65. <style> 
  66. #app { 
  67.   font-family: Avenir, Helvetica, Arial, sans-serif; 
  68.   -webkit-font-smoothing: antialiased; 
  69.   -moz-osx-font-smoothing: grayscale; 
  70.   text-align: center; 
  71.   color: #2c3e50; 
  72.   margin-top: 60px; 
  73. </style> 
  1. //API.js 
  2. import axios from 'axios' 
  3.  
  4. export default(url='https://api.kanye.rest') => { 
  5.     return axios.create({ 
  6.         baseURL: url, 
  7.     }) 
  1. //KanyeAPI.js 
  2. import API from './API' 
  3. export default { 
  4.     getQuote() { 
  5.         return API().get('/') 
  6.     }, 
  7.     createPost(data) { 
  8.         return API('https://jsonplaceholder.typicode.com/').post('/posts', data) 
  9.     } 

原文地址:https://mp.weixin.qq.com/s?__biz=MzI3NzIzMDY0NA==&mid=2247501889&idx=1&sn=413f0a7c1a328b43797ab928a7bb4c20&chksm=eb6bed1adc1c640c339c3cd5d2e81b83b697fbd9e7f3436d5d9fa90a1e5290fa3d8b71e9213e&mpshare=1&s