国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 編程 > JavaScript > 正文

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

2019-11-19 16:01:39
字體:
供稿:網(wǎng)友

前言

最近正在學(xué)習(xí)Axios,相信大家都知道Axios 是一個基于 promise 的 HTTP 庫,可以用在瀏覽器和 node.js 中。所以本文將詳細(xì)介紹關(guān)于Axios使用方法的相關(guān)內(nèi)容,分享出來供大家參考學(xué)習(xí),下面話不多說,來一起看看詳細(xì)的介紹:

Axios Github

功能特性

  • 從瀏覽器中創(chuàng)建 XMLHttpRequests
  • 從 node.js 創(chuàng)建 http 請求
  • 支持 Promise API
  • 攔截請求和響應(yīng)
  • 轉(zhuǎn)換請求數(shù)據(jù)和響應(yīng)數(shù)據(jù)
  • 取消請求
  • 自動轉(zhuǎn)換 JSON 數(shù)據(jù)
  • 客戶端支持防御 XSRF

安裝

使用 bower:

$ bower install axios

使用 npm:

$ npm install axios

Example

執(zhí)行 GET 請求

// 為給定 ID 的 user 創(chuàng)建請求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); });

執(zhí)行 POST 請求

axios.post('/user', { firstName: 'Fred', lastName: 'Flintstone' }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });

執(zhí)行多個并發(fā)請求

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) { // 兩個請求現(xiàn)在都執(zhí)行完成 }));

axios API

可以通過向 axios 傳遞相關(guān)配置來創(chuàng)建請求

 axios(config) // 發(fā)送 POST 請求 axios({ method: 'post', url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' } }); axios(url[, config])// 發(fā)送 GET 請求(默認(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]])

NOTE在使用別名方法時, url、method、data 這些屬性都不必在配置中指定。

并發(fā)

處理并發(fā)請求的助手函數(shù)

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

創(chuàng)建實例

可以使用自定義配置新建一個 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]])

請求配置

這些是創(chuàng)建請求時可以用的配置選項。只有 url 是必需的。如果沒有指定 method,請求將默認(rèn)使用 get 方法。

