第15章与服务端通信axios

实际项目中，页面数据通常从服务端获取，Vue官方推荐使用axios完成ajax请求。

Axios是一个基于Promise的HTTP客户端，广泛用于浏览器和node.js环境中进行HTTP请求。

15.1 安装

通过cdn引入

html

<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

通过npm安装

shell

npm install axios --save

在vue脚手架中结合vue-axios使用

shell

npm install axios vue-axios

javascript

import { createApp } from 'vue'
import App from './App.vue'

import axios from 'axios'
import VueAxios from 'vue-axios'
axios.defaults.baseURL = "/api"

const app = createApp(App);
app.use(VueAxios, axios)
app.mount('#app')
//createApp(App).use(VueAxios, axios).mount('#app')
//createApp(App).mount('#app')

15.2 基本用法

http最基本的请求就是get请求与post请求。

发送GET请求

javascript

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

发送GET请求（使用params传递查询参数）

javascript

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

发送POST请求

javascript

axios.post('http://localhost:3000/posts', { title: "axios post", content: "axios post content" })
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

15.3 axios API

javascript

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

15.4 请求配置

请求配置

也就是axios(config)中的config配置对象都有哪些可以自定义的属性

json

{
  // `url` 是用于请求的服务器 URL
  url: '/user',
 
  // `method` 是创建请求时使用的方法
  method: 'get', // 默认值
 
  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',
 
  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream
  // 你可以修改请求头。
  transformRequest: [function (data, headers) {
    // 对发送的 data 进行任意转换处理
 
    return data;
  }],
 
  // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [function (data) {
    // 对接收的 data 进行任意转换处理
 
    return data;
  }],
 
  // 自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},
 
  // `params` 是与请求一起发送的 URL 参数
  // 必须是一个简单对象或 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', 'DELETE 和 'PATCH' 请求方法
  // 在没有设置 `transformRequest` 时，则必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属: FormData, File, Blob
  // - Node 专属: Stream, Buffer
  data: {
    firstName: 'Fred'
  },
  
  // 发送请求体数据的可选语法
  // 请求方式 post
  // 只有 value 会被发送，key 则不会
  data: 'Country=Brasil&City=Belo Horizonte',
 
  // `timeout` 指定请求超时的毫秒数。
  // 如果请求时间超过 `timeout` 的值，则请求会被中断
  timeout: 1000, // 默认值是 `0` (永不超时)
 
  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // default
 
  // `adapter` 允许自定义处理请求，这使测试更加容易。
  // 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。
  adapter: function (config) {
    /* ... */
  },
 
  // `auth` HTTP Basic Auth
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },
 
  // `responseType` 表示浏览器将要响应的数据类型
  // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  // 浏览器专属：'blob'
  responseType: 'json', // 默认值
 
  // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  // 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // 默认值
 
  // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称
  xsrfCookieName: 'XSRF-TOKEN', // 默认值
 
  // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值
 
  // `onUploadProgress` 允许为上传处理进度事件
  // 浏览器专属
  onUploadProgress: function (progressEvent) {
    // 处理原生进度事件
  },
 
  // `onDownloadProgress` 允许为下载处理进度事件
  // 浏览器专属
  onDownloadProgress: function (progressEvent) {
    // 处理原生进度事件
  },
 
  // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  maxContentLength: 2000,
 
  // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数
  maxBodyLength: 2000,
 
  // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
  // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，
  // 则promise 将会 resolved，否则是 rejected。
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认值
  },
 
  // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  // 如果设置为0，则不会进行重定向
  maxRedirects: 5, // 默认值
 
  // `socketPath` 定义了在node.js中使用的UNIX套接字。
  // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  // 只能指定 `socketPath` 或 `proxy` 。
  // 若都指定，这使用 `socketPath` 。
  socketPath: null, // default
 
  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),
 
  // `proxy` 定义了代理服务器的主机名，端口和协议。
  // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。
  // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。
  // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https`
  proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },
 
  // see https://axios-http.com/zh/docs/cancellation
  cancelToken: new CancelToken(function (cancel) {
  }),
 
  // `decompress` indicates whether or not the response body should be decompressed 
  // automatically. If set to `true` will also remove the 'content-encoding' header 
  // from the responses objects of all decompressed responses
  // - Node only (XHR cannot turn off decompression)
  decompress: true // 默认值
 
}

响应结构

json

{
  // `data` 由服务器提供的响应，会自动解析为json格式
  data: {},
 
  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,
 
  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 是服务器响应头
  // 所有的 header 名称都是小写，而且可以使用方括号语法访问
  // 例如: `response.headers['content-type']`
  headers: {},
 
  // `config` 是 `axios` 请求的配置信息
  config: {},
 
  // `request` 是生成此响应的请求
  // 在node.js中它是最后一个ClientRequest实例 (in redirects)，
  // 在浏览器中则是 XMLHttpRequest 实例
  request: {}
}

15.5 并发请求

在JavaScript中，使用axios进行并发请求时，可以使用Promise.all或者axios.all结合axios.spread来处理。以下是使用Promise.all的示例代码：

