Vue Axios基本用法
阿新 • • 發佈:2018-12-20
Axios
Axios是一個基於promise的HTTP庫,可以用在瀏覽器和node.js中.
通過npm 使用axios
npm install axios
也可以在專案中使用cdn引入axios
get請求
// 不指定post和get方式,會預設為get方式 axios('/home'); // 指定id的get請求 axios.get('/home?ID=001') .then(function(res){ console.log(res); }) .catch(function(error){ console.log(error); }); // 還可以用下面的形式 axios.get('/home',{ params:{ ID:001 } }).then(function(res){ console.log(res); }).catch(function(error){ console.log(error); });
post請求
axios.post('/home',{
name:'name',
age:18
}).then(function(res){
console.log(res);
}).catch(function(error){
console.log(error);
})
執行多個併發請求
執行多個併發請求時需要用到 axios.all 和 axios.spread
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.create可以建立自定義的請求例項,可以在自定義的例項中重寫各個配置項,以滿足自己的需求.
以下是自定義配置選項:
{ // `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.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);
});