HTTP庫Axios

来源:http://www.cnblogs.com/xiaohuochai/archive/2017/10/05/7628756.html
-Advertisement-
Play Games

[1]概述 [2]使用 [3]API [4]實例方法 [5]響應結構 [6]配置預設值 [7]攔截器 [8]錯誤處理 [9]取消 ...


前面的話

　　本文將詳細介紹HTTP庫Axios

 

概述

　　Axios 是一個基於 promise 的 HTTP 庫，可以用在瀏覽器和 node.js 中

【安裝】

　　在Vue中使用，最好安裝兩個模塊axios 和vue-axios

$ npm install axios vue-axios --save

　　然後引用並使用模塊

import Axios from 'axios'
import VueAxios from 'vue-axios'
Vue.use(VueAxios,Axios)

　　在組件中通過如下方式進行使用

this.$http[method]()

【特性】

　　1、可以從瀏覽器中創建XHR對象

　　2、可以從nodeJS中創建HTTP請求

　　3、支持Promise API 

　　4、可以攔截請求和響應

　　5、可以轉換請求數據和響應數據

　　6、可以取消請求

　　7、可以自動轉換JSON數據

　　8、客戶端支持防禦XSRF

 

使用

　　下麵是一些簡單的請求實例

【get請求】

　　僅僅向後端請求數據

axios.get('index.php')
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

　　通過URL向後端發送數據，要使用params屬性，params屬性包含即將與請求一起發送的數據

　　運行下列代碼後，請求URL變更為index.php?id=12345&text=%E5%B0%8F%E7%81%AB%E6%9F%B4

axios.get('index.php',{
  params:{
    id:12345,
　　 text:'小火柴'
  }
}).then((response)=>{
  console.log(response)
}).catch((error)=>{
  console.log(error)
})

　　當然，也可以把數據直接寫到URL中

// 為給定 ID 的 user 創建請求
axios.get('/user?ID=12345')
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

【post請求】

　　一般來說，post請求更多的是要提交數據，params屬性里的數據會出現在請求主體中

　　[註意]如果是axios.create()方法中的params屬性，則其裡面的數據會出現在URL參數中

　　但實際上，post方法不需要使用params屬性，它的第二個參數就是要發送的數據

axios.post('index.php',{
  id:12345,
  text:'小火柴'
}).then((response)=>{
  console.log(response)
}).catch((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) {
    // acct為第一個請求的結果，perms為第二個請求的結果
  }));

 

API

【axios()】

　　可以通過向 axios 傳遞相關配置來創建請求

axios(config)

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

axios(url[,config])

// 發送 GET 請求（預設的方法）
axios('/user/12345');

【別名】

　　為方便起見，為所有支持的請求方法提供了別名

axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

　　[註意]在使用別名方法時， url、method、data 這些屬性都不必在配置中指定

【併發】

　　處理併發請求的助手函數

axios.all(iterable)
axios.spread(callback)

 

實例方法

【創建實例】

　　可以使用自定義配置新建一個 axios 實例

axios.create([config])
var instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

【實例方法】

　　以下是可用的實例方法。指定的配置將與實例的配置合併

axios#request(config)
axios#get(url[, config])
axios#delete(url[, config])
axios#head(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])

【請求配置】

　　這些是創建請求時可以用的配置選項。只有 url 是必需的。如果沒有指定 method，請求將預設使用 get 方法

{
  // `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, URLSearchParam，瀏覽器專屬：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
  cancelToken: new CancelToken(function (cancel) {
  })
}　　

　　下麵是一個實例

let HTTP = axios.create({
  baseURL: 'http://localhost/',
  timeout:1000,
  headers:{
    'author':'xiaohuochai'
  }
})
HTTP.post('index.php',{
  id:12345,
  text:'小火柴'
}).then((response)=>{
  console.log(response)
}).catch((error)=>{
  console.log(error)
})

　　結果如下

 

響應結構

　　某個請求的響應包含以下信息

{
  // `data` 由伺服器提供的響應
  data: {},
  // `status` 來自伺服器響應的 HTTP 狀態碼
  status: 200,
  // `statusText` 來自伺服器響應的 HTTP 狀態信息
  statusText: 'OK',
  // `headers` 伺服器響應的頭
  headers: {},
  // `config` 是為請求提供的配置信息
  config: {}
}

