Vue-resource和Axios對(duì)比以及Vue-axios

vue更新到2.0之后,作者就宣告不再對(duì)vue-resource更新,而是推薦的axios洪灯。

vue-resource特點(diǎn)

vue-resource插件具有以下特點(diǎn):
1匈挖,體積小
vue-resource非常小巧船惨,在壓縮以后只有大約12KB,服務(wù)端啟用gzip壓縮后只有4.5KB大小胧辽,這遠(yuǎn)比jQuery的體積要小得多谒麦。

2俄讹,支持主流的瀏覽器
和Vue.js一樣,vue-resource除了不支持IE 9以下的瀏覽器绕德,其他主流的瀏覽器都支持患膛。

3,支持Promise API和URI Templates
Promise是ES6的特性耻蛇,Promise的中文含義為“先知”,Promise對(duì)象用于異步計(jì)算。
URI Templates表示URI模板款票,有些類似于ASP.NET MVC的路由模板谱醇。

4,支持?jǐn)r截器
攔截器是全局的夺蛇,攔截器可以在請(qǐng)求發(fā)送前和發(fā)送請(qǐng)求后做一些處理疚漆。
攔截器在一些場景下會(huì)非常有用,比如請(qǐng)求發(fā)送前在headers中設(shè)置access_token刁赦,或者在請(qǐng)求失敗時(shí)娶聘,提供共通的處理方式。

vue2.0之后甚脉,就不再對(duì)vue-resource更新丸升,而是推薦使用axios∥保基于 Promise 的 HTTP 請(qǐng)求客戶端狡耻,可同時(shí)在瀏覽器和 Node.js 中使用。

功能特性
1波闹、在瀏覽器中發(fā)送 XMLHttpRequests 請(qǐng)求
2酝豪、在 node.js 中發(fā)送 http請(qǐng)求
3、支持 Promise API
4精堕、攔截請(qǐng)求和響應(yīng)
5孵淘、轉(zhuǎn)換請(qǐng)求和響應(yīng)數(shù)據(jù)
6、取消請(qǐng)求
7歹篓、自動(dòng)轉(zhuǎn)換 JSON 數(shù)據(jù)
8瘫证、客戶端支持保護(hù)安全免受 CSRF/XSRF 攻擊

axios和vue-axios

vue-axios 是在axios基礎(chǔ)上擴(kuò)展的插件,在Vue.prototype原型上擴(kuò)展了$http等屬性庄撮,可以更加方便的使用axios背捌,使用vue-axios更多是為了符合規(guī)范,并且方便協(xié)作吧洞斯。

Axios 是一個(gè)基于 promise 的 HTTP 庫毡庆,可以用在瀏覽器和 node.js 中坑赡。

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

安裝

使用 npm:

$ npm install axios

使用 bower:

$ bower install axios

使用 cdn:

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

Example
執(zhí)行 GET 請(qǐng)求

// 為給定 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);
  });

執(zhí)行 POST 請(qǐng)求

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

執(zhí)行多個(gè)并發(fā)請(qǐng)求

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 API

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

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

請(qǐng)求方法的別名
為方便起見么抗,為所有支持的請(qǐng)求方法提供了別名

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

在使用別名方法時(shí)毅否, url、method蝇刀、data 這些屬性都不必在配置中指定螟加。
并發(fā)
處理并發(fā)請(qǐng)求的助手函數(shù)

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

創(chuàng)建實(shí)例
可以使用自定義配置新建一個(gè) axios 實(shí)例

axios.create([config])
var instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

實(shí)例方法
以下是可用的實(shí)例方法。指定的配置將與實(shí)例的配置合并

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

請(qǐng)求配置

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

{
  // `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)求趾牧,以使測試更輕松
  // 返回一個(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) {
  })
}

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

某個(gè)請(qǐng)求的響應(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` 是為請(qǐng)求提供的配置信息
  config: {}
}

使用 then 時(shí)失晴,你將接收下面這樣的響應(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 時(shí)剧腻,或傳遞 rejection callback 作為 then 的第二個(gè)參數(shù)時(shí),響應(yīng)可以通過 error 對(duì)象可被使用涂屁,正如在錯(cuò)誤處理這一節(jié)所講书在。

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

你可以指定將被用在各個(gè)請(qǐng)求的配置默認(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';

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

// 創(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;

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

// 使用由庫提供的配置的默認(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)很長時(shí)間的請(qǐng)求覆寫超時(shí)設(shè)置
instance.get('/longRequest', {
  timeout: 5000
});

攔截器

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

// 添加請(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);

可以為自定義 axios 實(shí)例添加攔截器

var instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

錯(cuò)誤處理

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

可以使用 validateStatus 配置選項(xiàng)定義一個(gè)自定義 HTTP 狀態(tài)碼的錯(cuò)誤范圍捻激。

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

取消

使用 cancel token 取消請(qǐng)求
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 {
    // 處理錯(cuò)誤
  }
});

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

還可以通過傳遞一個(gè) 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ù)接收一個(gè) cancel 函數(shù)作為參數(shù)
    cancel = c;
  })
});

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

Note : 可以使用同一個(gè) cancel token 取消多個(gè)請(qǐng)求

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末垃杖,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子丈屹,更是在濱河造成了極大的恐慌调俘,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,122評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件旺垒,死亡現(xiàn)場離奇詭異彩库,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)先蒋,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門骇钦,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人竞漾,你說我怎么就攤上這事眯搭。” “怎么了业岁?”我有些...
    開封第一講書人閱讀 164,491評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵鳞仙,是天一觀的道長。 經(jīng)常有香客問我笔时,道長棍好,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,636評(píng)論 1 293
  • 正文 為了忘掉前任糊闽,我火速辦了婚禮梳玫,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘右犹。我一直安慰自己提澎,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評(píng)論 6 392
  • 文/花漫 我一把揭開白布念链。 她就那樣靜靜地躺著盼忌,像睡著了一般积糯。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上谦纱,一...
    開封第一講書人閱讀 51,541評(píng)論 1 305
  • 那天看成,我揣著相機(jī)與錄音,去河邊找鬼跨嘉。 笑死川慌,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的祠乃。 我是一名探鬼主播梦重,決...
    沈念sama閱讀 40,292評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼亮瓷!你這毒婦竟也來了琴拧?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,211評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤嘱支,失蹤者是張志新(化名)和其女友劉穎蚓胸,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體除师,經(jīng)...
    沈念sama閱讀 45,655評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡沛膳,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了汛聚。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片于置。...
    茶點(diǎn)故事閱讀 39,965評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖贞岭,靈堂內(nèi)的尸體忽然破棺而出八毯,到底是詐尸還是另有隱情,我是刑警寧澤瞄桨,帶...
    沈念sama閱讀 35,684評(píng)論 5 347
  • 正文 年R本政府宣布话速,位于F島的核電站,受9級(jí)特大地震影響芯侥,放射性物質(zhì)發(fā)生泄漏泊交。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評(píng)論 3 329
  • 文/蒙蒙 一柱查、第九天 我趴在偏房一處隱蔽的房頂上張望廓俭。 院中可真熱鬧,春花似錦唉工、人聲如沸研乒。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽雹熬。三九已至宽菜,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間竿报,已是汗流浹背铅乡。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評(píng)論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留烈菌,地道東北人阵幸。 一個(gè)月前我還...
    沈念sama閱讀 48,126評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像芽世,于是被迫代替她去往敵國和親侨嘀。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容