Axios是一個(gè)基于Promise的 HTTP 庫(kù)，可以用在瀏覽器和node.js 中，因?yàn)橛却蟠蟮耐扑]，axios也變得越來(lái)越流行。最近項(xiàng)目中使用axios也遇到了一些問(wèn)題，就借此機(jī)會(huì)總結(jié)一下，如有錯(cuò)誤，還請(qǐng)不吝指正。

功能

瀏覽器端發(fā)起XMLHttpRequests請(qǐng)求

node層發(fā)起http請(qǐng)求

支持Promise API

攔截請(qǐng)求和響應(yīng)

轉(zhuǎn)換請(qǐng)求和響應(yīng)數(shù)據(jù)

取消請(qǐng)求

自動(dòng)轉(zhuǎn)換JSON數(shù)據(jù)

客戶端支持防御XSRF（跨站請(qǐng)求偽造）

兼容

使用

npm
npm install axios

bower
bower install axios

cdn

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

發(fā)起請(qǐng)求

GET

axios.get('/user?ID=123')
  .then( res => {
    console.info(res)
  }).catch( e => {
    if(e.response){
    //請(qǐng)求已發(fā)出，服務(wù)器返回狀態(tài)碼不是2xx。
      console.info(e.response.data)
      console.info(e.response.status)
      console.info(e.response.headers)
    }else if(e.request){
      // 請(qǐng)求已發(fā)出，但沒(méi)有收到響應(yīng)
      // e.request 在瀏覽器里是一個(gè)XMLHttpRequest實(shí)例，
      // 在node中是一個(gè)http.ClientRequest實(shí)例
      console.info(e.request)
    }else{
      //發(fā)送請(qǐng)求時(shí)異常，捕捉到錯(cuò)誤
      console.info('error',e.message)
    }
    console.info(e.config)
  })
// 等同以下寫法
axios({
  url: '/user',
   method: 'GET',
  params: {
    ID: 123
  }
}).then( res => {
  console.info(res)
}).catch( e=> {
  console.info(e)
})

POST

axios.post('/user', {
  firstName: 'Mike',
  lastName: 'Allen'
}).then( res => {
  console.info(res)
}).catch( e => {
  console.info(e)
})
// 等同以下寫法
axios({
  url: '/user',
  method: 'POST',
  data: {
    firstName: 'Mike',
    lastName: 'Allen'
  }
}).then( res => {
  console.info(res)
}).catch( e => {
  console.info(e)
})

注意事項(xiàng)

在使用GET方法傳遞參數(shù)時(shí)使用的是params，并且官方文檔中介紹為：params are the URL parameters to be sent with the request. Must be a plain object or a URLSearchParams object。譯為：params作為URL鏈接中的參數(shù)發(fā)送請(qǐng)求，且其必須是一個(gè)plain object或者是URLSearchParams object。plain object（純對(duì)象）是指用JSON形式定義的普通對(duì)象或者new Object()創(chuàng)建的簡(jiǎn)單對(duì)象；而URLSearchParams object指的是一個(gè)可以由URLSearchParams接口定義的一些實(shí)用方法來(lái)處理 URL 的查詢字符串的對(duì)象，也就是說(shuō)params傳參是以/user?ID=1&name=mike&sex=male形式傳遞的。

而在使用POST時(shí)對(duì)應(yīng)的傳參使用的是data，data是作為請(qǐng)求體發(fā)送的，同樣使用這種形式的還有PUT,PATCH等請(qǐng)求方式。有一點(diǎn)需要注意的是，axios中POST的默認(rèn)請(qǐng)求體類型為Content-Type:application/json（JSON規(guī)范流行），這也是最常見的請(qǐng)求體類型，也就是說(shuō)使用的是序列化后的json格式字符串來(lái)傳遞參數(shù)，如：{ "name" : "mike", "sex" : "male" }；同時(shí)，后臺(tái)必須要以支持@RequestBody的形式接收參數(shù)，否則會(huì)出現(xiàn)前臺(tái)傳參正確，后臺(tái)接收不到的情況。

如果想要設(shè)置類型為Content-Type:application/x-www-form-urlencoded（瀏覽器原生支持），axios提供了兩種方式，如下：

瀏覽器端

const params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/user', params);

不過(guò)，并不是所有瀏覽器都支持URLSearchParams，兼容性查詢caniuse.com，但是這里有一個(gè)Polyfill (polyfill:用于實(shí)現(xiàn)瀏覽器并不支持的原生API的代碼，可以模糊理解為補(bǔ)丁，同時(shí)要確保polyfill在全局環(huán)境中)。

或者，你也可以用qs這個(gè)庫(kù)來(lái)格式化數(shù)據(jù)。默認(rèn)情況下在安裝完axios后就可以使用qs庫(kù)。

const qs = require('qs');
axios.post('/user', qs.stringify({'name':'mike'}));

node層

在node環(huán)境中可以使用querystring。同樣，也可以用qs來(lái)格式化數(shù)據(jù)。

const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({'name':'mike'}));

補(bǔ)充

常見的請(qǐng)求體類型還有一種方式，即multipart/form-data（瀏覽器原生支持），也就是提交表單數(shù)據(jù)常用的一種格式。和x-www-form-urlencoded對(duì)比起來(lái)，后者則是數(shù)據(jù)被編碼成以 '&' 分隔的鍵-值對(duì), 同時(shí)以 '=' 分隔鍵和值。非字母或數(shù)字的字符會(huì)被Percent-encoding（URL encoding），這也就是為什么這種類型不支持二進(jìn)制數(shù)據(jù)的原因 (應(yīng)使用 multipart/form-data 代替)。

最新評(píng)論