Axios學習筆記之使用方法教程

$ bower install axios

$ npm install axios

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

// 可選地，上面的請求可以這樣做
axios.get('/user', {
 params: {
 ID: 12345
 }
 })
 .then(function (response) {
 console.log(response);
 })
 .catch(function (error) {
 console.log(error);
 });

axios.post('/user', {
 firstName: 'Fred',
 lastName: 'Flintstone'
 })
 .then(function (response) {
 console.log(response);
 })
 .catch(function (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) {
 // 兩個請求現在都執行完成
 }));

 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]])

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

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` 是用于請求的服務器 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: {}
}

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);
 });

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;

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

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

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

// 添加請求攔截器
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);

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);
 });

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

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

var CancelToken = axios.CancelToken;
var cancel;

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

// 取消請求
cancel();