0. 系列文章

项目源码请猛戳这里!!!

1. 前言

在响应回来处理响应结果时，我们需要先判断一下XMLHttpRequest 响应中的数字状态码是否是一个合法值，如果是一个我们认定的合法值，那么我们就继续进行下一步操作，如果不是，则做其他操作，如抛出异常等。在之前的代码中，我们把判断响应状态码是否合法是直接写死在代码里的，我们简单的认为当状态码在200到300之间时候它是合法的，否则即为不合法。虽然这样符合大多数用户的业务场景，但是我们这样武断的直接写死在代码里显然是不行的，因为我们毕竟覆盖不了所有用户的业务场景。这就要求状态码合法性的校验规则应该是由用户可配置的。

而在官方axios中，在请求配置对象里提供了validateStatus属性，该属性值是一个状态码校验函数，接收状态码作为函数参数，返回校验结果true或false，并且这个属性也在默认请求配置对象中。官方文档是这么介绍的：

// `validateStatus` defines whether to resolve or reject the promise for a given

// HTTP response status code. If `validateStatus` returns `true` (or is set to `null` or `undefined`),

// the promise will be resolved; otherwise, the promise will be rejected.

validateStatus: function (status) {

    return status >= 200 && status < 300; // default

}

如果validateStatus函数返回true，或者validateStatus属性值被设置为null，或者没有用户配置了validateStatus属性但是没有定义校验函数的时候，都认为是合法的，正常 resolve(response)，否则都会抛出异常。

搞明白官方axios中的validateStatus属性功能后，那么接下里，我们也要为我们的axios添加validateStatus属性，并实现其功能。

2. 向请求配置对象添加属性

向请求配置对象config中添加 validateStatus 属性之前，我们需要先在src/types/index.ts中的配置对象的接口类型定义AxiosRequestConfig上添加该属性的定义，如下：

export interface AxiosRequestConfig {

  // 新增

  validateStatus?: (status: Number) => Boolean;

}

添加好属性接口后，我们还要给默认请求配置对象src/default.ts中添加这两个属性，并且属性的默认值跟官方axios保持一直，如下：

const defaults: AxiosRequestConfig = {

  // 新增

  validateStatus(status: Number): boolean {

    return status >= 200 && status < 300

  }

};

3. 修改之前的状态码判断逻辑

在之前的代码中，我们把判断响应状态码是否合法是直接写死在代码里的，现在我们应该调用用户传入的状态码校验函数，用它来校验状态是否合法，如下：

function handleResponse(response: AxiosResponse): void {

    if (!validateStatus || validateStatus(response.status)) {

        resolve(response);

    } else {

        reject(

            createError(

                `Request failed with status code ${response.status}`,

                config,

                null,

                request.status,

                response

            )

        );

    }

}

OK，validateStatus属性就添加好了，并且状态码判断逻辑也修改了。接下来，我们就来编写demo来测试下效果如何。

4. demo编写

在 examples 目录下创建 checkStatus目录，在 checkStatus目录下创建 index.html:

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="UTF-8" />

    <title>checkStatus demo</title>

  </head>

  <body>

    <script src="/__build__/checkStatus.js"></script>

  </body>

</html>

接着再创建 app.ts 作为入口文件：

import axios from "../../src/axios";

axios.get("/api/checkStatus").then(res => {

  console.log(res);

});

axios

  .get("/api/checkStatus", {

    validateStatus: status => status >= 200 && status < 400

  })

  .then(res => {

    console.log(res);

  });

接着在 server/server.js 添加新的接口路由：

// 请求状态码合法性校验

router.get("/api/checkStatus", function(req, res) {

  res.status(304);

  res.end();

});

在本demo我们发送了两个请求，一个请求没有配置validateStatus属性，它会使用默认请求对象中的validateStatus校验函数，即判断状态码是否在200到300之间；第二个请求我们配置了validateStatus属性，并且配置了校验函数，判断状态是否在200到400之间。另外，在服务端路由接口中，我们故意把响应状态设置为304，这样第一个请求就会校验不通过抛出异常，第二个请求将会校验通过。

