vue的axios是幹什麼的

2022-03-03 19:01:17

在vue中,axios是一個基於promise的HTTP庫,主要用於實現AJAX非同步通訊功能;axios可以在瀏覽器中傳送XMLHttpRequests請求,可以在nodejs中傳送http請求,還可以攔截請求和響應、轉換請求和響應資料。

本教學操作環境:windows7系統、vue2.9.6版,DELL G3電腦。

axios:前端通訊框架,因為vue的邊界很明確,就是為了處理DOM,所以並不具備通訊功能,此時就需要額外使用一個通訊框架與伺服器互動;當然也可以使用jQuery提供的AJAX通訊功能。

1.png

Axios是一個基於 promise 的 HTTP 庫,簡單的講就是可以傳送get、post請求。

說到get、post,大家應該第一時間想到的就是Jquery吧,畢竟前幾年Jquery比較火的時候,大家都在用他。但是由於Vue、React等框架的出現,Jquery也不是那麼吃香了。也正是Vue、React等框架的出現,促使了Axios輕量級庫的出現,因為Vue等,不需要操作Dom,所以不需要引入Jquery.js了。

Axios特性

1、可以在瀏覽器中傳送 XMLHttpRequests

2、可以在 node.js 傳送 http 請求

3、支援 Promise API

4、攔截請求和響應

5、轉換請求資料和響應資料

6、能夠取消請求

7、自動轉換 JSON 資料

8、使用者端支援保護安全免受 XSRF 攻擊

Axios用在什麼場景?

在特性裡面已經有提到,瀏覽器傳送請求,或者Node.js傳送請求都可以用到Axios。像Vue、React、Node等專案就可以使用Axios,如果你的專案裡面用了Jquery,此時就不需要多此一舉了,jquery裡面本身就可以傳送請求。

Axios如何使用?

安裝模組

npm install axios

或者直接引入

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

引入模組後可以直接使用

範例(一)

// GET
axios.get('/user', {
  params: {
    ID: 12345
  }
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});
// POST
axios.post('/user', {
  name: 'Javan',
  website: 'www.javanx.cn'
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});

上面的引數是可選的

如果你想並行多個請求,可以看下方程式碼

function getUserAccount() {
  return axios.get('/user/12345');
}
function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}
axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {
    // 兩個請求都執行完成才會執行
  }));

範例(二)

除了上面的方式外,你可以通過向 axios 傳遞相關設定來建立請求,如:

// POST
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

語法

axios(url[, config])

config

