Axios使用文档总结

　　vue更新到2.0以后，做者就宣告再也不对vue-resource更新，而是推荐的axios。Axios 是一个基于 promise 的 HTTP 库，能够用在浏览器和 node.js 中。

1、安装

//使用 npm:
$ npm install axios //使用 cdn:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

2、实例

　　执行 GET 请求

// 为给定 ID 的 user 建立请求
axios.get('/user?ID=12345') .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); // 可选地，上面的请求能够这样作
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) { // 两个请求如今都执行完成
  }));

3、axios API

　　一、能够经过向 axios 传递相关配置来建立请求

　　axios(config)

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

　　axios(url[, config])

// 发送 GET 请求（默认的方法）
axios('/user/12345');

　　二、请求方法的别名。

　　为方便起见，为全部支持的请求方法提供了别名

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

　　在使用别名方法时， url、method、data 这些属性都没必要在配置中指定。

　　三、并发

　　处理并发请求的助手函数

axios.all(iterable)

axios.spread(callback)

　　四、建立实例

　　可使用自定义配置新建一个 axios 实例：axios.create([config])

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

　　如下是可用的实例方法。指定的配置将与实例的配置合并

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

4、请求配置

　　这些是建立请求时能够用的配置选项。只有 url 是必需的。若是没有指定 method，请求将默认使用 get 方法

{ // `url` 是用于请求的服务器 URL
  url: '/user', // `method` 是建立请求时使用的方法
  method: 'get', // 默认是 get // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。 // 它能够经过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/', // `transformRequest` 容许在向服务器发送前，修改请求数据 // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法 // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
 transformRequest: [function (data) { // 对 data 进行任意转换处理
    return data; }], // `transformResponse` 在传递给 then/catch 前，容许修改响应数据
 transformResponse: [function (data) { // 对 data 进行任意转换处理
    return data; }], // `headers` 是即将被发送的自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'}, // `params` 是即将与请求一块儿发送的 URL 参数 // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
  params: { ID: 12345 }, // `paramsSerializer` 是一个负责 `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` 是做为请求主体被发送的数据 // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH' // 在没有设置 `transformRequest` 时，必须是如下类型之一： // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams // - 浏览器专属：FormData, File, Blob // - Node 专属： Stream
 data: { firstName: 'Fred' }, // `timeout` 指定请求超时的毫秒数(0 表示无超时时间) // 若是请求话费了超过 `timeout` 的时间，请求将被中断
  timeout: 1000, // `withCredentials` 表示跨域请求时是否须要使用凭证
  withCredentials: false, // 默认的 // `adapter` 容许自定义处理请求，以使测试更轻松 // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
 adapter: function (config) { /* ... */ }, // `auth` 表示应该使用 HTTP 基础验证，并提供凭据 // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
 auth: { username: 'janedoe', password: 's00pers3cret' }, // `responseType` 表示服务器响应的数据类型，能够是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // 默认的 // `xsrfCookieName` 是用做 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN', // default // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的 // `onUploadProgress` 容许为上传处理进度事件
 onUploadProgress: function (progressEvent) { // 对原生进度事件的处理
 }, // `onDownloadProgress` 容许为下载处理进度事件
 onDownloadProgress: function (progressEvent) { // 对原生进度事件的处理
 }, // `maxContentLength` 定义容许的响应内容的最大尺寸
  maxContentLength: 2000, // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。若是 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 不然，promise 将被 rejecte
 validateStatus: function (status) { return status >= 200 && status < 300; // 默认的
 }, // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目 // 若是设置为0，将不会 follow 任何重定向
  maxRedirects: 5, // 默认的 // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。容许像这样配置选项： // `keepAlive` 默认没有启用
  httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }), // 'proxy' 定义代理服务器的主机名称和端口 // `auth` 表示 HTTP 基础验证应当用于链接代理，并提供凭据 // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的经过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
 proxy: { host: '127.0.0.1', port: 9000, auth: : { username: 'mikeymike', password: 'rapunz3l' } }, // `cancelToken` 指定用于取消请求的 cancel token // （查看后面的 Cancellation 这节了解更多）
  cancelToken: new CancelToken(function (cancel) { }) }

5、响应结构

　　某个请求的响应包含如下信息

{ // `data` 由服务器提供的响应
 data: {}, // `status` 来自服务器响应的 HTTP 状态码
  status: 200, // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK', // `headers` 服务器响应的头
 headers: {}, // `config` 是为请求提供的配置信息
 config: {} }

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

　　在使用 catch 时，或传递 rejection/callback 做为 then 的第二个参数时，响应能够经过 error 对象可被使用

6、配置的默认值/defaults

　　你能够指定将被用在各个请求的配置默认值

　　一、全局的 axios 默认值

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

　　二、自定义实例默认值

// 建立实例时设置配置的默认值
var instance = axios.create({ baseURL: 'https://api.example.com' }); // 在实例已建立后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

　　三、配置的优先顺序

　　配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，而后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

// 使用由库提供的配置的默认值来建立实例 // 此时超时配置的默认值是 `0`
var instance = axios.create(); // 覆写库的超时默认值 // 如今，在超时前，全部请求都会等待 2.5 秒
instance.defaults.timeout = 2500; // 为已知须要花费很长时间的请求覆写超时设置
instance.get('/longRequest', { timeout: 5000 });

7、拦截器

　　在请求或响应被 then 或 catch 处理前拦截它们。

// 添加请求拦截器
axios.interceptors.request.use(function (config) { // 在发送请求以前作些什么
    return config; }, function (error) { // 对请求错误作些什么
    return Promise.reject(error); }); // 添加响应拦截器
axios.interceptors.response.use(function (response) { // 对响应数据作点什么
    return response; }, function (error) { // 对响应错误作点什么
    return Promise.reject(error); });

　　若是你想在稍后移除拦截器，能够这样：

var myInterceptor = axios.interceptors.request.use(function () {/*...*/}); axios.interceptors.request.eject(myInterceptor);

　　能够为自定义 axios 实例添加拦截器

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

8、错误处理

axios.get('/user/12345') .catch(function (error) { if (error.response) { // 请求已发出，但服务器响应的状态码不在 2xx 范围内
 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 配置选项定义一个自定义 HTTP 状态码的错误范围。

axios.get('/user/12345', { validateStatus: function (status) { return status < 500; // 状态码在大于或等于500时才会 reject
 } })

9、取消

　　使用 cancel token 取消请求。Axios 的 cancel token API 基于cancelable promises proposal，它还处于第一阶段。

　　可使用 CancelToken.source 工厂方法建立 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 { // 处理错误
 } }); // 取消请求（message 参数是可选的）
source.cancel('Operation canceled by the user.');

　　还能够经过传递一个 executor 函数到 CancelToken 的构造函数来建立 cancel token：

var CancelToken = axios.CancelToken; var cancel; axios.get('/user/12345', { cancelToken: new CancelToken(function executor(c) { // executor 函数接收一个 cancel 函数做为参数
    cancel = c; }) }); // 取消请求
cancel();

　　可使用同一个 cancel token 取消多个请求。