axios的基础用法（一）

最新推荐文章于 2024-10-29 20:34:27 发布

原创最新推荐文章于 2024-10-29 20:34:27 发布 · 2k 阅读

35 ·

CC 4.0 BY-SA版权

文章标签：

#ajax #vue.js

本文详细介绍了在Vue项目中如何使用Axios库与服务器进行通信，包括Axios的基本概念、安装方法、常用API以及配置项的使用。重点讲解了常见的请求方法如GET、POST等，以及transformRequest、transformResponse、headers、timeout等关键配置项。同时，还提及了响应结构的组成部分。

在之前我们了解了Vue 和 Vue的路由，这讲解这些的过程中，我们用到的数据都是直接定义的，而在实际项目中，页面中的数据通常都是从服务器端获取的，那么这篇就是讲解的通过 Axios 与服务器端进行通信的一部分——API和配置项。

什么是Axios

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。Vue 官方推荐使用 Axios 来完成请求。

Axios的优点

支持发送ajax异步
支持在NodeJs中发送ajax请求
支持Promise
支持拦截器请求和响应
支持对请求和响应数据的转换

如何安装 Axios

使用 CDN 方式

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

使用 NPM 安装方式

$ npm install axios

在 Vue CLI 项目中你使用

在 main.js 文件中导入 axios ，并绑定到 Vue 的原型链上

import axios from 'axios'

Vue.prototype.$axios = axios;

Axios支持的API

Axios所支持的请求方法本身只有两个：

axios(config)
axios(url[, config])

这两个方法中的参数config表示配置项，用于传递相关参数来创建请求，其本身是一个对象。而这两个方法的区别是，第二个方法可以不用在配置文件中添加url属性。

除了上述两个方法，Axios 又根据上述两个方法进行封装了其他方法：

Axios.request(config)
Axios.get(url, config)
Axios.post(url, data, config)
Axios.delete(url, config)
Axios.head(url, config)
Aixos.put(url, data, config)
Axios.patch(url,data,config)

上述方法是通过不同的请求方式发送请求，在使用过程中，url，data和mehotd都可以不用在配置项中添加。

配置项

以下就是创建请求时可以使用的配置选项。只有 url选项是必需的，其他选项按具体情况添加。如果没有指定 method选项，则请求将默认使用 get方法。

{
   // `url` 是用于请求的服务器 URL
  url: '/user',

  // `method` 是创建请求时使用的方法
  method: 'get', // default

  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data, headers) {
    // 对 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, // default

  // `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', // default

  // `responseEncoding` 表示用于解码响应数据的编码
  responseEncoding: 'utf8', // default

   // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` 是用作xsrf token 的值的http 报头名字
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

   // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `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; // default
  },

  // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  // 如果设置为0，将不会 follow 任何重定向
  maxRedirects: 5, // 默认值

  // `socketPath` 定义要在node.js中使用的 UNIX 套字节
  // 例如： '/var/run/docker.sock' 向docker 守护进程发送请求
  // 只能指定`socketPath` 或 `proxy` ，如果两者都指定，则使用socketPath
  socketPath: null, // default

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

配置项有很多，我们现在对一些配置项进行分类筛选，找出经常使用的配置项：

url、method、params、baseURL、data、timeout、headers和withCredentials这几个选项是发送请求经常使用
transformRequest和transformResponse这俩个选项是用于设置修改请求或响应的信息
onDownloadProgress和onUploadProgress这俩个选项是用于设置下载或上传处理进度事件
responseType和responseEncoding这两个选项是用于设置服务器响应的数据类型和编码

响应结构

当通过 Axios 发送请求之后，服务器对请求进行处理成功，最后 Axios 得到响应信息，而响应的信息结果如下：

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

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

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

  // `headers` 服务器响应的头
  headers: {},

   // `config` 是为请求提供的配置信息
  config: {},
  
  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance the browser
  request: {}
}