　　使用 then 時，將接收下麵這樣的響應：

  .then(function(response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

 

配置預設值

　　可以指定將被用在各個請求的配置預設值

【全局的axios預設值】

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

【自定義實例預設值】

// 創建實例時設置配置的預設值
var instance = axios.create({
  baseURL: 'https://api.example.com'
});

// 在實例已創建後修改預設值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

【配置優先順序】

　　配置會以一個優先順序進行合併。這個順序是：在 lib/defaults.js 找到的庫的預設值，然後是實例的 defaults 屬性，最後是請求的 config 參數。後者將優先於前者

// 使用由庫提供的配置的預設值來創建實例
// 此時超時配置的預設值是 `0`
var instance = axios.create();

// 覆寫庫的超時預設值
// 現在，在超時前，所有請求都會等待 2.5 秒
instance.defaults.timeout = 2500;

// 為已知需要花費很長時間的請求覆寫超時設置
instance.get('/longRequest', {
  timeout: 5000
});

 

攔截器

　　在請求或響應被 then 或 catch 處理前攔截它們

// 添加請求攔截器
axios.interceptors.request.use(function (config) {
    // 在發送請求之前做些什麼
    return config;
  }, function (error) {
    // 對請求錯誤做些什麼
    return Promise.reject(error);
  });

// 添加響應攔截器
axios.interceptors.response.use(function (response) {
    // 對響應數據做點什麼
    return response;
  }, function (error) {
    // 對響應錯誤做點什麼
    return Promise.reject(error);
  });

　　如果想在稍後移除攔截器，可以這樣：

var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

　　可以為自定義 axios 實例添加攔截器

var instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

 

錯誤處理

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // 請求已發出，但伺服器響應的狀態碼不在 2xx 範圍內
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

　　可以使用 validateStatus 配置選項定義一個自定義 HTTP 狀態碼的錯誤範圍

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 狀態碼在大於或等於500時才會 reject
  }
})

 

取消

　　可以使用 CancelToken.source 工廠方法創建 cancel token，像這樣：

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.');

　　還可以通過傳遞一個 executor 函數到 CancelToken 的構造函數來創建 cancel token

var CancelToken = axios.CancelToken;
var cancel;

axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函數接收一個 cancel 函數作為參數
    cancel = c;
  })
});

// 取消請求
cancel();

　　[註意] 可以使用同一個 cancel token 取消多個請求

　　下麵是一個實例

let CancelToken = axios.CancelToken;
let source = CancelToken.source();
let HTTP = axios.create({
  baseURL: 'http://localhost/',
  params:{
    a:123
  },
})

HTTP.post('index.php',{
  id:12345,
  text:'小火柴'
},{
  cancelToken: source.token,
}).then((response)=>{
  commit('fnChangeList',{listData:response.data})
}).catch(function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    console.log('err');
  }
});
source.cancel('Operation canceled by the user.');

　　最終在控制臺中列印出如下信息

Request canceled Operation canceled by the user.

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 使用JS動態修改網頁body的背景色
    大部分網頁預設的背景色為白色，個人感覺比較刺眼，於是寫了個JS的腳本去改變body部分的背景色，代碼如下： 代碼比較簡單，直接創建了一個body上的css樣式規則，然後添加到head里，如果網頁內容變化或者非同步更新等使樣式被移除時，通過事件監聽機制重新添加到head上。 由於只是簡單地改變了body ...
  • 原生js :removeClass和addClass
    1 function removeClass(obj, aClass) { 2 var re = new RegExp('\\b' + aClass + '\\b'); 3 if (obj.className != '') { 4 5 if (re.test(obj.className)) { 6 ...
  • onselectstart和onselect的使用
    1.onselectstart 這個事件主要是用於禁止選擇網頁中的文字。代碼為： document.onselectstart =function(){ return false; } 另外ff/opera不支持此事件，ff可以用css控制：css: body { -moz-user-select: ...
  • web端 css hack（一）
    逢10月小長假，幾天不敲鍵盤，渾身難受。也是有時間分享一下自己遇到的css問題。先說一下什麼css hack 簡單介紹一下css hack： 定義： 一般都是利用各瀏覽器的支持CSS的能力和BUG來進行的，可以分為能力選擇和怪癖選擇(BUG)。 能力通常是指瀏覽器對CSS特性的支持程度，而怪癖是指瀏 ...
  • Angular組件之間的交互
    這篇文章的題材相信已經有很多人寫過，如果你對Angular組件之間的交互瞭如指掌的話，那麼麻煩各位大神多多指教，如果你對Angular組件之間的交互一知半解，或者全然不知，那麼相信這篇文章對一些代碼的解讀對你會有所幫助！ ...
  • css 浮動和清除浮動
    在寫頁面佈局的過程中，浮動是大家經常用的屬性。在好多的排版佈局中都是用的的浮動比如說下麵這些地方都是應用到了浮動。 在我學習浮動的時候可是熬壞了腦筋，在這裡我分享一下我對浮動這塊知識的總結。 一、浮動的定義 使元素脫離文檔流，按照指定的方向（左或右發生移動），直到它的外邊緣碰到包含框或另一個浮動框的 ...
  • 有關前端的一點隨筆
    由於小龍老師讓根據自己會的知識寫一篇文章,可是想了想自己好想不會啥(尷尬..),所以就寫一點簡單的知識點吧 : 一: 先說說定位吧,感覺挺重要的 1相對定位:position:realative(相對於本身沒有定位之前的位置進行移動)有如下1個特點:不脫離文檔流,不影響元素本身的特性,塊級還是塊級, ...
  • 文字溢出時，實現在末尾顯示三個點省略效果
    有時我們會有這樣的需求：當文本內容較多，寬度超出父容器時，就在最後顯示三個點，代表還有東西被摺疊起來了。如下圖 具體實現 HTML 如下 div 樣式如下 簡單加了個邊框，然後居中方便截圖，然後給了個寬度，作為文本寬度的限制 p 的樣式如下 第 2 行表示強制在一行顯示，如果不強制在一行顯示，超出容 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類