Axios學(xué)習(xí)筆記之使用方法教程

$ bower install axios

$ npm install axios

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

// 可選地，上面的請(qǐng)求可以這樣做
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) {
 // 兩個(gè)請(qǐng)求現(xiàn)在都執(zhí)行完成
 }));

 axios(config)
 // 發(fā)送 POST 請(qǐng)求
 axios({
 method: 'post',
 url: '/user/12345',
 data: {
 firstName: 'Fred',
 lastName: 'Flintstone'
 }
 });
 axios(url[, config])

// 發(fā)送 GET 請(qǐng)求（默認(rèn)的方法）

 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` 是用于請(qǐng)求的服務(wù)器 URL
 url: '/user',

 // `method` 是創(chuàng)建請(qǐng)求時(shí)使用的方法
 method: 'get', // 默認(rèn)是 get

 // `baseURL` 將自動(dòng)加在 `url` 前面，除非 `url` 是一個(gè)絕對(duì) URL。
 // 它可以通過設(shè)置一個(gè) `baseURL` 便于為 axios 實(shí)例的方法傳遞相對(duì) URL
 baseURL: 'https://some-domain.com/api/',

 // `transformRequest` 允許在向服務(wù)器發(fā)送前，修改請(qǐng)求數(shù)據(jù)
 // 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個(gè)請(qǐng)求方法
 // 后面數(shù)組中的函數(shù)必須返回一個(gè)字符串，或 ArrayBuffer，或 Stream
 transformRequest: [function (data) {
 // 對(duì) data 進(jìn)行任意轉(zhuǎn)換處理

 return data;
 }],

 // `transformResponse` 在傳遞給 then/catch 前，允許修改響應(yīng)數(shù)據(jù)
 transformResponse: [function (data) {
 // 對(duì) data 進(jìn)行任意轉(zhuǎn)換處理

 return data;
 }],

 // `headers` 是即將被發(fā)送的自定義請(qǐng)求頭
 headers: {'X-Requested-With': 'XMLHttpRequest'},

 // `params` 是即將與請(qǐng)求一起發(fā)送的 URL 參數(shù)
 // 必須是一個(gè)無格式對(duì)象(plain object)或 URLSearchParams 對(duì)象
 params: {
 ID: 12345
 },

 // `paramsSerializer` 是一個(gè)負(fù)責(zé) `params` 序列化的函數(shù)
 // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
 paramsSerializer: function(params) {
 return Qs.stringify(params, {arrayFormat: 'brackets'})
 },

 // `data` 是作為請(qǐng)求主體被發(fā)送的數(shù)據(jù)
 // 只適用于這些請(qǐng)求方法 'PUT', 'POST', 和 'PATCH'
 // 在沒有設(shè)置 `transformRequest` 時(shí)，必須是以下類型之一：
 // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
 // - 瀏覽器專屬：FormData, File, Blob
 // - Node 專屬： Stream
 data: {
 firstName: 'Fred'
 },

 // `timeout` 指定請(qǐng)求超時(shí)的毫秒數(shù)(0 表示無超時(shí)時(shí)間)
 // 如果請(qǐng)求話費(fèi)了超過 `timeout` 的時(shí)間，請(qǐng)求將被中斷
 timeout: 1000,

 // `withCredentials` 表示跨域請(qǐng)求時(shí)是否需要使用憑證
 withCredentials: false, // 默認(rèn)的

 // `adapter` 允許自定義處理請(qǐng)求，以使測(cè)試更輕松
 // 返回一個(gè) promise 并應(yīng)用一個(gè)有效的響應(yīng) (查閱 [response docs](#response-api)).
 adapter: function (config) {
 /* ... */
 },

 // `auth` 表示應(yīng)該使用 HTTP 基礎(chǔ)驗(yàn)證，并提供憑據(jù)
 // 這將設(shè)置一個(gè) `Authorization` 頭，覆寫掉現(xiàn)有的任意使用 `headers` 設(shè)置的自定義 `Authorization`頭
 auth: {
 username: 'janedoe',
 password: 's00pers3cret'
 },

 // `responseType` 表示服務(wù)器響應(yīng)的數(shù)據(jù)類型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
 responseType: 'json', // 默認(rèn)的

 // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名稱
 xsrfCookieName: 'XSRF-TOKEN', // default

 // `xsrfHeaderName` 是承載 xsrf token 的值的 HTTP 頭的名稱
 xsrfHeaderName: 'X-XSRF-TOKEN', // 默認(rèn)的

 // `onUploadProgress` 允許為上傳處理進(jìn)度事件
 onUploadProgress: function (progressEvent) {
 // 對(duì)原生進(jìn)度事件的處理
 },

 // `onDownloadProgress` 允許為下載處理進(jìn)度事件
 onDownloadProgress: function (progressEvent) {
 // 對(duì)原生進(jìn)度事件的處理
 },

 // `maxContentLength` 定義允許的響應(yīng)內(nèi)容的最大尺寸
 maxContentLength: 2000,

 // `validateStatus` 定義對(duì)于給定的HTTP 響應(yīng)狀態(tài)碼是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者設(shè)置為 `null` 或 `undefined`)，promise 將被 resolve; 否則，promise 將被 rejecte
 validateStatus: function (status) {
 return status >= 200 && status < 300; // 默認(rèn)的
 },

 // `maxRedirects` 定義在 node.js 中 follow 的最大重定向數(shù)目
 // 如果設(shè)置為0，將不會(huì) follow 任何重定向
 maxRedirects: 5, // 默認(rèn)的

 // `httpAgent` 和 `httpsAgent` 分別在 node.js 中用于定義在執(zhí)行 http 和 https 時(shí)使用的自定義代理。允許像這樣配置選項(xiàng)：
 // `keepAlive` 默認(rèn)沒有啟用
 httpAgent: new http.Agent({ keepAlive: true }),
 httpsAgent: new https.Agent({ keepAlive: true }),

 // 'proxy' 定義代理服務(wù)器的主機(jī)名稱和端口
 // `auth` 表示 HTTP 基礎(chǔ)驗(yàn)證應(yīng)當(dāng)用于連接代理，并提供憑據(jù)
 // 這將會(huì)設(shè)置一個(gè) `Proxy-Authorization` 頭，覆寫掉已有的通過使用 `header` 設(shè)置的自定義 `Proxy-Authorization` 頭。
 proxy: {
 host: '127.0.0.1',
 port: 9000,
 auth: : {
 username: 'mikeymike',
 password: 'rapunz3l'
 }
 },

 // `cancelToken` 指定用于取消請(qǐng)求的 cancel token
 // （查看后面的 Cancellation 這節(jié)了解更多）
 cancelToken: new CancelToken(function (cancel) {
 })
}

{
 // `data` 由服務(wù)器提供的響應(yīng)
 data: {},

 // `status` 來自服務(wù)器響應(yīng)的 HTTP 狀態(tài)碼
 status: 200,

 // `statusText` 來自服務(wù)器響應(yīng)的 HTTP 狀態(tài)信息
 statusText: 'OK',

 // `headers` 服務(wù)器響應(yīng)的頭
 headers: {},

 // `config` 是為請(qǐng)求提供的配置信息
 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';

// 創(chuàng)建實(shí)例時(shí)設(shè)置配置的默認(rèn)值
var instance = axios.create({
 baseURL: 'https://api.example.com'
});

// 在實(shí)例已創(chuàng)建后修改默認(rèn)值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

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

// 覆寫庫的超時(shí)默認(rèn)值
// 現(xiàn)在，在超時(shí)前，所有請(qǐng)求都會(huì)等待 2.5 秒
instance.defaults.timeout = 2500;

// 為已知需要花費(fèi)很長(zhǎng)時(shí)間的請(qǐng)求覆寫超時(shí)設(shè)置
instance.get('/longRequest', {
 timeout: 5000
});

// 添加請(qǐng)求攔截器
axios.interceptors.request.use(function (config) {
 // 在發(fā)送請(qǐng)求之前做些什么
 return config;
 }, function (error) {
 // 對(duì)請(qǐng)求錯(cuò)誤做些什么
 return Promise.reject(error);
 });

// 添加響應(yīng)攔截器
axios.interceptors.response.use(function (response) {
 // 對(duì)響應(yīng)數(shù)據(jù)做點(diǎn)什么
 return response;
 }, function (error) {
 // 對(duì)響應(yīng)錯(cuò)誤做點(diǎn)什么
 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) {
  // 請(qǐng)求已發(fā)出，但服務(wù)器響應(yīng)的狀態(tài)碼不在 2xx 范圍內(nèi)
  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; // 狀態(tài)碼在大于或等于500時(shí)才會(huì) 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 {
 // 處理錯(cuò)誤
 }
});

// 取消請(qǐng)求（message 參數(shù)是可選的）
source.cancel('Operation canceled by the user.');

var CancelToken = axios.CancelToken;
var cancel;

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

// 取消請(qǐng)求
cancel();