最新要闻
- 要闻:全新起亚K3开启预售 新款起亚K3怎么样?
- 今热点:只要78元!《元能失控》登陆任天堂国行Switch:支持多人联机 太罕见
- 今日热闻!累计订单已超5万!比亚迪豪华MPV腾势D9 EV官宣涨价6000元
- 送女神绝佳好礼 好吃还能发圈!榴芒一刻礼盒大促:立减179元
- 环球速讯:恐怖!男子酒后吃布洛芬致皮肤大面积剥脱 医生:重度药疹
- 焦点滚动:另起炉灶?马斯克怒批ChatGPT 欲开发替代品
- 资讯:建设银行e路通不用了直接扔了吗_建设银行e路通
- 恐怕人类永远也搞不定真正的AI!
- 环球时讯:黄仁勋带着NVIDIA新品发布会来了!RTX 4070梦碎
- 大量年轻人成为“果粉” :苹果连三星大本营都快攻陷了
- 精选!AGM G2 Guardian发布:全球首款500米范围热成像手机
- 全球时讯:不怕停电了?董明珠:格力开始研究将储能技术应用冰箱上
- 外敷仙人掌的禁忌和副作用_外敷仙人掌的禁忌
- 环球热文:官宣定档3月6日 领创科技旗舰荣耀Magic5系列即将国内亮相
- 需要去看医生的呼噜声什么样?这三种情况要特别注意:有危险
- 蔚来:阿尔卑斯全系车型采用800V方案 还将共享使用三代换电站
手机
iphone11大小尺寸是多少?苹果iPhone11和iPhone13的区别是什么?
警方通报辅警执法直播中被撞飞:犯罪嫌疑人已投案
- iphone11大小尺寸是多少?苹果iPhone11和iPhone13的区别是什么?
- 警方通报辅警执法直播中被撞飞:犯罪嫌疑人已投案
- 男子被关545天申国赔:获赔18万多 驳回精神抚慰金
- 3天内26名本土感染者,辽宁确诊人数已超安徽
- 广西柳州一男子因纠纷杀害三人后自首
- 洱海坠机4名机组人员被批准为烈士 数千干部群众悼念
家电
记录--如何优雅地校验后端接口数据
这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助
背景
最近新接手了一批项目,还没来得及接新需求,一大堆bug就接踵而至,仔细一看,应该返回数组的字段返回了 null
,或者没有返回,甚至返回了字符串 "null"
???
【资料图】
这我能忍?我立刻截图发到群里,用红框加大加粗重点标出。后端同学也积极响应,答应改正。
第二天,同样的事情又在其他的项目上演,我只是一个小前端,为什么什么错都找我啊!!
日子不能再这样下去,于是我决定写一个工具来解决遇到 bug 永远在找前端的困境。
TypeScript 运行时校验
如何对接口数据进行校验呢,因为我们的项目是 React+TypeScript 写的,所以第一时间就想到了使用 TypeScript 进行数据校验。但是众所周知,TypeScript 用于编译时校验,有没有办法作用到运行时呢?
我还真找到了一些运行时类型校验的库:typescript-needs-types,大部分需要使用指定格式编写代码,相当于对项目进行重构,拿其中 star 最多的 zod 举例,代码如下。
import { z } from "zod";const User = z.object({ username: z.string(),});User.parse({ username: "Ludwig" });// extract the inferred typetype User = z.infer;// { username: string }
我宁可查 bug 也不可能重构手里一大堆项目啊。此种方案 ❎。
此时看到了 typescript-json-schema 可以把 TypeScript 定义转为 JSON Schema ,然后再使用 JSON Schema 对数据进行校验就可以啦。这种方案比较灵活,且对代码入侵性较小。
搭建一个项目测试一下!
使用 npx create-react-app my-app --template typescript
快速创建一个 React+TS 项目。
首先安装依赖 npm install typescript-json-schema
创建类型文件 src/types/user.ts
export interface IUserInfo { staffId: number name: string email: string}
然后创建src/types/index.ts
文件并引入刚才的类型。
import { IUserInfo } from "./user";interface ILabel { id: number; name: string; color: string; remark?: string;}type ILabelArray = ILabel[];type IUserInfoAlias = IUserInfo;
接下来在package.json
添加脚本
"scripts": { // ... "json": "typescript-json-schema src/types/index.ts "*" -o src/types/index.json --id=api --required --strictNullChecks"}然后运行
npm run json
可以看到新建了一个 src/types/index.json
文件(此步在已有项目中可能会报错报错,可以尝试在 json
命令中添加 --ignoreErrors
参数),打开文件可以看到已经成功转成了 JSON Schema 格式。{ "$id": "api", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "ILabel": { "properties": { "color": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "remark": { "type": "string" } }, "required": [ "color", "id", "name" ], "type": "object" }, "ILabelArray": { "items": { "$ref": "api#/definitions/ILabel" }, "type": "array" }, "IUserInfoAlias": { "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "staffId": { "type": "number" } }, "required": [ "email", "name", "staffId" ], "type": "object" } }}
使用 JSON Schema 校验数据
至于如何使用JSON Schema 校验数据,我找到了现成的库ajv,至于为什么选择 ajv,主要是因为它说它很快,详见:github.com/ebdrup/json…
接下来尝试一下。我找到了中文版文档,有兴趣的可以去看下www.febeacon.com/ajv-docs-zh…
先安装依赖npm install ajv
,然后创建文件src/validate.ts
import Ajv from "ajv";import schema from "./types/index.json";const ajv = new Ajv({ schemas: [schema] });export function validateDataByType(type: string, data: unknown) { console.log(`开始校验,类型:${type}, 数据:`, data); var validate = ajv.getSchema(`api#/definitions/${type}`); if (validate) { const valid = validate(data); if (!valid) { console.log("校验失败", validate.errors); } else { console.log("校验成功"); } }}
接下来在src/index.tsx
添加下面代码来测试一下。
validateDataByType("IUserInfoAlias", { email: "idonteatcookie@gmail.com", name: "idonteatcookie", staffId: 12306})validateDataByType("IUserInfoAlias", { email: "idonteatcookie@gmail.com", staffId: 12306})validateDataByType("IUserInfoAlias", { email: "idonteatcookie@gmail.com", name: "idonteatcookie", staffId: "12306"})
可以在控制台看到成功打印如下信息:
拦截请求
因为项目中发送请求都是调用统一封装的函数,所以我首先想到的是在函数中增加一层校验逻辑。但是这样的话就与项目代码耦合严重,换一个项目又要再写一份。我真的有好多项目QAQ。
那干脆拦截所有请求统一处理好了。
很容易的找到了拦截所有 XMLHttpRequest
请求的库 ajax-hook,可以非常简单地对请求做处理。
首先安装依赖 npm install ajax-hook
,然后创建 src/interceptTool.ts
:
import { proxy } from "ajax-hook";export function intercept() { // 获取 XMLHttpRequest 发送的请求 proxy({ onResponse: (response: any, handler: any) => { console.log("xhr", response.response) handler.next(response); }, });}
这样就拦截了所有的XMLHttpRequest
发送的请求,但是我突然想到我们的项目,好像使用fetch
发送的请求来着???
好叭,那就再拦截一遍fetch
发送的请求。
export function intercept() { // ... const { fetch: originalFetch } = window; // 获取 fetch 发送的请求 window.fetch = async (...args) => { const response = await originalFetch(...args); response.clone().json().then((data: { result: any }) => { console.log("window.fetch", args, data); return data; }); return response; };}
为了证明拦截成功,使用json-server
搭建一个本地 mock 服务器。首先安装npm install json-server
,然后在根目录创建文件db.json
:
{ "user": { "staffId": 1, "name": "cookie1", "email": "cookie@cookie.com" }, "labels": [ { "id": 1, "name": "ck", "color": "red", "remark": "blabla" }, { "id": 2, "color": "green" } ]}
再在package.json
添加脚本
"scripts": { "serve": "json-server --watch db.json -p 8000"},
现在执行npm run serve
就可以启动服务器了。在src/index.tsx
增加调用接口的代码,并引入src/interceptTool.ts
。
import { intercept } from "./interceptTool";// ... other codeintercept();fetch("http://localhost:8000/user");const xhr = new XMLHttpRequest();xhr.open("GET", "http://localhost:8000/labels");xhr.send();
可以看到两种请求都拦截成功了。
校验接口返回数据
胜利在望,只差最后一步,校验返回数据。我们校验数据需要提供两个关键信息,数据本身和对应的类型名,为了将两者对应起来,需要再创建一个映射文件,把 url 和类型名对应起来。
创建文件 src/urlMapType.ts
然后添加内容
export const urlMapType = { "http://localhost:8000/user": "IUserInfoAlias", "http://localhost:8000/labels": "ILabelArray",}
我们在src/validate.ts
新增函数validateDataByUrl
import { urlMapType } from "./urlMapType";// ...export function validateDataByUrl(url: string, data: unknown) { const type = urlMapType[url as keyof typeof urlMapType]; if (!type) { // 没有定义对应格式不进行校验 return; } console.log(`==== 开始校验 === url ${url}`); validateDataByType(type, data);}
然后在src/interceptTool.ts
文件中引用
import { proxy } from "ajax-hook";import { validateDataByUrl } from "./validate";export function intercept() { // 获取 XMLHttpRequest 发送的请求 proxy({ onResponse: (response, handler: any) => { validateDataByUrl(response.config.url, JSON.parse(response.response)); handler.next(response); }, }); const { fetch: originalFetch } = window; // 获取 fetch 发送的请求 window.fetch = async (...args) => { const response = await originalFetch(...args); response.json().then((data: any) => { validateDataByUrl(args[0] as string, data); return data; }); return response; };}
现在可以在控制台看到接口数据校验的接口辣~ ✿✿ヽ(°▽°)ノ✿
总结下流程图
后续规划
目前所做的事情,准确的说不是拦截,只是获取返回数据,然后对比打印校验结果,因为初步目标不涉及数据的处理。
后续会考虑对不合法的数据进行处理,比如应该返回数组但是返回了null
的情况,如果能自动赋值[]
,就可以防止前端页面崩溃的情况了。
本文转载于:
https://juejin.cn/post/7166061734803963917
如果对您有所帮助,欢迎您点个关注,我会定时更新技术文档,大家一起讨论学习,一起进步。
-
世界今亮点!New Bing怼人、说谎、PUA,ChatGPT已经开始胡言乱语了
最近,来自大洋彼岸那头的ChatGPT科技浪潮席卷而来,微软将chatGPT整合搜索引擎Bing开启内测后,数百万...
来源: 记录--如何优雅地校验后端接口数据
世界今亮点!New Bing怼人、说谎、PUA,ChatGPT已经开始胡言乱语了
要闻:全新起亚K3开启预售 新款起亚K3怎么样?
今热点:只要78元!《元能失控》登陆任天堂国行Switch:支持多人联机 太罕见
今日热闻!累计订单已超5万!比亚迪豪华MPV腾势D9 EV官宣涨价6000元
送女神绝佳好礼 好吃还能发圈!榴芒一刻礼盒大促:立减179元
环球速讯:恐怖!男子酒后吃布洛芬致皮肤大面积剥脱 医生:重度药疹
焦点滚动:另起炉灶?马斯克怒批ChatGPT 欲开发替代品
全球播报:Rust 知识积累(1)
世界百事通!让WPF中的DataGrid像Excel一样可以筛选
全球头条:Codeforces Round #854 by cybercats (Div. 1+2) 1799 A~G 题解
全球报道:2363. 合并相似的物品
【天天速看料】c语言运算符优先级实例解析
资讯:建设银行e路通不用了直接扔了吗_建设银行e路通
恐怕人类永远也搞不定真正的AI!
环球时讯:黄仁勋带着NVIDIA新品发布会来了!RTX 4070梦碎
大量年轻人成为“果粉” :苹果连三星大本营都快攻陷了
精选!AGM G2 Guardian发布:全球首款500米范围热成像手机
全球时讯:不怕停电了?董明珠:格力开始研究将储能技术应用冰箱上
新消息丨.NET MAUI
外敷仙人掌的禁忌和副作用_外敷仙人掌的禁忌
环球热文:官宣定档3月6日 领创科技旗舰荣耀Magic5系列即将国内亮相
需要去看医生的呼噜声什么样?这三种情况要特别注意:有危险
蔚来:阿尔卑斯全系车型采用800V方案 还将共享使用三代换电站
【全球新视野】男子反复发烧20多天被诊出黑热病:发病率仅0.0108/10万
环球快报:一加Buds Pro 2轻享版上架:48dB深度降噪
今热点:11 款顶级 MySQL 图形化工具汇总,总有一款适合你!(建议收藏)
【速看料】Python实战项目3-前后端连接/首页轮播图表设计
热头条丨剑指 Offer 55 - II. 平衡二叉树(java解题)
焦点速讯:安装node并创建vue项目
报告称每天工作超8小时心脏病风险增8成:很多公司拒绝996、启用四天工作制
比亚迪专业个性化品牌曝光:首车性能对标奔驰大G 年内发布
苹果将成本转嫁给果粉!2024年iPad Pro要大涨价
LOL帧率近乎翻倍!Intel Arc A750新驱动测试:大幅提升、最大短板没有了
丰田有队友了!宝马氢燃料SUV将路试:16磅氢能跑500公里
世界速读:CSS中的BFC、IFC、GFC、FFC
环球即时:Synchronized,我要一层一层剥开你的心
全球视点!轻松玩转makefile|基础知识
环球聚焦:曝吴秀波儿子家暴成性,女方晒照满嘴是血,指证男方出轨乱约
周杰伦演唱会数百万人疯抢!演唱会门票30秒卖光
环球新资讯:长安发律师函控诉银河之光抄袭 吉利回应:毫无根据、误导公众
环球微速讯:【同步、共享和内容协作软件】上海道宁与ownCloud让您的团队随时随地在任何设备上轻松处理数据
全白外观拥有硬核实力!影驰Z790金属大师D5 Wi-Fi白金版主板评测:内存轻松提速10%
环球快讯:越来越多PC用户不愿买显卡了:2022年Q4桌面独显销量暴跌43%
世界第一次!中国空间站看到了在轨航天员的“三维皮肤”
【时快讯】89元 小米无线键鼠套装2上架:鼠标轻至45g
环球精选!运酒撞破酒缸1分钟损失5万!男子:一坛酒1000斤 1斤50块钱
天天快看点丨易基因|独家分享:高通量测序后的下游实验验证方法——DNA甲基化篇
IPO参考:联域光电拟深市主板IPO 郝氏控股二次递表港交所
【全球快播报】感冒的食疗偏方秘方_感冒的食疗偏方
8尺夫人面对面!《生化危机8 VR》IGN 8分 MTC用户9.7分
环球热点评!40多万的车没有语音控制功能!宝马遭X3车主集体投诉
今日聚焦!一加Ace 2V搭载旗舰级2.8D微弧玻璃:手感温润如玉
世界讯息:续航1整年!小米智能门锁M20大屏猫眼版开售:首发1899元
世界要闻:《艾尔登法环》原子之心机械姐妹花Mod 性感吸睛
自得其乐是什么意思?自得其乐的名人例子有哪些?
12%是零点几?12%公积金是什么档次?
给据邮件是什么意思?给据邮件如何填写?
男主角性格冰冷的小说有哪些?男主角性格冰冷的小说推荐
兔子能喝牛奶吗?兔子吃的食物有哪些?
小米手机屏幕校准在哪里?小米手机屏幕有多大?
集成显卡可以玩英雄联盟吗?集成显卡和独立显卡有什么区别?
华为mate9哪一年生产的?华为mate9参数配置
可视化图表之奥妙——百分比堆积条形图
看热讯:基于开源IM即时通讯框架MobileIMSDK:RainbowChat-iOS端v6.2版已发布
常用的xpath
环球观察:mybatis plus映射postgreSQL数组
世界资讯:redis实现用户查询次数限制
军用三防手机有哪些?军用三防手机推荐
苏泊尔电磁炉滴滴响不加热是什么原因?苏泊尔电磁炉滴滴响不加热怎么解决?
最新资讯:完美全面屏!努比亚Z50 Ultra官宣3月7日发布
新消息丨控告抄袭!长安给吉利发去律师函
【环球新要闻】BBA压力来了!李想:今年理想将挑战30-50万豪华SUV市场20%份额
环球快消息!SRC挖掘之Access验证校验的漏洞挖掘
【世界热闻】tomcat源码分析(一)如何启动服务
协同办公领域未来三大趋势(协同办公带来的机遇)
彻底理解 HashMap 及 LinkedHashMap,面试官请随便问!
当前焦点!轻量级CI/CD发布部署环境搭建及使用_02_docker安装jenkins
世界微速讯:理想汽车2022年亏损额创新高达20.32亿元
天天热议:腾势D9首创双枪充电 赵长江:比高压充电更节省社会成本
当前视讯!DXO排名全球第一!京东方认领荣耀Magic5/Pro屏幕
【全球播资讯】史诗级更新!雷军:小米12S Ultra 2倍变焦快捷按键正式上线
环球时讯:巧妙利用“慧言”机器人在安全场景中实践
每日消息!iOS封闭垄断 俄罗斯怒罚苹果9.06亿卢布:后者服软已悄悄支付
李想:比亚迪汽车毛利率20%左右 跟理想汽车很接近 良心
世界最新:梅西第七次当选世界足球先生 FIFA年度最佳球员!网友泪目:实至名归
全球消息!游戏第一神U上新!AMD锐龙9 7950X3D超频后更强:性能完秒13900KS
天天热点!40吨重 我国长征九号重型火箭未来将发射大型天文望远镜:探测地外生命
湖人官方:詹姆斯明日因右脚伤势缺战灰熊
全球热消息:世界第二大水电站16台机组全部通过验收:自主研制 登顶世界水电
全球观速讯丨增程是落后技术?李想:理想汽车单车型研发投入中国行业最高
环球今热点:10多天还没到 市民吐槽快递延误 客服:你投诉去吧
读Java性能权威指南(第2版)笔记04_ Java SE API技巧下
天天速递!承诺员工1人1套房!董明珠被传与王自如恋爱 格力愤怒已报案
事与愿违下一句啥意思_事与愿违下一句是什么
天天观热点:一元二次方程
全球报道:k8s中的PV和PVC
观察:Canvas画布
印尼16月大男婴重达27公斤:比8岁男童还重
焦点日报:最后一天赶紧换!苹果iPhone等设备全系电池明天涨价:最贵519元