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(三) ...

随机推荐

求n以内的质数（质数的定义：在大于1的自然数中，除了1和它本身意外，无法被其他自然数整除的数）
思路: 1.(质数筛选定理)n不能够被不大于根号n的任何质数整除,则n是一个质数2.除了2的偶数都不是质数代码如下: /** * 求n内的质数 * @param int $n * @return ar ...
@DateTimeFormat注解
@DateTimeFormat在spring-context依赖下,所在包如下当form表单中出现时间字段需要跟pojo对象中的成员变量进行数据绑定时,springmvc框架中的时间数据无法自动绑定 ...
python编程基础之一
编译:将全部代码转成二进制可执行文件速度快, c,c++等解释:一行一行的将代码解释速度慢 python,php等 python简介:Guido van Rossum 1989年常用的pyth ...
BZOJ 2535: [Noi2010]Plane 航空管制2
Description 世博期间,上海的航空客运量大大超过了平时,随之而来的航空管制也频频发生.最近,小X就因为航空管制,连续两次在机场被延误超过了两小时.对此,小X表示很不满意. 在这次来烟台的路上 ...
超炫酷的 IntelliJ IDEA 插件(一)
工善其事必先利器打开setting文件选择Plugins选项 Ctrl + Alt + S File -> Setting 我的idea是最新版本2019.02 有的和别人界面可能不一样主界 ...
算法学习之剑指offer（十）
一题目描述请实现一个函数用来判断字符串是否表示数值(包括整数和小数).例如,字符串"+100","5e2","-123","3 ...
转 NAT技术详解
NAT产生背景今天,无数快乐的互联网用户在尽情享受Internet带来的乐趣.他们浏览新闻,搜索资料,下载软件,广交新朋,分享信息,甚至于足不出户获取一切日用所需.企业利用互联网发布信息,传递资料和 ...
[BZOJ1054] 移动玩具
1054: [HAOI2008]移动玩具 Time Limit: 10 Sec Memory Limit: 162 MBSubmit: 2741 Solved: 1537[Submit][Stat ...
mysql 数据分析如何实现日报、周报、月报和年报？
以天为统计周期,是常见需求.周报.月报更是常见需求.长周期项目,甚至有年报需求.我已经掌握了mysql中按天统计,如何实现按年.按月.按周统计呢? 1.已掌握的技能:按天统计实现以天为统计周期很简单 ...
java与java web数组括号的不同
由于之前学JAVA SE数组时习惯了数组括号的写法,到了Web这里写了有点不太习惯了,赶快写篇博客加深一下印象哈一. java和java web中的数组的不同 java: int[] arr = n ...

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