{
  // `url` 是用於請求的伺服器 URL
  url: '/user',
  // `method` 是建立請求時使用的方法
  method: 'get', // 預設是 get
  // `baseURL` 將自動加在 `url` 前面,除非 `url` 是一個絕對 URL。
  // 它可以通過設定一個 `baseURL` 便於為 axios 範例的方法傳遞相對 URL
  baseURL: 'https://some-domain.com/api/',
  // `transformRequest` 允許在向伺服器傳送前,修改請求資料
  // 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個請求方法
  // 後面陣列中的函數必須返回一個字串,或 ArrayBuffer,或 Stream
  transformRequest: [function (data) {
    // 對 data 進行任意轉換處理
    return data;
  }],
  // `transformResponse` 在傳遞給 then/catch 前,允許修改響應資料
  transformResponse: [function (data) {
    // 對 data 進行任意轉換處理
    return data;
  }],
  // `headers` 是即將被傳送的自定義請求頭
  headers: {'X-Requested-With': 'XMLHttpRequest'},
  // `params` 是即將與請求一起傳送的 URL 引數
  // 必須是一個無格式物件(plain object)或 URLSearchParams 物件
  params: {
    ID: 12345
  },
  // `paramsSerializer` 是一個負責 `params` 序列化的函數
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },
  // `data` 是作為請求主體被傳送的資料
  // 只適用於這些請求方法 'PUT', 'POST', 和 'PATCH'
  // 在沒有設定 `transformRequest` 時,必須是以下型別之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 瀏覽器專屬:FormData, File, Blob
  // - Node 專屬: Stream
  data: {
    firstName: 'Fred'
  },
  // `timeout` 指定請求超時的毫秒數(0 表示無超時時間)
  // 如果請求話費了超過 `timeout` 的時間,請求將被中斷
  timeout: 1000,
  // `withCredentials` 表示跨域請求時是否需要使用憑證
  withCredentials: false, // 預設的
  // `adapter` 允許自定義處理請求,以使測試更輕鬆
  // 返回一個 promise 並應用一個有效的響應 (查閱 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },
  // `auth` 表示應該使用 HTTP 基礎驗證,並提供憑據
  // 這將設定一個 `Authorization` 頭,覆寫掉現有的任意使用 `headers` 設定的自定義 `Authorization`頭
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },
  // `responseType` 表示伺服器響應的資料型別,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // 預設的
  // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名稱
  xsrfCookieName: 'XSRF-TOKEN', // default
  // `xsrfHeaderName` 是承載 xsrf token 的值的 HTTP 頭的名稱
  xsrfHeaderName: 'X-XSRF-TOKEN', // 預設的
  // `onUploadProgress` 允許為上傳處理進度事件
  onUploadProgress: function (progressEvent) {
    // 對原生進度事件的處理
  },
  // `onDownloadProgress` 允許為下載處理進度事件
  onDownloadProgress: function (progressEvent) {
    // 對原生進度事件的處理
  },
  // `maxContentLength` 定義允許的響應內容的最大尺寸
  maxContentLength: 2000,
  // `validateStatus` 定義對於給定的HTTP 響應狀態碼是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者設定為 `null` 或 `undefined`),promise 將被 resolve; 否則,promise 將被 rejecte
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 預設的
  },
  // `maxRedirects` 定義在 node.js 中 follow 的最大重定向數目
  // 如果設定為0,將不會 follow 任何重定向
  maxRedirects: 5, // 預設的
  // `httpAgent` 和 `httpsAgent` 分別在 node.js 中用於定義在執行 http 和 https 時使用的自定義代理。允許像這樣設定選項:
  // `keepAlive` 預設沒有啟用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),
  // 'proxy' 定義代理伺服器的主機名稱和埠
  // `auth` 表示 HTTP 基礎驗證應當用於連線代理,並提供憑據
  // 這將會設定一個 `Proxy-Authorization` 頭,覆寫掉已有的通過使用 `header` 設定的自定義 `Proxy-Authorization` 頭。
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },
  // `cancelToken` 指定用於取消請求的 cancel token
  // (檢視後面的 Cancellation 這節瞭解更多)
  cancelToken: new CancelToken(function (cancel) {
  })
}

範例(三)

我們還可以使用自定義設定新建一個 axios 範例,並且可以在請求或響應被 then 或 catch 處理前攔截它們。

// 如檔名叫http.js
import axios from 'axios'
// 建立範例時設定設定的預設值
var instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});
// 新增請求攔截器
instance.interceptors.request.use(function (config) {
  // 在傳送請求之前做些什麼
  /**
    1、比如新增token之類的請求頭資訊
    2、新增每次請求loading等
  */
  return config;
}, function (error) {
  // 對請求錯誤做些什麼
  return Promise.reject(error);
});
// 新增響應攔截器
instance.interceptors.response.use(function (response) {
  // 對響應資料做點什麼
  /**
    1、集中處理響應資料(如錯誤碼處理)
  */
  return response;
}, function (error) {
  // 對響應錯誤做點什麼
  return Promise.reject(error);
});
export default instance

如何使用上面的http.js???

import http from 'xxx/http'
http({
  method: 'POST',
  url: '/user',
  data: {
    name: 'Javan',
    website: 'www.javanx.cn'
  }
}).then((response) => {
  // 200響應
}, (err) => {
  // 500響應
})

範例(四)

如何取消介面???

場景:一個搜尋方塊,每次輸入字元都會呼叫介面,這時候沒有辦法來知道那個介面資料放回是最後一次的,只能取消之前發起的相同介面,所以就有了取消介面。

var CancelToken = axios.CancelToken;
var source = CancelToken.source();
axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // 處理錯誤
  }
});
// 取消請求(message 引數是可選的)
source.cancel('Operation canceled by the user.');

總結

Axios可以說把請求這件事做到了極致,封裝的很好用,目前下載次數:4,784,599次,github star:60,584次。足矣說明開發者們還是很喜歡他的。瀏覽器支援方法,除了IE低版本以外,最新版的瀏覽器都是支援的。

(學習視訊分享:、)

以上就是vue的axios是幹什麼的的詳細內容,更多請關注TW511.COM其它相關文章!