javascript

const axios = require('axios');
 
// 创建多个请求
const request1 = axios.get('https://api.example.com/data1');
const request2 = axios.get('https://api.example.com/data2');
const request3 = axios.get('https://api.example.com/data3');
 
// 使用Promise.all并发执行请求
Promise.all([request1, request2, request3]).then(axios.spread((response1, response2, response3) => {
    console.log(response1.data);
    console.log(response2.data);
    console.log(response3.data);
})).catch(error => {
    console.error('There was an error!', error);
});

在这个例子中，Promise.all 用于等待所有请求都完成，然后通过axios.spread来分别处理每个响应。如果任何请求失败，则会进入catch块处理错误。

15.6 创建实例

在JavaScript中，使用axios库创建实例可以让你创建一个带有特定配置的axios对象，例如基础URL、请求超时、自定义头信息等。以下是创建axios实例的示例代码：

javascript

const axios = require('axios'); // 引入axios库
 
// 创建axios实例
const instance = axios.create({
  baseURL: 'http://example.com/api', // 设置基础URL
  timeout: 1000, // 请求超时时间（毫秒）
  headers: {'X-Custom-Header': 'foobar'} // 自定义头信息
});
 
// 使用实例发送请求
instance.get('/someEndpoint')
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

在这个例子中，我们首先引入了axios库，然后使用axios.create方法创建了一个带有特定配置的实例。之后，我们使用这个实例来发送一个GET请求到http://example.com/api/someEndpoint。这个实例会自动应用我们在创建时设置的基础URL和头信息，并且如果请求在指定的时间内没有响应，会自动超时。

15.7 配置默认值

对于每次请求相同的配置选项，可以通过配置选项设置默认值来简化代码编写。

全局默认值

在axios中配置全局默认值可以通过axios.defaults.xxx来设置。例如，你可以设置全局的baseURL和timeout：

javascript

import axios from 'axios';
 
// 设置全局默认的baseURL
axios.defaults.baseURL = 'https://api.example.com';
 
// 设置全局默认的timeout时间
axios.defaults.timeout = 1000;
 
// 你还可以设置headers等其他配置
axios.defaults.headers.common['Authorization'] = 'Bearer your-token';
axios.defaults.headers.post['Content-Type'] = 'application/json';
 
// 使用axios发送请求时，将自动应用这些默认配置
axios.get('/endpoint')
  .then(response => {
    // handle success
    console.log(response);
  })
  .catch(error => {
    // handle error
    console.log(error);
  });

这样，你在创建新的请求时，就无需每次都指定相同的配置了。

实例默认值

在axios中，可以通过创建一个axios实例并配置默认值来设置全局默认值。以下是如何设置axios默认值的示例代码：

javascript

const axios = require('axios');
 
// 创建一个axios实例
const instance = axios.create({
  baseURL: 'http://example.com', // 全局基础URL
  timeout: 1000, // 请求超时时间
  headers: {'X-Custom-Header': 'foobar'} // 全局自定义头部
});
 
// 使用实例来发送请求
instance.get('/api/test')
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

在这个例子中，我们创建了一个axios实例，并为它设置了基础URL、超时时间和自定义头部。之后，我们使用这个实例来发送请求，这样所有的请求都会自动使用这些默认值。

15.8 拦截器

拦截器的原理

1、拦截器分为请求拦截器，和响应body拦截器

2、请求拦截器的主要作用，可以理解为给请求body加一下附带参数，如请求token，或者对请求做一些过滤，比如判定请求时一个非法请求时直接reject。

3、响应body拦截器的作用在于可以在框架级别对于响应body的内容进行合适的处理，比如401的http status code直接导航用到到登录页进行重新鉴权，亦或者直接做一个续期token的操作，并且在续期成功之后直接重放刚才的请求。

4、拦截器是axios的精华部分。

示例

javascript

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

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么
    return Promise.reject(error);
  });

15.9 小结

无

第15章 与服务端通信axios ​

15.1 安装 ​

通过cdn引入 ​

通过npm安装 ​

在vue脚手架中结合vue-axios使用 ​

15.2 基本用法 ​

发送GET请求 ​

发送GET请求（使用params传递查询参数） ​

发送POST请求 ​

15.3 axios API ​

15.4 请求配置 ​

请求配置 ​

响应结构 ​

15.5 并发请求 ​

15.6 创建实例 ​

15.7 配置默认值 ​

全局默认值 ​

实例默认值 ​

15.8 拦截器 ​

拦截器的原理 ​

示例 ​

15.9 小结 ​

第15章与服务端通信axios

15.1 安装

通过cdn引入

通过npm安装

在vue脚手架中结合vue-axios使用

15.2 基本用法

发送GET请求

发送GET请求（使用params传递查询参数）

发送POST请求

15.3 axios API

15.4 请求配置

请求配置

响应结构

15.5 并发请求

15.6 创建实例

15.7 配置默认值

全局默认值

实例默认值

15.8 拦截器

拦截器的原理

示例

15.9 小结