术语表

核心概念

特殊字段 (Special Field)

具有特定语义和行为的字段,需要编辑器提供特殊的交互和展示方式。包括但不限于:

  • 引用字段 (Reference Field): 引用其他 JSON 对象的字段
  • 必填字段 (Required Field): 在 Schema 中标记为必填的字段
  • 脚本字段 (Script Field): 包含可执行代码的字段

匹配规则 (Matching Rule)

用于识别和处理特殊字段的规则集合,支持:

  1. 字段名匹配: 通过字段名识别特殊字段
  2. 路径匹配: 通过 JSONPath 匹配特定位置的字段
  3. 值类型匹配: 通过字段值的类型进行匹配
  4. 正则匹配: 通过正则表达式匹配字段名或值
  5. 组合匹配: 多个规则的与/或组合

样式系统 (Style System)

定义字段在编辑器中的视觉呈现,包括:

  1. 基础样式: 字体、颜色、边框等
  2. 状态样式: 悬停、选中、禁用等状态
  3. 交互样式: 点击、拖拽等操作的视觉反馈
  4. 动画效果: 展开/收起、错误提示等动画

插件 (Plugin)

扩展编辑器功能的独立模块,可以:

  1. 添加新的字段类型
  2. 自定义匹配规则
  3. 扩展交互行为
  4. 添加工具栏按钮
  5. 注册快捷键

钩子 (Hook)

在特定时机触发的回调函数,用于:

  1. 监听编辑器事件
  2. 修改编辑器行为
  3. 执行自定义逻辑
  4. 与外部系统交互

组件概念

工具栏 (Toolbar)

提供常用操作的按钮组,包括:

  • 内置按钮: 格式化、压缩、验证等
  • 自定义按钮: 用户定义的操作按钮
  • 按钮组: 相关按钮的分组
  • 分隔符: 按钮组之间的分隔线

状态栏 (Status Bar)

显示编辑器状态信息,包括:

  • 错误信息: 验证错误的提示
  • 光标位置: 当前光标所在行列
  • 文档大小: 行数和字节数
  • 验证状态: JSON 是否有效

Schema 面板 (Schema Panel)

显示当前字段的 Schema 信息,包括:

  • 字段路径: 当前字段的 JSON 路径
  • 字段类型: 数据类型和格式
  • 字段描述: Schema 中的描述信息
  • 必填标记: 是否为必填字段
  • 输入控件: 特殊类型的输入界面

技术概念

JSON Path

用于定位 JSON 中的字段,支持:

  • 点号表示法: $.user.name
  • 方括号表示法: $['user']['name']
  • 数组索引: $.users[0]
  • 通配符: $.users[*].name

Schema 验证

基于 JSON Schema 的数据验证,包括:

  • 类型验证: 确保字段类型正确
  • 格式验证: 验证特定格式(如日期、颜色)
  • 范围验证: 检查数值范围
  • 模式匹配: 验证字符串模式
  • 必填检查: 检查必填字段

主题系统

定义编辑器的整体外观,支持:

  • 明暗主题: 切换明暗风格
  • 自定义主题: 定制主题样式
  • 主题扩展: 添加新的主题
  • 动态切换: 运行时切换主题