React学习笔记06-Axios网络请求组件

young 670 2022-09-30

前端网络请求的几种方式

Ajax

传统的Ajax是基于XMLHttpRequest（XHR）

Ajax的配置和调用方式等非常的混乱，编码起来很复杂，一般很少直接使用，而是使用jQuery

jQuery-Ajax

相比于传统的Ajax非常好用，但是jQuery整个项目太大，单纯使用ajax却要引入整个jQuery非常的不合理，采取个性化打包的方案又不能享受CDN服务，并且它是基于原生的XHR开发，XHR本身的架构不清晰

Fetch API

Fetch是Ajax的替换方案，基于Promise设计，很好的进行了关注分离

但是Fetch也有很明显的缺点

  • Fetch是一个low-level（底层）的API，没有封装好各种各样的功能和实现

  • 发送网络请求需要自己来配置Header的Content-Type，不会默认携带cookie等

  • 错误处理相对麻烦，只有网络错误才会reject，HTTP的状态码404或者500不会被标记为reject

  • 不支持取消一个请求，不能查看一个请求的进度

Fetch学习地址：https://developer.mozilla.org/zh-CN/docs/Web/API/Fetch_API/Using_Fetch

Axios

axios是目前前端使用非常广泛的网络请求库，包括Vue作者也是推荐在Vue中使用axios

只要特点包括：

  • 在浏览器中发送XMLHttpRequest请求
  • 在node.js中发送http请求
  • 支持Promise API
  • 拦截请求和响应
  • 转换请求和响应数据等

Axios

Axios基本使用

支持多种请求方式

  • axios(config)
  • 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.path(url [,data [,config]])

Axios发送请求

使用httpbin.org进行测试

发送get请求

axios({
  method: "get",
  url: "https:httpbin.org/get",
  params: {
    name: "way",
    age: 18
  }
}).then(res => {
  console.log("请求结果:", res);
}).catch(err => {
  console.log("错误信息:", err);
});

也可以使用get方法，就可以不用传method了，默认情况下，不传method也是发送get请求

axios.get("https://httpbin.org/get", {
  params: {
    name: "kobe",
    age: 40
  }
}).then(res => {
  console.log("请求结果:", res);
}).catch(err => {
  console.log("错误信息:", err);
});

也可以使用await、async在componentDidMount中发送网络请求

async componentDidMount() {
  const result = await axios.get("https://httpbin.org/get", {
    params: {
      name: "kobe",
      age: 40
    }
  })
  console.log(result);
}

有错误的时候，await中使用try-catch来处理错误信息

async componentDidMount() {
  try {
    const result = await axios.get("https://httpbin.org/get", {
      params: {
        name: "kobe",
        age: 40
      }
    })
    console.log(result);
  } catch(err) {
    console.log(err);
  }
}

发送多个并发的请求

const request1 = axios.get("https://httpbin.org/get", {
  params: {name: "why", age: 18}
});
const request2 = axios.post("https://httpbin.org/post", {
  name: "kobe",
  age: 40
})
axios.all([request1, request2]).then(([res1, res2]) => {
  console.log(res1, res2);
}).catch(err => {
  console.log(err);
})

axios.all本质上是Promise.all

axios(config)和axios.get()或axios.post()本质上都是调用axios.request()方法

axios函数、get、post请求本质上都是axios.request请求

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

响应结构信息

{
  // `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.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

自定义实例默认配置

const instance = axios.create({
  baseURL: 'https://api.example.com'
});

// Alter defaults after instance has been created
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

配置信息优先级

  • 优先是请求的config参数配置；
  • 其次是实例的default中的配置；
  • 最后是创建实例时的配置；

Axios拦截器

axios库有一个非常好用的特性是可以添加拦截器：

  • 请求拦截器：在发送请求时，请求被拦截；

    • 发送网络请求时，在页面中添加一个loading组件作为动画；
    • 某些网络请求要求用户必须登录，可以在请求中判断是否携带了token，没有携带token直接跳转到login页面；
    • 对某些请求参数进行序列化；

  • 响应拦截器：在响应结果中，结果被拦截；

    • 响应拦截中可以对结果进行二次处理（比如服务器真正返回的数据其实是在response的data中）；
    • 对于错误信息进行判断，根据不同的状态进行不同的处理
axios.interceptors.request.use(config => {
  // 1.发送网络请求时，在页面中添加一个loading组件作为动画；

  // 2.某些网络请求要求用户必须登录，可以在请求中判断是否携带了token，没有携带token直接跳转到login页面；

  // 3.对某些请求参数进行序列化；
  return config;
}, err => {
  return err;
})

axios.interceptors.response.use(response => {
  return response.data;
}, err => {
  if (err && err.response) {
    switch (err.response.status) {
      case 400:
        err.message = "请求错误";
        break;
      case 401:
        err.message = "未授权访问";
        break;
    }
  }
  return err;
})

axios进行二次封装

默认情况下，我们可以直接使用axios进行开发

但是如果多个地方直接依赖axios，某天axios出现重大bug，并且其不再维护时，我们就需要寻找一个新的网络请求库或者自己进行二次封装，但是大量的地方直接依赖axios，修改起来很不方便，如果我们自己进行了二次封装，并且暴露一套自己的API，那么修改起来就很简单了。

创建一个service文件夹，用于存放所有的网络请求相关的内容。

创建文件config.js，用于存放一些配置信息

export const TIMEOUT = 5000;

const devBaseURL = "https://httpbin.org";
const proBaseURL = "https://production.org";
console.log(process.env.NODE_ENV);
export const baseURL = process.env.NODE_ENV === 'development' ? devBaseURL: proBaseURL;

创建request.js，用于封装请求对象

import axios from 'axios';

import {
  TIMEOUT,
  baseURL
 } from "./config";

const instance = axios.create({
  timeout: TIMEOUT,
  baseURL: baseURL
})

axios.interceptors.request.use(config => {
  // 1.发送网络请求时，在页面中添加一个loading组件作为动画；

  // 2.某些网络请求要求用户必须登录，可以在请求中判断是否携带了token，没有携带token直接跳转到login页面；

  // 3.对某些请求参数进行序列化；
  return config;
}, err => {
  return err;
})

instance.interceptors.response.use(response => {
  return response.data;
}, err => {
  if (err && err.response) {
    switch (err.response.status) {
      case 400:
        err.message = "请求错误";
        break;
      case 401:
        err.message = "未授权访问";
        break;
    }
  }
  return err;
})

export default instance;
React