1. 程式人生 > >vue結合axios使用入門

vue結合axios使用入門

methods site over 指定 pack when mda pen nload

Vue官方推薦的網絡通信庫不再是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);
  });

同時執行多個請求

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

其實和其他的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支持的所有請求方法別名,便於各種請求。
註:[...]

中的數據表示可以為空。url是ajax請求地址;data是提交的數據對象;config是配置對象,所有ajax配置都可以在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]])

並發性

下列接口用於處理並發請求(同時處理多個多個request)

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

axios實例

可以用自定義的config創建一個axios實例
axios.create([config])

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

實例方法

下面是實例的所有可用方法,方法中的config會與axios實例中的config合並。(實例可以將一些通用的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

重點來了,來看看Config。
下面列出了config的所有配置項,其中之後url是必填的。當method沒有指定方法,默認為GET

{
  // `url` is the server URL that will be used for the request
  // 用來向服務器發送請求的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`不是絕對路徑,那麽向服務器發送請求的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

配置參數很多,我們一個一個來了解它們

  • url —— 用來向服務器發送請求的url
  • method —— 請求方法,默認是GET方法
  • baseURL —— 基礎URL路徑,假如url不是絕對路徑,如https://some-domain.com/api/v1/login?name=jack,那麽向服務器發送請求的URL將會是baseURL + url
  • transformRequest —— transformRequest方法允許在請求發送到服務器之前修改該請求,此方法只適用於PUTPOSTPATCH方法中。而且,此方法最後必須返回一個string、ArrayBuffer或者Stream。
  • transformResponse —— transformResponse方法允許在數據傳遞到then/catch之前修改response數據。此方法最後也要返回數據。
  • headers —— 發送自定義Headers頭文件,頭文件中包含了http請求的各種信息。
  • params —— params是發送請求的查詢參數對象,對象中的數據會被拼接成url?param1=value1&param2=value2
  • paramsSerializer —— params參數序列化器。
  • data —— data是在發送POSTPUT或者PATCH請求的數據對象。
  • timeout —— 請求超時設置,單位為毫秒
  • withCredentials —— 表明是否有跨域請求需要用到證書
  • adapter —— adapter允許用戶處理更易於測試的請求。返回一個Promise和一個有效的response
  • auth —— auth表明提供憑證用於完成http的身份驗證。這將會在headers中設置一個Authorization授權信息。自定義Authorization授權要設置在headers中。
  • responseType —— 表示服務器將返回響應的數據類型,有arraybufferblobdocumentjsontextstream這6個類型,默認是json類似數據。
  • xsrfCookieName —— 用作 xsrf token 值的 cookie 名稱
  • xsrfHeaderName —— 帶有 xsrf token 值 http head 名稱
  • onUploadProgress —— 允許在上傳過程中的做一些操作
  • onDownloadProgress —— 允許在下載過程中的做一些操作
  • maxContentLength —— 定義了接收到的response響應數據的最大長度。
  • validateStatus —— validateStatus定義了根據HTTP響應狀態碼決定是否接收或拒絕獲取到的promise。如果 validateStatus 返回 true (或設置為 nullundefined),promise將被接收;否則,promise將被拒絕。
  • maxRedirects —— maxRedirects定義了在node.js中redirect的最大值,如果設置為0,則沒有redirect。
  • httpAgent —— 定義在使用http請求時的代理
  • httpsAgent —— 定義在使用https請求時的代理
  • proxy —— proxy定義代理服務器的主機名和端口,auth
  • cancelToken —— cancelToken定義一個 cancel token 用於取消請求

Response

當我們ajax獲取數據成功後會返回一個response對象,它包含了以下內容:

{
  // `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);
  });

相對的,我們有時也會出現ajax報錯,此時就會到我們的catch中去捕獲異常error對象。

vue結合axios使用入門