如何在 HTML 编辑器中构建基于 JSON Schema 的文档结构合法性校验器

秋枫小哥_1882

秋枫小哥_1882

2026-06-14

917人浏览

原创

vanilla-jsonschema-form + ajv 是最可行路径,因其不依赖框架、不污染 dom、校验逻辑可复用;核心在于用 ajv 构建独立校验层,全量校验、编译 schema、精准映射错误路径,并手动桥接 schema 与 html 编辑器。

如何在 html 编辑器中构建基于 json schema 的文档结构合法性校验器

直接用 vanilla-jsonschema-form + ajv 组合是最可行的路径,不依赖框架、不污染 DOM、校验逻辑可复用——自己从零解析 Schema 并映射到 HTML 校验规则,90% 的坑都集中在字段类型误判和错误定位错位上。

为什么不能只靠 HTML5 表单原生验证

HTML5 原生 requiredpatternminlength 等属性只覆盖极小部分 JSON Schema 语义。比如 "type": "integer" 在 Schema 中要求整数,但 <input type="number"> 仍允许输入 3.14 或空字符串;"enum" 列表无法用 <select></select> 自动同步 disabled 状态;"oneOf" 或嵌套 "properties" 更是完全无对应 HTML 原生能力。

常见错误现象:

  • 用户填了 "age": "25"(字符串),表单却通过校验,后端 JSON.parse() 后类型不匹配
  • "dependencies" 规则被忽略,导致隐藏字段未校验却提交成功
  • 错误提示只显示“Invalid”,不指向具体字段路径(如 #/user/email

用 ajv 构建独立校验层,绕过 UI 框架绑定

关键不是“把 Schema 渲染成表单”,而是“让表单数据流经 Schema 验证器”。ajv 不关心 DOM,只认 JavaScript 对象 —— 这正是解耦的核心。

实操建议:

html-ppt-to-pdf
html-ppt-to-pdf

将使用 `

` 约定的 HTML 幻灯片转换为高保真、矢量文本 PDF(使用 Playwright + Chromium 原生 PDF 功能)。

下载
  • 不要在 onchange 里对每个字段单独校验,改用 ajv.validate(schema, formData) 全量校验,否则 "if"/"then" 等交叉规则永远漏检
  • 校验前先用 ajv.compile(schema) 编译一次,避免每次提交都重复解析 Schema(尤其含 "definitions" 的大 Schema)
  • 错误对象里的 .errors 数组含 instancePath 字段(如 "/user/phone"),别手动拼 DOM ID,用它直接映射到对应 <input name="user.phone"> 元素
  • "format": "email" 这类规则,ajv 默认不启用,需显式调用 ajv.addFormat("email", ...),否则形同虚设

如何让 HTML 编辑器实时反馈 Schema 错误

编辑器本身(如 Monaco、CodeMirror)只负责文本,真正校验必须由 JS 主动触发:监听 blur 或防抖后的 input,提取当前内容 → JSON.parse() → 传给 ajv.validate()

容易踩的坑:

  • JSON.parse() 失败时,ajv 不会运行,但你得自己捕获 SyntaxError 并标记整个编辑区为“非法 JSON”,不能静默吞掉
  • 用户输入 {"name": "张三",}(末尾逗号),JSON.parse() 直接抛错,此时 Schema 校验根本没机会执行 —— 必须分两层:先语法合法,再语义合法
  • 错误定位要精确到字符偏移(error?.position),而不是只标红整行;Monaco 可用 editor.deltaDecorations(),CodeMirror 用 setGutterMarker()
  • 大文档(>100KB)下,ajv.validate() 可能卡顿,建议加 timeout:若 300ms 未返回,降级只做基础语法检查

Schema 校验结果怎么映射回 HTML 结构

别试图把 JSON Schema 转成 HTML 属性再塞进 <input>,而是维护一份字段元数据映射表:{ "user.email": { type: "string", format: "email", required: true } },校验出错时查表渲染提示。

要点:

  • HTML 中每个可编辑字段必须有稳定、可推导的 namedata-path,例如 name="config.api.timeout",用于和 instancePath 对齐
  • "required": ["a", "b"] 不等于所有字段都标红,而是当 ab 都为空时才报错;单独缺 ab 有值,可能不触发
  • 数组项校验("items": { "type": "string" })需按索引展开路径,如 /users/0/name,对应 name="users[0].name"
  • 嵌套 "anyOf" 场景下,ajv 默认只报第一个匹配失败的分支,需开启 allErrors: true 才显示全部问题

最常被忽略的是:Schema 校验器和 HTML 编辑器之间没有天然桥梁,所有路径映射、错误注入、状态同步都得手动桥接。哪怕用了 vanilla-jsonschema-form,它也只管渲染,不自动把编辑器内容喂给 ajv —— 这一跳,必须你自己写。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

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

下载

相关标签:

html javascript js json

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

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

4855

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

2852

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

2510

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

2539

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

4519

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

2481

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

2269

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2088

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2048

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 204人学习