前言
在學(xué)習(xí)了之前的路由vue-router和狀態(tài)管理vuex之后,就應(yīng)該是網(wǎng)絡(luò)交互了。就學(xué)習(xí)尤大推薦的axios了。剛好本人對(duì)網(wǎng)絡(luò)請(qǐng)求這塊除了會(huì)get、put、post和delete這四個(gè)方法之外知之甚少,剛好補(bǔ)全上。
注意:Vue官方推薦的網(wǎng)絡(luò)通信庫(kù)不再是vue-resource了,推薦使用axios。
為何放棄vue-resource?
尤大的原話:
最近團(tuán)隊(duì)討論了一下,Ajax 本身跟 Vue 并沒有什么需要特別整合的地方,使用 fetch polyfill 或是 axios、superagent 等等都可以起到同等的效果,vue-resource 提供的價(jià)值和其維護(hù)成本相比并不劃算,所以決定在不久以后取消對(duì) vue-resource 的官方推薦。已有的用戶可以繼續(xù)使用,但以后不再把 vue-resource 作為官方的 ajax 方案。
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 IDaxios.get('/user?ID=12345') .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });// Optionally the request above could also be done asaxios.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
可以直接通過config來完成請(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)。
并發(fā)性
下列接口用于處理并發(fā)請(qǐng)求(同時(shí)處理多個(gè)多個(gè)request)
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先配置好)
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ā)送請(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è)來了解它們
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是通過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); });相對(duì)的,我們有時(shí)也會(huì)出現(xiàn)ajax報(bào)錯(cuò),此時(shí)就會(huì)到我們的catch中去捕獲異常error對(duì)象。
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來一定的幫助,如果有疑問大家可以留言交流,謝謝大家對(duì)武林網(wǎng)的支持。
新聞熱點(diǎn)
疑難解答
圖片精選
網(wǎng)友關(guān)注