axios

Vue官方推薦的網(wǎng)絡(luò)通信庫(kù)不再是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請(qǐng)求

// 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請(qǐng)求

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

同時(shí)執(zhí)行多個(gè)請(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) {
    // Both requests are now complete
  }));

其實(shí)和其他的ajax庫(kù)一樣庸论,基本用法都是差不多的。大家一看就知道怎么用秀鞭。

axios API

可以直接通過(guò)config
來(lái)完成請(qǐng)求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');

請(qǐng)求方法別名

下面是axios支持的所有請(qǐng)求方法別名旋圆,便于各種請(qǐng)求。
注:[...]中的數(shù)據(jù)表示可以為空瓤球。url是ajax請(qǐng)求地址;data是提交的數(shù)據(jù)對(duì)象拟赊;config是配置對(duì)象,所有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ā)請(qǐng)求(同時(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)來(lái)了翩隧,來(lái)看看Config。
下面列出了config的所有配置項(xiàng),其中之后url是必填的墩弯。當(dāng)method沒(méi)有指定方法桥温,默認(rèn)為GET氛谜。

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

  // `method` is the request method to be used when making the request
 // 請(qǐng)求方法
  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`不是絕對(duì)路徑惭嚣,那么向服務(wù)器發(fā)送請(qǐng)求的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è)來(lái)了解它們

  • url —— 用來(lái)向服務(wù)器發(fā)送請(qǐng)求的url
  • method —— 請(qǐng)求方法窗宦,默認(rèn)是GET方法
  • baseURL —— 基礎(chǔ)URL路徑订讼,假如url不是絕對(duì)路徑寄纵,如https://some-- domain.com/api/v1/login?name=jack,那么向服務(wù)器發(fā)送請(qǐng)求的URL將會(huì)是baseURL
  • url帆阳。
  • transformRequest —— transformRequest方法允許在請(qǐng)求發(fā)送到服務(wù)器之前修改該請(qǐng)求至扰,此方法只適用于PUT直秆、POST和PATCH方法中齿诉。而且抵恋,此方法最后必須返回一個(gè)string、ArrayBuffer或者Stream茸习。
  • transformResponse —— transformResponse方法允許在數(shù)據(jù)傳遞到then/catch之前修改response數(shù)據(jù)猫胁。此方法最后也要返回?cái)?shù)據(jù)。
  • headers —— 發(fā)送自定義Headers頭文件脑豹,頭文件中包含了http請(qǐng)求的各種信息俱饿。
  • params —— params是發(fā)送請(qǐng)求的查詢參數(shù)對(duì)象,對(duì)象中的數(shù)據(jù)會(huì)被拼接成url?param1=value1&param2=value2
  • paramsSerializer —— params參數(shù)序列化器。
  • data ——data是在發(fā)送POST、PUT或者PATCH請(qǐng)求的數(shù)據(jù)對(duì)象。
  • timeout —— 請(qǐng)求超時(shí)設(shè)置,單位為毫秒
  • withCredentials —— 表明是否有跨域請(qǐng)求需要用到證書
  • adapter —— adapter允許用戶處理更易于測(cè)試的請(qǐng)求续室。返回一個(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 —— 允許在上傳過(guò)程中的做一些操作
  • onDownloadProgress —— 允許在下載過(guò)程中的做一些操作
  • maxContentLength —— 定義了接收到的response響應(yīng)數(shù)據(jù)的最大長(zhǎng)度笑跛。
  • validateStatus —— validateStatus定義了根據(jù)HTTP響應(yīng)狀態(tài)碼決定是否接收或拒絕獲取到的promise晤柄。如果 validateStatus 返回 true (或設(shè)置為 null 或 undefined),promise將被接收;否則,promise將被拒絕爬坑。
  • maxRedirects —— maxRedirects定義了在node.js中redirect的最大值署辉,如果設(shè)置為0逝淹,則沒(méi)有redirect欣簇。
  • httpAgent —— 定義在使用http請(qǐng)求時(shí)的代理
  • httpsAgent —— 定義在使用https請(qǐng)求時(shí)的代理
  • proxy —— proxy定義代理服務(wù)器的主機(jī)名和端口妇智,auth
  • cancelToken —— cancelToken定義一個(gè) cancel
    token 用于取消請(qǐng)求

Response

當(dāng)我們ajax獲取數(shù)據(jù)成功后會(huì)返回一個(gè)response對(duì)象如贷,它包含了以下內(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是通過(guò)promise的then方法來(lái)獲取,具體使用方法如下:

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

相對(duì)的纹蝴,我們有時(shí)也會(huì)出現(xiàn)ajax報(bào)錯(cuò),此時(shí)就會(huì)到我們的catch中去捕獲異常error對(duì)象帆竹。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末脐湾,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子茂洒,更是在濱河造成了極大的恐慌堵未,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,454評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件谷朝,死亡現(xiàn)場(chǎng)離奇詭異累铅,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,553評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門嚼酝,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事畜挥】诟猓” “怎么了?”我有些...
    開封第一講書人閱讀 157,921評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵夜矗,是天一觀的道長(zhǎng)惭缰。 經(jīng)常有香客問(wèn)我各谚,道長(zhǎng)了赵,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,648評(píng)論 1 284
  • 正文 為了忘掉前任锥惋,我火速辦了婚禮株婴,結(jié)果婚禮上蘸际,老公的妹妹穿的比我還像新娘。我一直安慰自己尘惧,他們只是感情好核芽,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,770評(píng)論 6 386
  • 文/花漫 我一把揭開白布察藐。 她就那樣靜靜地躺著皮璧,像睡著了一般。 火紅的嫁衣襯著肌膚如雪分飞。 梳的紋絲不亂的頭發(fā)上悴务,一...
    開封第一講書人閱讀 49,950評(píng)論 1 291
  • 那天,我揣著相機(jī)與錄音譬猫,去河邊找鬼讯檐。 笑死,一個(gè)胖子當(dāng)著我的面吹牛染服,可吹牛的內(nèi)容都是我干的别洪。 我是一名探鬼主播,決...
    沈念sama閱讀 39,090評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼柳刮,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼挖垛!你這毒婦竟也來(lái)了痒钝?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,817評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤晕换,失蹤者是張志新(化名)和其女友劉穎午乓,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體闸准,經(jīng)...
    沈念sama閱讀 44,275評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡益愈,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,592評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了夷家。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片蒸其。...
    茶點(diǎn)故事閱讀 38,724評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖库快,靈堂內(nèi)的尸體忽然破棺而出摸袁,到底是詐尸還是另有隱情,我是刑警寧澤义屏,帶...
    沈念sama閱讀 34,409評(píng)論 4 333
  • 正文 年R本政府宣布靠汁,位于F島的核電站,受9級(jí)特大地震影響闽铐,放射性物質(zhì)發(fā)生泄漏蝶怔。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,052評(píng)論 3 316
  • 文/蒙蒙 一兄墅、第九天 我趴在偏房一處隱蔽的房頂上張望踢星。 院中可真熱鬧,春花似錦隙咸、人聲如沸沐悦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,815評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)藏否。三九已至,卻和暖如春充包,著一層夾襖步出監(jiān)牢的瞬間秕岛,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,043評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工误证, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留继薛,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,503評(píng)論 2 361
  • 正文 我出身青樓愈捅,卻偏偏與公主長(zhǎng)得像遏考,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子蓝谨,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,627評(píng)論 2 350

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