如何在NodeJS中利用JSON-Schema实现接口数据的验证

胖强酱_5759

胖强酱_5759

2026-05-01

478人浏览

原创

直接用 ajv 而不是手写 if 校验,因为手写易漏判、难维护、无法复用,而 ajv 是 node.js 生态事实标准,支持多版 json schema、错误清晰、性能可靠。

如何在nodejs中利用json-schema实现接口数据的验证

为什么直接用 ajv 而不是手写 if 校验?

因为接口字段一多,手写校验逻辑极易漏判、难维护,且无法复用校验规则。而 ajv 是目前 Node.js 生态中事实标准的 JSON Schema 验证器,支持 Draft-04/07/2019-09/2020-12,错误提示清晰,性能也经过大量生产验证。

常见错误现象:用 JSON.parse() 后仅检查字段是否存在,但没校验类型、范围、格式(如邮箱、日期字符串)、必填项缺失——这些都得靠 schema 显式定义。

  • 必须安装 ajv(v8+ 推荐,v6 已停止维护):npm install ajv
  • 不要用 ajv-errors 插件来“美化”错误——它会让错误结构变复杂,反而干扰调试;原生 errorsText() 或遍历 validation.errors 更可控
  • schema 必须是合法 JSON Schema 对象,不能是字符串;若从文件读取,请先 JSON.parse()

如何定义并复用一个用户注册的 schema?

真实场景中,同一个 schema 往往用于多个路由(如 POST /register、PUT /user/profile),所以应抽离为模块导出,避免重复定义。

示例 schema(保存为 schema/user-register.json):

{
  "type": "object",
  "required": ["email", "password", "nickname"],
  "properties": {
    "email": { "type": "string", "format": "email" },
    "password": { "type": "string", "minLength": 8 },
    "nickname": { "type": "string", "maxLength": 20 },
    "age": { "type": ["integer", "null"], "minimum": 0, "maximum": 150 }
  },
  "additionalProperties": false
}
  • "additionalProperties": false 很关键——防止客户端传入未声明字段(如 admin: true)被静默忽略
  • "format": "email" 依赖 ajv 的 format 插件,默认不启用;需显式添加:new Ajv({ formats: { email: true } })
  • 若需校验手机号、身份证号等自定义格式,用 addFormat() 注册正则,别硬塞进 schema

如何在 Express 中拦截并返回结构化验证错误?

验证应在请求体解析之后、业务逻辑之前执行,推荐封装成中间件,统一处理错误格式。

Rydberg Agent Node
Rydberg Agent Node

使用一条命令部署ProbeChain Rydberg测试网代理节点。自动注册为Agent(NodeType=1),免gas,支持macOS/Linux/Windows。触发词:/r

下载

实操建议:

  • 用 req.body 直接传给 validate(),不要二次解构或转换(如转成 class 实例)——否则 schema 失效
  • 验证失败时,validate.errors 是数组,每个元素含 instancePath(如 "/email")、message、keyword(如 "required")
  • 不要直接 res.status(400).json(validate.errors) ——前端难解析;建议统一包装:{ code: 400, message: "Validation failed", details: errors.map(e => ({ field: e.instancePath.slice(1), reason: e.message })) }
  • 对 application/json 请求才验证;非 JSON 请求(如 multipart/form-data)需另写逻辑或跳过

为什么 ajv.compile() 后的验证函数不能跨请求复用?

可以,而且必须复用。每次调用 ajv.compile(schema) 都会生成一个新函数,但该函数本身是纯函数、无状态,可安全缓存并多次调用。

容易踩的坑:

  • 在路由 handler 内反复调用 ajv.compile() —— 每次请求都重新编译,浪费 CPU,且无法利用 ajv 内部缓存
  • 正确做法:启动时编译一次,导出验证函数:const validateUserRegister = ajv.compile(userRegisterSchema),后续直接 validateUserRegister(req.body)
  • 如果 schema 动态生成(如根据 query 参数切换),才需要运行时编译,但这种情况极少,且要加 LRU 缓存避免爆炸式编译
  • 注意:ajv 实例本身不应跨进程共享;Cluster 模式下每个 worker 自己 new 一个

最常被忽略的是 format 校验的开关和 additionalProperties 的默认行为——它们不开、不设,验证就形同虚设。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nodejs js json node

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2909

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2208

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1180

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1118

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1316

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2058

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3220

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14315

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
快速入门Node.JS全套完整版
快速入门Node.JS全套完整版

共83课时 | 13.2万人学习

nodejs开发基础教程
nodejs开发基础教程

共15课时 | 4.9万人学习

JavaScript设计模式视频教程
JavaScript设计模式视频教程

共28课时 | 6.2万人学习