Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。

Axios 具有以下特性:

  • 从浏览器中创建 XMLHttpRequests
  • 从 node.js 创建 http 请求
  • 支持 Promise API
  • 拦截请求和响应
  • 转换请求数据和响应数据
  • 取消请求
  • 自动转换 JSON 数据
  • 客户端支持防御 XSRF

Axios 的使用需要进行安装与配置,下面分别介绍一下这两步:

 安装

NPM 安装方式

npm install axios

CDN方式

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

配置

在项目的 main.js 文件中,导入 axios ,并且将其挂载到 Vue 实例的 prototype 原型上。同时配置项目所要访问的服务端 API 的根路径,这样后续发起请求就会简便很多。示例代码如下:

import Vue from "vue";
import axios from "axios";
// 配置请求的跟路径
axios.defaults.baseURL = "http://127.0.0.1:8888/api/";
// 将 axios 实例挂载为 Vue 的一个全局方法
Vue.prototype.$http = axios;

经过以上的安装配置,我们就可以在项目中使用 Axios 发起网络请求了,Axios 为所有支持的请求方法还提供了别名,支持的方法如下:

axios.request(config)

axios.get(url[, config])

axios.delete(url[, config])

axios.head(url[, config])

axios.options(url[, config])

axios.post(url[, data[, config]])

axios.put(url[, data[, config]])

axios.patch(url[, data[, config]])

注意:在使用别名方法时, urlmethoddata 这些属性都不必在配置中指定。示例如下:

// 直接调用 get() 方法,传入 API 接口数据即可
axios.get('/user?ID=12345')

注:axios 发起请求后返回的是一个 Promise 对象,所以可以使用 .then().catch() 方法来接收返回值并处理两种场景下的逻辑,最推荐使用的还是 await/async 异步编程的最佳方案。示例代码如下:

    async login() {
      const {data: res} = await axios.get('/user', this.loginForm)
    }

注意:使用 axios 发起网络请求返回的数据最外层 axios 会默认包裹在 data 对象中,也就是说我们得到的数据结构上最外面又多了一层。所以可以在接收请求返回值时进行解构赋值。

Axios 处理并发请求的助手函数:

axios.all(iterable)

axios.spread(callback)

Axios 提供的请求配置项:

如下示例代码中是创建请求时可以用的配置选项。只有 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` indicates encoding to use for decoding responses
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // default

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

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  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, // default

  // `socketPath` defines a UNIX Socket to be used in node.js.
  // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
  // Only either `socketPath` or `proxy` can be specified.
  // If both are specified, `socketPath` is used.
  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) {
  })
}

Axios 请求响应的数据结构:(它们都被包裹在 data 对象中)

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

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

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

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

   // `config` 是为请求提供的配置信息
  config: {},
 // 'request'
  // `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: {}
}

Axios 的默认配置项

可以配置一些用于所有请求的 axios 默认项来简化我们代码量、方便我们更好的处理数据。比如,配置全局所有请求的根路径、配置全局请求的请求头字段等。示例如下

注:axios 的全局配置可以新建一个 axios.js 文件来单独写然后再导入到 main.js 文件中,也可以直接写到 main.js 文件中。

axios.defaults.baseURL = 'http://127.0.0.1:8888/api/';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

Axios 拦截器

axios 的拦截器有请求拦截器响应拦截器,在请求拦截器中更多的是处理请求发起前需要做的事,而在响应拦截器中更多的是处理响应回来的数据或者验证请求结果等。示例如下:

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;// 注意:这里必须要 return config
  }, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;// 注意:这里必须要 return response
  }, function (error) {
    // 对响应错误做点什么
    return Promise.reject(error);
  });

axios拦截器在项目中主要的作用是可以用于在请求拦截器中对用于客户端发起的此次请求进行身份验证,判断当前的请求接口是否需要权限密钥,比如在访问一些需要权限的接口时,我们可以完善当前请求的数据让我们的请求可以符合接口要求,而在响应拦截器中则可以验证返回的数据状态解构出我们更方便处理的数据结构

以上粗略的介绍了 Axios 的基本使用以及常用的一些方法和场景,更多更详细Axios 使用方法介绍可直接点击链接访问  Axios 中文网中文文档 。

好好学习、天天向上!        :)

Logo

CSDN联合极客时间,共同打造面向开发者的精品内容学习社区,助力成长!

更多推荐