在學(xué)習(xí)了之前的路由vue-router和狀態(tài)管理vuex之后山林，就應(yīng)該是網(wǎng)絡(luò)交互了逻杖。就學(xué)習(xí)尤大推薦的axios了。剛好本人對網(wǎng)絡(luò)請求這塊除了會(huì)get塔猾、put、post和delete這四個(gè)方法之外知之甚少稽坤，剛好補(bǔ)全上丈甸。

注意：Vue官方推薦的網(wǎng)絡(luò)通信庫不再是vue-resource了，推薦使用axios慎皱。

尤大的公告

axios安裝

npm:

$ npm install axios

bower:

$ bower install axios

Using cdn:

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

基本使用方法

GET請求

// Make a request for a user with a given ID
axios.get('/user?ID=12345')
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

// Optionally the request above could also be done as
axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

POST請求

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

同時(shí)執(zhí)行多個(gè)請求

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) {
    // Both requests are now complete
  }));

其實(shí)和其他的ajax庫一樣老虫，基本用法都是差不多的。大家一看就知道怎么用茫多。

axios API

可以直接通過config來完成請求
axios(config)

axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

axios(url, [config])

// Send a GET request (default method)
axios('/user/12345');

請求方法別名

下面是axios支持的所有請求方法別名祈匙，便于各種請求。
注：[...]中的數(shù)據(jù)表示可以為空天揖。url是ajax請求地址夺欲；data是提交的數(shù)據(jù)對象；config是配置對象今膊，所有ajax配置都可以在config中實(shí)現(xiàn)些阅。

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

并發(fā)性

下列接口用于處理并發(fā)請求(同時(shí)處理多個(gè)多個(gè)request)

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

axios實(shí)例

可以用自定義的config創(chuàng)建一個(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í)例的所有可用方法数焊，方法中的config會(huì)與axios實(shí)例中的config合并歧匈。（實(shí)例可以將一些通用的config先配置好）

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

Config

重點(diǎn)來了，來看看Config互墓。
下面列出了config的所有配置項(xiàng)恕刘，其中之后url是必填的缤谎。當(dāng)method沒有指定方法，默認(rèn)為GET褐着。