{ // `url` 是用于請求的服務(wù)器 URL url: '/user', // `method` 是創(chuàng)建請求時使用的方法 method: 'get', // 默認(rèn)是 get // `baseURL` 將自動加在 `url` 前面,除非 `url` 是一個絕對 URL。 // 它可以通過設(shè)置一個 `baseURL` 便于為 axios 實例的方法傳遞相對 URL baseURL: 'https://some-domain.com/api/', // `transformRequest` 允許在向服務(wù)器發(fā)送前,修改請求數(shù)據(jù) // 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個請求方法 // 后面數(shù)組中的函數(shù)必須返回一個字符串,或 ArrayBuffer,或 Stream transformRequest: [function (data) { // 對 data 進(jìn)行任意轉(zhuǎn)換處理 return data; }], // `transformResponse` 在傳遞給 then/catch 前,允許修改響應(yīng)數(shù)據(jù) transformResponse: [function (data) { // 對 data 進(jìn)行任意轉(zhuǎn)換處理 return data; }], // `headers` 是即將被發(fā)送的自定義請求頭 headers: {'X-Requested-With': 'XMLHttpRequest'}, // `params` 是即將與請求一起發(fā)送的 URL 參數(shù) // 必須是一個無格式對象(plain object)或 URLSearchParams 對象 params: { ID: 12345 }, // `paramsSerializer` 是一個負(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` 是作為請求主體被發(fā)送的數(shù)據(jù) // 只適用于這些請求方法 'PUT', 'POST', 和 'PATCH' // 在沒有設(shè)置 `transformRequest` 時,必須是以下類型之一: // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams // - 瀏覽器專屬:FormData, File, Blob // - Node 專屬: Stream data: { firstName: 'Fred' }, // `timeout` 指定請求超時的毫秒數(shù)(0 表示無超時時間) // 如果請求話費了超過 `timeout` 的時間,請求將被中斷 timeout: 1000, // `withCredentials` 表示跨域請求時是否需要使用憑證 withCredentials: false, // 默認(rèn)的 // `adapter` 允許自定義處理請求,以使測試更輕松 // 返回一個 promise 并應(yīng)用一個有效的響應(yīng) (查閱 [response docs](#response-api)). adapter: function (config) { /* ... */ }, // `auth` 表示應(yīng)該使用 HTTP 基礎(chǔ)驗證,并提供憑據(jù) // 這將設(shè)置一個 `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) { // 對原生進(jìn)度事件的處理 }, // `onDownloadProgress` 允許為下載處理進(jìn)度事件 onDownloadProgress: function (progressEvent) { // 對原生進(jìn)度事件的處理 }, // `maxContentLength` 定義允許的響應(yīng)內(nèi)容的最大尺寸 maxContentLength: 2000, // `validateStatus` 定義對于給定的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,將不會 follow 任何重定向 maxRedirects: 5, // 默認(rèn)的 // `httpAgent` 和 `httpsAgent` 分別在 node.js 中用于定義在執(zhí)行 http 和 https 時使用的自定義代理。允許像這樣配置選項: // `keepAlive` 默認(rèn)沒有啟用 httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }), // 'proxy' 定義代理服務(wù)器的主機名稱和端口 // `auth` 表示 HTTP 基礎(chǔ)驗證應(yīng)當(dāng)用于連接代理,并提供憑據(jù) // 這將會設(shè)置一個 `Proxy-Authorization` 頭,覆寫掉已有的通過使用 `header` 設(shè)置的自定義 `Proxy-Authorization` 頭。 proxy: { host: '127.0.0.1', port: 9000, auth: : { username: 'mikeymike', password: 'rapunz3l' } }, // `cancelToken` 指定用于取消請求的 cancel token // (查看后面的 Cancellation 這節(jié)了解更多) cancelToken: new CancelToken(function (cancel) { })}

響應(yīng)結(jié)構(gòu)

某個請求的響應(yīng)包含以下信息

{ // `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` 是為請求提供的配置信息 config: {}}

使用 then 時,你將接收下面這樣的響應(yīng):

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 的第二個參數(shù)時,響應(yīng)可以通過 error 對象可被使用,正如在錯誤處理這一節(jié)所講。。

配置的默認(rèn)值/defaults

你可以指定將被用在各個請求的配置默認(rèn)值

全局的 axios 默認(rèn)值

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

自定義實例默認(rèn)值

// 創(chuàng)建實例時設(shè)置配置的默認(rèn)值var instance = axios.create({ baseURL: 'https://api.example.com'});// 在實例已創(chuàng)建后修改默認(rèn)值instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

配置的優(yōu)先順序配置會以一個優(yōu)先順序進(jìn)行合并。這個順序是:在 lib/defaults.js 找到的庫的默認(rèn)值,然后是實例的 defaults 屬性,最后是請求的 config 參數(shù)。后者將優(yōu)先于前者。這里是一個例子:

// 使用由庫提供的配置的默認(rèn)值來創(chuàng)建實例// 此時超時配置的默認(rèn)值是 `0`var instance = axios.create();// 覆寫庫的超時默認(rèn)值// 現(xiàn)在,在超時前,所有請求都會等待 2.5 秒instance.defaults.timeout = 2500;// 為已知需要花費很長時間的請求覆寫超時設(shè)置instance.get('/longRequest', { timeout: 5000});

攔截器

在請求或響應(yīng)被 then 或 catch 處理前攔截它們。

// 添加請求攔截器axios.interceptors.request.use(function (config) { // 在發(fā)送請求之前做些什么 return config; }, function (error) { // 對請求錯誤做些什么 return Promise.reject(error); });// 添加響應(yīng)攔截器axios.interceptors.response.use(function (response) { // 對響應(yīng)數(shù)據(jù)做點什么 return response; }, function (error) { // 對響應(yīng)錯誤做點什么 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) {  // 請求已發(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); });

可以使用 validateStatus 配置選項定義一個自定義 HTTP 狀態(tài)碼的錯誤范圍。

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

取消

使用 cancel token 取消請求

Axios 的 cancel token API 基于cancelable promises proposal,它還處于第一階段。

可以使用 CancelToken.source 工廠方法創(chuàng)建 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 參數(shù)是可選的)source.cancel('Operation canceled by the user.');

還可以通過傳遞一個 executor 函數(shù)到 CancelToken 的構(gòu)造函數(shù)來創(chuàng)建 cancel token:

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

Note : 可以使用同一個 cancel token 取消多個請求

摘自axios github

總結(jié)

以上就是這篇文章的全部內(nèi)容,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作能帶來一定的幫助,如果有疑問大家可以留言交流,謝謝大家對武林網(wǎng)的支持。

發(fā)表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發(fā)表
主站蜘蛛池模板: 栾城县| 三原县| 留坝县| 涪陵区| 胶南市| 建水县| 晋江市| 商都县| 寻甸| 水富县| 汤阴县| 华阴市| 莎车县| 平度市| 蓝山县| 和平县| 辽源市| 鸡东县| 偃师市| 浮梁县| 绍兴县| 龙口市| 台东市| 新龙县| 通化县| 广州市| 哈尔滨市| 萍乡市| 安顺市| 丰宁| 多伦县| 新野县| 神木县| 旬阳县| 攀枝花市| 成武县| 宜丰县| 萝北县| 深州市| 禹城市| 徐水县|