axios是一個基於Promise對象,同時支持瀏覽器端和Node.js的HTTP庫,常用語Ajax請求,簡單來理解:實現Ajax功能的基礎上,將http請求引入到了後臺開發;Axios項目地址
瞭解過Vue.js開發的應該知道,Vue.js不像jQuery JQuery在線手冊或者AngularJs,Vue.js本身是沒有Ajax方法的,因此在Vue開發中實現http接口的請求需要藉助插件或者第三方http庫;相對比而言,Axios就是一個很不錯的選擇;
1.簡單安裝
// 採用node.js中常用的npm安裝(install可簡寫i)
npm install axios --save
// 採用bower或者yarn來安裝(還沒有使用過,大同小異)
bower install axios
yarn add axios
// 直接使用cdn安裝引入到script中(較簡單)
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
2.Axios的重要特點
- 從瀏覽器中創建 XMLHttpRequests
- 從 node.js 創建 http 請求
- 支持 Promise API
- 攔截請求和響應
- 轉換請求數據和響應數據
- 取消請求
- 自動轉換 JSON 數據
- 客戶端支持防禦 XSRF(如果熟悉egg的,這裏可以轉門用來處理post,put,delete的csrf安全)
3.Axios方法別名
方法別名舉例:
//在ajax中常用post請求爲如下格式
$.ajax({
url:'....',//接口地址
type:'post',// 接口請求類型
data:{ //接口參數
.....
},
success:function(data){ //接口響應成功回調方法,放回data參數
},
//省略常用錯誤處理error回調方法
})
// 和Axios一樣ajax也是有別名的,相比以上的格式,別名提供的就直接如下
$.post('//請求地址',{
// 參數
},function(data){
//回調執行方法
});
與上面類似,axios提供的別名有:
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]])
4.Axios與ajxa請求舉例:
//ajax的get請求
$.get('地址','參數','回調方法');
$.ajax({
url:'',
type:'get',
data:{
// 請求數據
},
success:function(data){
// 請求成功,狀態碼爲200時候觸發
},
error:function(error){
// 請求出現異常時,觸發;
}
})
// axios請求get,與ajax差不多
axios.get('/user?ID=12345')
.then(function (response) {
//請求成功,未出現異常時候的響應
console.log(response);
})
.catch(function (error) {
// 出現異常,進行捕獲,響應;
console.log(error);
});
// 可選地,上面的請求可以這樣做,即:請求參數的傳遞,注意get中的param參數傳遞;
axios.get('/user', {
params: {
// 參數傳遞,以ID爲鍵
ID: 12345
}
})
.then(function (response) {
//請求成功,未出現異常時候的響應
console.log(response);
})
.catch(function (error) {
// 出現異常,進行捕獲,響應;
console.log(error);
});
------------------------------------------------------------------------------------------------
// axios中post請求傳參和比較
axios.post('/user', {
firstName: 'Fred',
lastName: 'Flintstone'
}).then(function (response) {
//請求成功,未出現異常時候的響應
console.log(response);
}).catch(function (error) {
//請求成功,未出現異常時候的響應
console.log(error);
});
//也可以通過鍵值對的方式傳參
axios.post('/user',{
data:{// data爲鍵
......
}
}).then(function(response){
// 執行成功,響應爲200的時候,執行
}).catch(funciton(error){
// 請求接口出現異常進行捕獲的時候執行;
});
// Notes:對於Egg開發,常見的post,put,delete都需要進行csrf處理,同時支持像post那樣鍵值對或者直接傳參;
併發
處理併發請求的助手函數
axios.all(iterable)
axios.spread(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) {
// 兩個請求現在都執行完成
}))
創建實例
可以使用自定義配置新建一個 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, 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) {
})
}
響應結構
某個請求的響應包含以下信息
{
// `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);
});
在使用 catch
時,或傳遞 rejection callback 作爲 then
的第二個參數時,響應可以通過 error
對象可被使用,正如在錯誤處理這一節所講。
配置的默認值/defaults
你可以指定將被用在各個請求的配置默認值
全局的 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
}
})
取消
使用 cancel token 取消請求
Axios 的 cancel token API 基於cancelable promises proposal,它還處於第一階段。
可以使用 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();
// Note : 可以使用同一個 cancel token 取消多個請求