最后在根目录下的index.html中加上启动该demo的入口：

<li><a href="examples/checkStatus">checkStatus</a></li>

OK,我们在命令行中执行：

# 同时开启客户端和服务端

npm run server | npm start

接着我们打开 chrome 浏览器，访问 http://localhost:8000/ 即可访问我们的 demo 了，我们点击 checkStatus，就可以看到请求都已经正常发出，在控制台上第一个请求抛出了状态码异常，第二个请求正常响应了。

OK，以上就是为我们的axios添加validateStatus属性，并实现了其功能。

（完）

使用Typescript重构axios(二十七)——添加请求状态码合法性校验的更多相关文章

使用Typescript重构axios(二十三)——添加withCredentials属性
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十一)——请求取消功能：添加axios.isCancel接口
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十)——请求取消功能：实现第一种使用方式
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十二)——请求取消功能：收尾
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十六)——添加HTTP授权auth属性
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十八)——自定义序列化请求参数
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十九)——添加baseURL
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二)——项目起手，跑通流程
0.系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三)- ...
使用Typescript重构axios(二十四)——防御XSRF攻击
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...

随机推荐

深入理解SpringCloud之Gateway
虽然在服务网关有了zuul(在这里是zuul1),其本身还是基于servlet实现的,换言之还是同步阻塞方式的实现.就其本身来讲它的最根本弊端也是再此.而非阻塞带来的好处不言而喻,高效利用线程资源进而 ...
node 利用命令行交互生成相应模板
目录 readline 实现使用process实现使用 inquirer 调用的生成模板方法 (generator 方法) 创建时间:2019-10-15 测试环境:win10 node-v10. ...
【THE LAST TIME】this：call、apply、bind
前言 The last time, I have learned [THE LAST TIME]一直是我想写的一个系列,旨在厚积薄发,重温前端. 也是给自己的查缺补漏和技术分享. 欢迎大家多多评论指点 ...
MFC下使用Mysql
MFC工程需要使用Mysql数据库中遇到的问题记录下. 1.首先去官网下载下Mysql安装包,安装下Mysql. 我在这边下载的是mysql-installer-community-5.7.16.0. ...
winsock完成端口套接字重用注意事项
刚申请到博客,第一篇随笔(๑•̀ㅂ•́)و✧ 关于DisconnectEx的一个问题,目前主要发现在windows10中出现了这个问题,winserver2008 win7都没有这个问题. 被Disc ...
indexeddb：浏览器中的数据库
随着浏览器功能的不断加强,越来越多的网站开始考虑将大量的数据存储在客户端.这样的考虑是为了直接从本地获取数据,减少从服务器获取数据耗费的网络资源. 原有的浏览器数据存储方案都不适合存储大量数据.Coo ...
[Luogu2359] 三素数数
题目背景蛟川书院的一道练习题QAQ 题目描述如果一个数的所有连续三位数字都是大于100的素数,则该数称为三素数数.比如113797是一个6位的三素数数. 输入输出格式输入格式: 一个整数n(3 ...
C++中哪些函数不能声明为virtual?
首先要明确,virtual是用于支持类多态的关键字,所以出现在类声明之外的地方都是错误的.由此可以断定下文的1. 普通函数(即非类成员函数)不能是virtual的,否则不能通过编译,virtual只能 ...
Java获取文件中视频的时长
public void ReadVideoTime(String path) { long sum = 0; long num = 0; File source = new File(path[i]) ...
【Dubbo】Zookeeper+Dubbo项目demo搭建
一.Dubbo的注解配置在Dubbo 2.6.3及以上版本提供支持. 1.@Service(全路径@org.apache.dubbo.config.annotation.Service) 配置服务提 ...

使用Typescript重构axios(二十七)——添加请求状态码合法性校验