axios · liuyichi

隨著 vuejs 作者尤雨溪發布消息，不再繼續維護vue-resource，并推薦大家使用 axios 開始，axios 被越來越多的人所了解。本來想在網上找找詳細攻略，突然發現，axios 的官方文檔本身就非常詳細！！有這個還要什么自行車！！所以推薦大家學習這種庫，最好詳細閱讀其官方文檔。大概翻譯了一下 axios 的官方文檔，相信大家只要吃透本文再加以實踐，axios 就是小意思啦！！如果您覺得本文對您有幫助，不妨點個贊或關注收藏一下，您的鼓勵對我非常重要。 ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#axios-%E7%AE%80%E4%BB%8B "axios 簡介")axios 簡介 axios 是一個基于Promise 用于瀏覽器和 nodejs 的 HTTP 客戶端，它本身具有以下特征： * * * * 從瀏覽器中創建 XMLHttpRequest * 從 node.js 發出 http 請求 * 支持 Promise API * 攔截請求和響應 * 轉換請求和響應數據 * 取消請求 * 自動轉換JSON數據 * 客戶端支持防止[CSRF/XSRF](http://baike.baidu.com/link?url=iUceAfgyfJOacUtjPgT4ifaSOxDULAc_MzcLEOTySflAn5iLlHfMGsZMtthBm5sK4y6skrSvJ1HOO2qKtV1ej_) ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%B5%8F%E8%A7%88%E5%99%A8%E5%85%BC%E5%AE%B9%E6%80%A7 "瀏覽器兼容性")瀏覽器兼容性 [![](https://user-gold-cdn.xitu.io/2017/2/26/14fd63190880bcb74969d61a4f47b0f9.png?imageView2/0/w/1280/h/960/format/webp/ignore-error/1)](http://p1.bpimg.com/567571/991b798df8c9a528.png) ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E5%BC%95%E5%85%A5%E6%96%B9%E5%BC%8F%EF%BC%9A "引入方式：")引入方式： ~~~ $ npm install axios$ cnpm install axios //taobao源$ bower install axios或者使用cdn：<script src="https://unpkg.com/axios/dist/axios.min.js"></script> ~~~ ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E4%B8%BE%E4%B8%AA%E6%A0%97%E5%AD%90%EF%BC%9A "舉個栗子：")舉個栗子： * * * ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%89%A7%E8%A1%8C-GET-%E8%AF%B7%E6%B1%82 "執行 GET 請求")執行 GET 請求 ~~~ // 向具有指定ID的用戶發出請求axios.get('/user?ID=12345') .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });// 也可以通過 params 對象傳遞參數axios.get('/user', { params: { ID: 12345 } }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%89%A7%E8%A1%8C-POST-%E8%AF%B7%E6%B1%82 "執行 POST 請求")執行 POST 請求 ~~~ axios.post('/user', { firstName: 'Fred', lastName: 'Flintstone' }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%89%A7%E8%A1%8C%E5%A4%9A%E4%B8%AA%E5%B9%B6%E5%8F%91%E8%AF%B7%E6%B1%82 "執行多個并發請求")執行多個并發請求 ~~~ 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) { //兩個請求現已完成 })); ~~~ ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#axios-API "axios API")axios API * * * 可以通過將相關配置傳遞給 axios 來進行請求。 ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#axios-config "axios(config)")axios(config) ~~~ // 發送一個 POST 請求axios({ method: 'post', url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' }}); ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#axios-url-config "axios(url[, config])")axios(url\[, config\]) ~~~ // 發送一個 GET 請求 (GET請求是默認請求模式)axios('/user/12345'); ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E8%AF%B7%E6%B1%82%E6%96%B9%E6%B3%95%E5%88%AB%E5%90%8D "請求方法別名")請求方法別名為了方便起見，已經為所有支持的請求方法提供了別名。 * 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\]\]） **注意** 當使用別名方法時，不需要在config中指定url，method和data屬性。 ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E5%B9%B6%E5%8F%91 "并發")并發幫助函數處理并發請求。 * axios.all（iterable） * axios.spread（callback） ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E5%88%9B%E5%BB%BA%E5%AE%9E%E4%BE%8B "創建實例")創建實例您可以使用自定義配置創建axios的新實例。 axios.create（\[config\]） ~~~ var instance = axios.create({ baseURL: 'https://some-domain.com/api/', timeout: 1000, headers: {'X-Custom-Header': 'foobar'}}); ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E5%AE%9E%E4%BE%8B%E6%96%B9%E6%B3%95 "實例方法")實例方法可用的實例方法如下所示。指定的配置將與實例配置合并。 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\]\]） ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E8%AF%B7%E6%B1%82%E9%85%8D%E7%BD%AE "請求配置")請求配置 * * * 這些是用于發出請求的可用配置選項。只有url是必需的。如果未指定方法，請求將默認為GET。 ~~~ { // `url`是將用于請求的服務器URL url: '/user', // `method`是發出請求時使用的請求方法 method: 'get', // 默認 // `baseURL`將被添加到`url`前面，除非`url`是絕對的。 // 可以方便地為 axios 的實例設置`baseURL`，以便將相對 URL 傳遞給該實例的方法。 baseURL: 'https://some-domain.com/api/', // `transformRequest`允許在請求數據發送到服務器之前對其進行更改 // 這只適用于請求方法'PUT'，'POST'和'PATCH' // 數組中的最后一個函數必須返回一個字符串，一個 ArrayBuffer或一個 Stream transformRequest: [function (data) { // 做任何你想要的數據轉換 return data; }], // `transformResponse`允許在 then / catch之前對響應數據進行更改 transformResponse: [function (data) { // Do whatever you want to transform the data return data; }], // `headers`是要發送的自定義 headers headers: {'X-Requested-With': 'XMLHttpRequest'}, // `params`是要與請求一起發送的URL參數 // 必須是純對象或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 // - Browser only: FormData, File, Blob // - Node only: Stream data: { firstName: 'Fred' }, // `timeout`指定請求超時之前的毫秒數。 // 如果請求的時間超過'timeout'，請求將被中止。 timeout: 1000, // `withCredentials`指示是否跨站點訪問控制請求 // should be made using credentials withCredentials: false, // default // `adapter'允許自定義處理請求，這使得測試更容易。 // 返回一個promise并提供一個有效的響應（參見[response docs]（＃response-api）） adapter: function (config) { /* ... */ }, // `auth'表示應該使用 HTTP 基本認證，并提供憑據。 // 這將設置一個`Authorization'頭，覆蓋任何現有的`Authorization'自定義頭，使用`headers`設置。 auth: { username: 'janedoe', password: 's00pers3cret' }, // “responseType”表示服務器將響應的數據類型 // 包括 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream' responseType: 'json', // default //`xsrfCookieName`是要用作 xsrf 令牌的值的cookie的名稱 xsrfCookieName: 'XSRF-TOKEN', // default // `xsrfHeaderName`是攜帶xsrf令牌值的http頭的名稱 xsrfHeaderName: 'X-XSRF-TOKEN', // default // `onUploadProgress`允許處理上傳的進度事件 onUploadProgress: function (progressEvent) { // 使用本地 progress 事件做任何你想要做的 }, // `onDownloadProgress`允許處理下載的進度事件 onDownloadProgress: function (progressEvent) { // Do whatever you want with the native progress event }, // `maxContentLength`定義允許的http響應內容的最大大小 maxContentLength: 2000, // `validateStatus`定義是否解析或拒絕給定的promise // HTTP響應狀態碼。如果`validateStatus`返回`true`（或被設置為`null` promise將被解析;否則，promise將被??// 拒絕。 validateStatus: function (status) { return status >= 200 && status < 300; // default }, // `maxRedirects`定義在node.js中要遵循的重定向的最大數量。 // 如果設置為0，則不會遵循重定向。 maxRedirects: 5, // 默認 // `httpAgent`和`httpsAgent`用于定義在node.js中分別執行http和https請求時使用的自定義代理。 // 允許配置類似`keepAlive`的選項， // 默認情況下不啟用。 httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }), // 'proxy'定義代理服務器的主機名和端口 // `auth`表示HTTP Basic auth應該用于連接到代理，并提供credentials。 // 這將設置一個`Proxy-Authorization` header，覆蓋任何使用`headers`設置的現有的`Proxy-Authorization` 自定義 headers。 proxy: { host: '127.0.0.1', port: 9000, auth: : { username: 'mikeymike', password: 'rapunz3l' } }, // “cancelToken”指定可用于取消請求的取消令牌 // (see Cancellation section below for details) cancelToken: new CancelToken(function (cancel) { })} ~~~ 使用 then 時，您將收到如下響應： ~~~ axios.get('/user/12345') .then(function(response) { console.log(response.data); console.log(response.status); console.log(response.statusText); console.log(response.headers); console.log(response.config); }); ~~~ ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E9%85%8D%E7%BD%AE%E9%BB%98%E8%AE%A4%E5%80%BC "配置默認值")配置默認值 * * * 您可以指定將應用于每個請求的配置默認值。 ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E5%85%A8%E5%B1%80axios%E9%BB%98%E8%AE%A4%E5%80%BC "全局axios默認值")全局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'; ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%9E%E4%BE%8B%E9%BB%98%E8%AE%A4%E5%80%BC "自定義實例默認值")自定義實例默認值 ~~~ //在創建實例時設置配置默認值 var instance = axios.create（{?? baseURL：'https://api.example.com'}）; ?//在實例創建后改變默認值 instance.defaults.headers.common ['Authorization'] = AUTH_TOKEN; ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E9%85%8D%E7%BD%AE%E4%BC%98%E5%85%88%E7%BA%A7%E9%A1%BA%E5%BA%8F "配置優先級順序")配置優先級順序配置將與優先順序合并。順序是lib / defaults.js中的庫默認值，然后是實例的defaults屬性，最后是請求的config參數。后者將優先于前者。這里有一個例子。 ~~~ //使用庫提供的配置默認值創建實例//此時，超時配置值為`0`，這是庫的默認值var instance = axios.create（）;?//覆蓋庫的超時默認值//現在所有請求將在超時前等待2.5秒instance.defaults.timeout = 2500;?//覆蓋此請求的超時，因為它知道需要很長時間instance.get（'/ longRequest'，{?? timeout：5000}）; ~~~ ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%8B%A6%E6%88%AA%E5%99%A8 "攔截器")攔截器 * * * 你可以截取請求或響應在被 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 () {/*...*/}); ~~~ ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E5%A4%84%E7%90%86%E9%94%99%E8%AF%AF "處理錯誤")處理錯誤 * * * ~~~ 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 {?????? //在設置觸發錯誤的請求時發生了錯誤?????? console.log（'Error'，error.message）;???? }}???? console.log（error.config）;?? }）; ~~~ 您可以使用validateStatus配置選項定義自定義HTTP狀態碼錯誤范圍。 ~~~ axios.get（'/ user / 12345'，{?? validateStatus：function（status）{???? return status < 500; //僅當狀態代碼大于或等于500時拒絕?? }}}） ~~~ ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%B6%88%E9%99%A4 "消除")消除 * * * 您可以使用取消令牌取消請求。 > axios cancel token API基于可取消的promise提議，目前處于階段1。您可以使用CancelToken.source工廠創建一個取消令牌，如下所示： ~~~ 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 { // 處理錯誤 }});//取消請求（消息參數是可選的）source.cancel（'操作被用戶取消。'）; ~~~ 您還可以通過將執行器函數傳遞給CancelToken構造函數來創建取消令牌： ~~~ var CancelToken = axios.CancelToken;var cancel;?axios.get（'/ user / 12345'，{?? cancelToken：new CancelToken（function executor（c）{???? //一個執行器函數接收一個取消函數作為參數???? cancel = c;?? }）}）;?// 取消請求clear(); ~~~ > 注意：您可以使用相同的取消令牌取消幾個請求。 ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E4%BD%BF%E7%94%A8application-x-www-form-urlencoded%E6%A0%BC%E5%BC%8F "使用application / x-www-form-urlencoded格式")使用application / x-www-form-urlencoded格式 * * * 默認情況下，axios將JavaScript對象序列化為JSON。要以應用程序/ x-www-form-urlencoded格式發送數據，您可以使用以下選項之一。 ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#%E6%B5%8F%E8%A7%88%E5%99%A8 "瀏覽器")瀏覽器在瀏覽器中，您可以使用URLSearchParams API，如下所示： ~~~ var params = new URLSearchParams();params.append('param1', 'value1');params.append('param2', 'value2');axios.post('/foo', params); ~~~ > 請注意，所有瀏覽器都不支持URLSearchParams，但是有一個polyfill可用（確保polyfill全局環境）。或者，您可以使用qs庫對數據進行編碼： ~~~ var qs = require('qs');axios.post('/foo', qs.stringify({ 'bar': 123 }); ~~~ ### [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#Node-js "Node.js")Node.js 在node.js中，可以使用querystring模塊，如下所示： ~~~ var querystring = require('querystring');axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }); ~~~ 你也可以使用qs庫。 ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#Promise "Promise")Promise * * * axios 依賴本機要支持ES6 Promise實現。如果您的環境不支持ES6 Promises，您可以使用polyfill。 ## [](https://juejin.im/entry/58b2532f2f301e006c0a2d80#TypeScript "TypeScript")TypeScript * * * axios包括TypeScript定義。 ~~~ import axios from 'axios';axios.get('/user?ID=12345'); ~~~ * * * axios在很大程度上受到Angular提供的$http服務的啟發。最終，axios努力提供一個在Angular外使用的獨立的$http-like服務。