vue 使用 axios 访问 API

发布时间:2019-01-11 编辑:小张个人博客 查看次数:4394

有很多时候你在构建应用时需要访问一个 API 并展示其数据。做这件事的方法有好几种,而使用基于 promise 的 HTTP 客户端 axios 则是其中非常流行的一种。Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。

特点

  • 从浏览器中创建 XMLHttpRequests

  • 从 node.js 创建 http 请求

  • 支持 Promise API

  • 拦截请求和响应

  • 转换请求数据和响应数据

  • 取消请求

  • 自动转换 JSON 数据

  • 客户端支持防御 XSRF

浏览器支持

axios 支持浏览器

安装

npm install axios --save

或者使用 CDN 

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

一个简单的案例

Axios 执行 GET 请求

axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

Axios 执行 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) {
    // 以上两个请求现在都执行完成
  }));

请求方法的别名

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

在使用别名方法时, urlmethoddata 这些属性都不必在配置中指定。

并发

处理并发请求的助手函数

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

请求配置

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method,请求将默认使用 get 方法。

{
  url: '/user',
 
  method: 'get', // 默认是 get
  
  baseURL: 'https://023xs.cn/api/',

  transformRequest: [function (data) {
    // 对 data 进行任意转换处理

    return data;
  }],

  transformResponse: [function (data) {
    // 对 data 进行任意转换处理
    return data;
  }],

  headers: {'X-Requested-With': 'XMLHttpRequest'},

  params: {
    ID: 12345
  },

  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },

  data: {
    firstName: 'Fred'
  },

  timeout: 1000,

  withCredentials: false, // 默认的

  adapter: function (config) {
    /* ... */
  },
  auth: {
    username: '023xs',
    password: '***********'
  },
  
  responseType: 'json', // 默认的
 
  xsrfCookieName: 'XSRF-TOKEN', // default
 
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
 
  onUploadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },
  onDownloadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },
  maxContentLength: 2000,
 
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认的
  },
 
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

}

注释:


  • url:是用于请求的服务器 URL

  • method:是创建请求时使用的方法,默认是 get

  • baseURL:自动加在 `url` 前面,除非 `url` 是一个绝对 URL,它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL。

  • transformRequest:允许在向服务器发送前,修改请求数据,只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法。

  • transformResponse:在传递给 then/catch 前,允许修改响应数据。

  • headers:自定义请求头。

  • params:与请求一起发送的 URL 参数,必须是一个无格式对象(plain object)或 URLSearchParams 对象。

  • paramsSerializer:是负责 `params` 序列化的函数。

  • data:是作为请求主体被发送的数据,只适用于这些请求方法 'PUT', 'POST', 和 'PATCH',在没有设置 `transformRequest` 时,必须是以下类型之一:string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams,浏览器专属:FormData, File, Blob,Node 专属: Stream。

  • timeout:指定请求超时的毫秒数(0 表示无超时时间)。

  • withCredentials:表示跨域请求时是否需要使用凭证,默认 false。

  • adapter:允许自定义处理请求,以使测试更轻松。

  • auth:表示应该使用 HTTP 基础验证,并提供凭据

  • responseType:表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream',默认 json。

  • xsrfCookieName:用作 xsrf token 的值的cookie的名称。

  • onUploadProgress:允许为上传处理进度事件。

  • onDownloadProgress:允许为下载处理进度事件。

  • maxContentLength:定义允许的响应内容的最大尺寸。

  • validateStatus:定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte。

  • proxy:定义代理服务器的主机名称和端口,`auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据

响应结构

{
  data: {}, // `data` 由服务器提供的响应

  status: 200, // `status` 来自服务器响应的 HTTP 状态码

  statusText: 'OK',  // `statusText` 来自服务器响应的 HTTP 状态信息
  
  headers: {},  // `headers` 服务器响应的头

  config: {}  // `config` 是为请求提供的配置信息
}

拦截器

在请求或响应被 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 () {/*...*/});

错误处理

很多时候我们可能并没有从 API 获取想要的数据。这可能是由于很多种因素引起的,比如 axios 调用可能由于多种原因而失败,包括但不限于:

  • API 不工作了;

  • 请求发错了;

  • API 没有按我们预期的格式返回信息。

当发送这个请求的时候,我们应该检查一下这些情况,并在所有情况下都返回相应的信息以便处理这些问题。在 axios 中,我们会通过使用 catch 来做这件事。

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

其实 Vue 和 axios 可以在一起配合的事情不只是访问和展示一个 API。你也可以和 Serverless Function 通信,向一个有写权限的 API 发送发布/编辑/删除请求等等。由于这两个库的集成很简单直接,它便成为了需要在工作流中集成 HTTP 客户端的开发者的常见选择。



出处:小张个人博客

网址:http://blog.023xs.cn/

您的支持是对博主最大的鼓励,感谢您的认真阅读。欢迎转载,但请保留该声明。

顶部

Copyright © 小张个人博客 All Rights Reserved 渝ICP备15006773号-1

联系方式:[email protected] | 本站文章仅供学习和参考

渝公网安备 50024102500267号