{
  // `url` is the server URL that will be used for the request
  // 用來向服務(wù)器發(fā)送請求的url
  url: '/user',

  // `method` is the request method to be used when making the request
 // 請求方法
  method: 'get', // default

  // `baseURL` will be prepended to `url` unless `url` is absolute.
  // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
  // to methods of that instance.
  // 假如`url`不是絕對路徑坷澡，那么向服務(wù)器發(fā)送請求的URL將是`baseURL + url`
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` allows changes to the request data before it is sent to the server
  // This is only applicable for request methods 'PUT', 'POST', and 'PATCH'
  // The last function in the array must return a string, an ArrayBuffer, or a Stream
  transformRequest: [function (data) {
    // Do whatever you want to transform the data

    return data;
  }],

  // `transformResponse` allows changes to the response data to be made before
  // it is passed to then/catch
  transformResponse: [function (data) {
    // Do whatever you want to transform the data

    return data;
  }],

  // `headers` are custom headers to be sent
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` are the URL parameters to be sent with the request
  // Must be a plain object or a URLSearchParams object
  params: {
    ID: 12345
  },

  // `paramsSerializer` is an optional function in charge of serializing `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` is the data to be sent as the request body
  // Only applicable for request methods 'PUT', 'POST', and 'PATCH'
  // When no `transformRequest` is set, must be of one of the following types:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - Browser only: FormData, File, Blob
  // - Node only: Stream
  data: {
    firstName: 'Fred'
  },

  // `timeout` specifies the number of milliseconds before the request times out.
  // If the request takes longer than `timeout`, the request will be aborted.
  timeout: 1000,

  // `withCredentials` indicates whether or not cross-site Access-Control requests
  // should be made using credentials
  withCredentials: false, // default

  // `adapter` allows custom handling of requests which makes testing easier.
  // Return a promise and supply a valid response (see [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },

  // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
  // This will set an `Authorization` header, overwriting any existing
  // `Authorization` custom headers you have set using `headers`.
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` indicates the type of data that the server will respond with
  // options are 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // default

  // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

  // `onUploadProgress` allows handling of progress events for uploads
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `onDownloadProgress` allows handling of progress events for downloads
  onDownloadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `maxContentLength` defines the max size of the http response content allowed
  maxContentLength: 2000,

  // `validateStatus` defines whether to resolve or reject the promise for a given
  // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
  // or `undefined`), the promise will be resolved; otherwise, the promise will be
  // rejected.
  validateStatus: function (status) {
    return status >= 200 && status < 300; // default
  },

  // `maxRedirects` defines the maximum number of redirects to follow in node.js.
  // If set to 0, no redirects will be followed.
  maxRedirects: 5, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows to configure options like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // 'proxy' defines the hostname and port of the proxy server
  // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and supplies credentials.
  // This will set an `Proxy-Authorization` header, overwriting any existing `Proxy-Authorization` custom headers you have set using `headers`.
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // `cancelToken` specifies a cancel token that can be used to cancel the request
  // (see Cancellation section below for details)
  cancelToken: new CancelToken(function (cancel) {
  })
}

分析Config

配置參數(shù)很多，我們一個(gè)一個(gè)來了解它們

• url —— 用來向服務(wù)器發(fā)送請求的url
• method —— 請求方法含蓉，默認(rèn)是GET方法
• baseURL —— 基礎(chǔ)URL路徑频敛，假如url不是絕對路徑项郊，如https://some-domain.com/api/v1/login?name=jack,那么向服務(wù)器發(fā)送請求的URL將會(huì)是baseURL + url。
• transformRequest —— transformRequest方法允許在請求發(fā)送到服務(wù)器之前修改該請求斟赚，此方法只適用于PUT着降、POST和PATCH方法中。而且拗军，此方法最后必須返回一個(gè)string鹊碍、ArrayBuffer或者Stream。
• transformResponse —— transformResponse方法允許在數(shù)據(jù)傳遞到then/catch之前修改response數(shù)據(jù)食绿。此方法最后也要返回?cái)?shù)據(jù)侈咕。
• headers —— 發(fā)送自定義Headers頭文件，頭文件中包含了http請求的各種信息器紧。
• params —— params是發(fā)送請求的查詢參數(shù)對象耀销，對象中的數(shù)據(jù)會(huì)被拼接成url?param1=value1&param2=value2。
• paramsSerializer —— params參數(shù)序列化器铲汪。
• data —— data是在發(fā)送POST熊尉、PUT或者PATCH請求的數(shù)據(jù)對象。
• timeout —— 請求超時(shí)設(shè)置掌腰，單位為毫秒
• withCredentials —— 表明是否有跨域請求需要用到證書
• adapter —— adapter允許用戶處理更易于測試的請求狰住。返回一個(gè)Promise和一個(gè)有效的response
• auth —— auth表明提供憑證用于完成http的身份驗(yàn)證。這將會(huì)在headers中設(shè)置一個(gè)Authorization授權(quán)信息齿梁。自定義Authorization授權(quán)要設(shè)置在headers中催植。
• responseType —— 表示服務(wù)器將返回響應(yīng)的數(shù)據(jù)類型，有arraybuffer勺择、blob创南、document、json省核、text稿辙、stream這6個(gè)類型，默認(rèn)是json類似數(shù)據(jù)气忠。
• xsrfCookieName —— 用作 xsrf token 值的 cookie 名稱
• xsrfHeaderName —— 帶有 xsrf token 值 http head 名稱
• onUploadProgress —— 允許在上傳過程中的做一些操作
• onDownloadProgress —— 允許在下載過程中的做一些操作
• maxContentLength —— 定義了接收到的response響應(yīng)數(shù)據(jù)的最大長度邻储。
• validateStatus —— validateStatus定義了根據(jù)HTTP響應(yīng)狀態(tài)碼決定是否接收或拒絕獲取到的promise。如果 validateStatus 返回 true (或設(shè)置為 null 或 undefined ),promise將被接收;否則,promise將被拒絕旧噪。
• maxRedirects —— maxRedirects定義了在node.js中redirect的最大值吨娜，如果設(shè)置為0，則沒有redirect舌菜。
• httpAgent —— 定義在使用http請求時(shí)的代理
• httpsAgent —— 定義在使用https請求時(shí)的代理
• proxy —— proxy定義代理服務(wù)器的主機(jī)名和端口萌壳，auth
• cancelToken —— cancelToken定義一個(gè) cancel token 用于取消請求

Response

當(dāng)我們ajax獲取數(shù)據(jù)成功后會(huì)返回一個(gè)response對象亦镶，它包含了以下內(nèi)容：

{
  // `data` is the response that was provided by the server
  data: {},

  // `status` is the HTTP status code from the server response
  status: 200,

  // `statusText` is the HTTP status message from the server response
  statusText: 'OK',

  // `headers` the headers that the server responded with
  headers: {},

  // `config` is the config that was provided to `axios` for the request
  config: {}
}

response是通過promise的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);
  });

相對的日月，我們有時(shí)也會(huì)出現(xiàn)ajax報(bào)錯(cuò)袱瓮，此時(shí)就會(huì)到我們的catch中去捕獲異常error對象。

為何放棄vue-resource

尤大的原話：

最近團(tuán)隊(duì)討論了一下爱咬，Ajax 本身跟 Vue 并沒有什么需要特別整合的地方尺借，使用 fetch polyfill 或是 axios、superagent 等等都可以起到同等的效果精拟，vue-resource 提供的價(jià)值和其維護(hù)成本相比并不劃算燎斩，所以決定在不久以后取消對 vue-resource 的官方推薦。已有的用戶可以繼續(xù)使用蜂绎，但以后不再把 vue-resource 作為官方的 ajax 方案栅表。
知乎鏈接：https://www.zhihu.com/question/52418455/answer/130535375

Vue.js學(xué)習(xí)系列項(xiàng)目地址

本文源碼已收入到GitHub中，以供參考师枣，當(dāng)然能留下一個(gè)star更好啦^-怪瓶。
https://github.com/violetjack/VueStudyDemos

關(guān)于作者

VioletJack，高效學(xué)習(xí)前端工程師践美，喜歡研究提高效率的方法洗贰，也專注于Vue前端相關(guān)知識(shí)的學(xué)習(xí)、整理陨倡。
歡迎關(guān)注敛滋、點(diǎn)贊、評論留言~我將持續(xù)產(chǎn)出Vue相關(guān)優(yōu)質(zhì)內(nèi)容兴革。

新浪微博： http://weibo.com/u/2640909603
掘金：https://gold.xitu.io/user/571d953d39b0570068145cd1
CSDN: http://blog.csdn.net/violetjack0808
簡書： http://www.reibang.com/users/54ae4af3a98d/latest_articles
Github： https://github.com/violetjack

打個(gè)廣告

鏈家上海研發(fā)中心招聘前端绎晃、后端、測試杂曲。
機(jī)會(huì)不多箕昭，需要內(nèi)推機(jī)會(huì)的請將簡歷發(fā)送至 dingxiaojie001@ke.com。