在 Vue 中用 Axios 和異步模式請求API

Axios 是 Javascript 中最受歡迎的 HTTP 庫之一，咱們能夠用它在 Vue 程序中調用API。

在本文中咱們用 Vue 3 和 Axios 寫一個侃爺語錄小應用，侃爺是國內粉絲對美國當紅饒舌歌手 Kanye West 的暱稱。能夠用這個小程序學習英語，同時也能從侃爺的話中獲得一些啓發，並且還能夠學習用 Vue 異步請求API，一舉多得，何樂而不爲呢？

設置基本 HTTP 請求

首先在終端中執行下面的命令把 Axios 安裝到項目中：

install axiosnpm install axios
複製代碼

而後，在 Vue 組件中像這樣導入axios。

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

export default {
  setup () {
  
  }
}
</script>
複製代碼

接下來用 axios.get 經過 Kanye REST API 的 URL 獲取隨機語錄。以後能夠用 Promise.then 等待請求返回響應。

//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 的引用。

//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>
複製代碼

最後將其輸出到模板中並以斜體顯示，並用引號引發來，另外還須要給這條語錄加上引用來源。

//App.vue - template code
<template>
  <div>
    <i>"{{ quote }}"</i>
    <p>- Kanye West</p>
  </div>
</template>
複製代碼

檢查一下瀏覽器中的內容。

咱們能夠看到隨機返回的侃爺語錄，還有一些額外的信息，例如請求的響應碼等。

對於咱們這個小應用，只對這個 data.quote 值感興趣，因此要在腳本中指定要訪問 response 上的哪一個屬性。

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

經過上面的代碼能夠獲得想要的內容：

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
}
複製代碼

它和前面的代碼工做原理徹底同樣，但此次用了異步模式。

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 調用。

他們的文檔中提供了一個測試 POST 請求的 /posts 接口。

接下來咱們須要建立一個按鈕，當點擊按鈕時將會觸發咱們的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 請求已成功完成。

用 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 教程。 無償分享給掘仔們，戳我看教程