在 Vue 中用 Axios 異步請求API

作者：前端小混混 2021-05-19 09:29:52

Axios 是 Javascript 中最受歡迎的 HTTP 庫之一，我們可以用它在 Vue 程序中調(diào)用API。

在本文中我們用 Vue 3 和 Axios 寫一個侃爺語錄小應(yīng)用，侃爺是國內(nèi)粉絲對美國當(dāng)紅饒舌歌手 Kanye West 的昵稱。可以用這個小程序?qū)W習(xí)英語，同時也能從侃爺?shù)脑捴械玫揭恍﹩l(fā)，而且還可以學(xué)習(xí)用 Vue 異步請求API，一舉多得，何樂而不為呢?

[[400375]]

設(shè)置基本 HTTP 請求

首先在終端中執(zhí)行下面的命令把 Axios 安裝到項(xiàng)目中：

install axiosnpm install axios

然后，在 Vue 組件中像這樣導(dǎo)入axios。

//App.vie - importing axios 
<script> 
import axios from 'axios' 
 
export default { 
  setup () { 
   
  } 
} 
</script>

接下來用 axios.get 通過 Kanye REST API 的 URL 獲取隨機(jī)語錄。之后可以用 Promise.then 等待請求返回響應(yīng)。

//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>

現(xiàn)在可以從 API 中獲取響應(yīng)了，先看一下它的含義。把它保存成名為 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>

檢查一下瀏覽器中的內(nèi)容。

我們可以看到隨機(jī)返回的侃爺語錄，還有一些額外的信息，例如請求的響應(yīng)碼等。

對于我們這個小應(yīng)用，只對這個 data.quote 值感興趣，所以要在腳本中指定要訪問 response 上的哪個屬性。

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

通過上面的代碼可以得到想要的內(nèi)容：

Axios 配合 async/await

可以在 Vue 程序中把 Axios 和 async /await 模式結(jié)合起來使用。

在設(shè)置過程中，首先注釋掉當(dāng)前的 GET 代碼，然后創(chuàng)建一個名為 loadQuote 的異步方法。在內(nèi)部，可以使用相同的 axios.get 方法，但是我們想用 async 等待它完成，然后把結(jié)果保存在一個名為 response 的常量中。

然后設(shè)置 quote 的值。

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

它和前面的代碼工作原理完全一樣，但這次用了異步模式。

Axios 的錯誤處理

在 async-await 模式中，可以通過 try 和 catch 來為 API 調(diào)用添加錯誤處理：

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

如果使用原始的 promises 語法，可以在 API 調(diào)用之后添加 .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) 
})

發(fā)送POST請求

下面看一下怎樣發(fā)送 POST 請求。在這里我們使用 JSONPlaceholder Mock API 調(diào)用。

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

接下來我們需要創(chuàng)建一個按鈕，當(dāng)點(diǎn)擊按鈕時將會觸發(fā)我們的API調(diào)用。在模板中創(chuàng)建一個名為 “Create Post” 的按鈕，單擊時調(diào)用名為 createPost 方法。

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

下面在代碼中創(chuàng)建 createPost 方法，然后從 setup 返回。

這個方法，類似于前面的 GET 請求，只需要調(diào)用 axios.post 并傳入URL(即https://jsonplaceholder.typicode.com/posts )就可以復(fù)制粘貼文檔中的數(shù)據(jù)了。

//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 編寫可復(fù)用的 API 調(diào)用

在項(xiàng)目中通過創(chuàng)建一個 src/services 目錄，用它來組織所有 api 調(diào)用。

目錄中包含 2 種類型的文件：

API.js ：用來創(chuàng)建一個帶有定義的 baseURL 的 Axios 實(shí)例，這個實(shí)例會用于所有的路由
*{specific functionality}*API.js ：更具體的文件，可用于將 api 調(diào)用組織成可重用的模塊

這樣做的好處是可以方便的在開發(fā)和生產(chǎn)服務(wù)器之間進(jìn)行切換，只需修改一小段代碼就行了。

創(chuàng)建 services/API.js 文件，并將 Axios baseURL 設(shè)置為默認(rèn)為 Kanye REST API。

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

接下來創(chuàng)建一個 KanyeAPI.js 文件并從 ./API 中導(dǎo)入 API。在這里我們要導(dǎo)出不同的 API 調(diào)用。

調(diào)用 API() 會給得到一個 Axios 實(shí)例，可以在其中調(diào)用 .get 或 .post。

//KanyeAPI.js 
import API from './API' 
 
export default { 
    getQuote() { 
        return API().get('/') 
    }, 
}

然后在 App.vue 內(nèi)部，讓我們的組件通過可復(fù)用的 API 調(diào)用來使用這個新文件，而不是自己再去創(chuàng)建 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 在導(dǎo)出默認(rèn)設(shè)置中添加 createPost，這會將 POST 請求的數(shù)據(jù)作為參數(shù)傳遞給我們的 HTTP 請求。

與GET請求類似，通過 API 獲取 axios 實(shí)例，但這次需要覆蓋默認(rèn) 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 ，可以像這樣調(diào)用新的 post 方法。

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

現(xiàn)在單擊按鈕時，可以看到專用的 API 能夠正常工作。

把 API 調(diào)用移出這些 Vue 組件并放在它自己的文件的好處在于，可以在整個程序中的任何位置使用這些 API 調(diào)用。這樣可以創(chuàng)建更多可重用和可伸縮的代碼。

最終代碼

// 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) 
    } 
}

責(zé)任編輯：趙寧寧來源：前端先鋒