1.什么是axios?
axios是一個基於promise的HTTP庫，可用在瀏覽器和Node.js中
2.axios基本用法
2.1 安裝axios
1 npm install axios
2.2 引入axios
1 import axios from 'axios';
2.3 axios提供的請求方式
1 axios.request(config) 2 3 axios.get(url[, config]) 4 5 axios.delete(url[, config]) 6 7 axios.head(url[, config]) 8 9 axios.post(url[, data[, config]]) 10 11 axios.put(url[, data[, config]]) 12 13 axios.patch(url[, data[, config]])
常用的只有get/post 方法
2.4 配置config文件（請求配置）
此處的config是對一些基本信息的配置，例如請求頭，baseURL等
// 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 .post(url,{},config) .then(function(res) { console.log(res); }) .catch(function(err) { console.log(err); }); // axios請求返回的也是一個promise，跟蹤錯誤只需要在最后加一個catch即可
2.5 同時發起多個請求處理（並發）
axios.all(iterable); // iterable為請求函數
axios.spread(callback); // callback為請求成功后的處理函數
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){ // 只有兩個請求都完成才會成功，否則會被catch捕獲 }));
2.6 創建實例
可以使用自定義的配置新建一個axios實例：axios.create([config]);
// 創建實例 var instance = axios.create({ baseURL: 'https://some-domain.com/api/', timeout: 1000, headers: {'X-Custom-Header': 'foobar'} });
2.7 響應結構
// 某個請求的響應包含以下信息 { // `data` 由服務器提供的響應 data: {}, // `status` 來自服務器響應的 HTTP 狀態碼 status: 200, // `statusText` 來自服務器響應的 HTTP 狀態信息 statusText: 'OK', // `headers` 服務器響應的頭 headers: {}, // `config` 是為請求提供的配置信息 config: {} }
當使用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); });
2.8 錯誤處理
// 錯誤處理 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); });
2.9 配置默認值（default）
可以指定各請求方式的默認值
2.9.1 配置全局的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';
2.9.2 配置自定義實例的默認值
// 自定義實例默認值 // 創建實例時設置的默認值 var instance = axios.create({ baseURL:'https://api.example.com', }); // 創建實例后修改默認值 instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
2.9.3 配置的優先級
配置信息會以一個優先順序進行合並。這個優先級順序是：
首先ib/defaults.js找到的庫的默認值 < 然后實例的default屬性 < 最后請求的config參數
例子：
// 使用由庫提供的配置默認值來創建實例。此時超時配置的默認值是 `0` var instance = axios.create(); // 覆寫庫的超時默認值。現在在超時前所有請求都會等待 2.5 秒 instance.defaults.timeout = 2500; // 為已知需要花費很長時間的請求覆寫超時設置 instance.get('/longRequest', { timeout: 5000 });
2.10 攔截器
2.10.1 在請求或響應被 then 或 catch 處理前攔截它們
// 添加請求攔截器 axios.interceptors.requset.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); } );
2.10.2 為自定義axios實例添加攔截器
// 為自定義的axios實例添加攔截器 var instance = axios.create(); // 創建axios實例 instance.interceptors.requset.use(function() {/*...*/});
2.10.3 移除攔截器
// 移除攔截器 var myInterceptor = axios.interceptors.request.use(function() {/*...*/}); // 添加請求攔截器 axios.interceptors.requset.eject(myInterceptor); // 移除攔截器