vscode支持通过自定义json schema对json文件进行规则校验。1. 使用json.schemas设置自定义规则,通过settings.json绑定特定路径文件与schema地址(本地或远程),实现自动校验;2. 创建.vscode/settings.json统一管理配置,适用于团队协作,内联schema适合小型项目;3. 借助扩展如json schema validator和better json schema intellisense可实现更复杂的校验、自动补全和保存格式化等功能,提升开发效率。
VSCode 默认就支持对 JSON 文件进行基本的语法检查和格式校验,但如果你希望它能根据特定规则(比如字段类型、必填项等)来验证 JSON 内容,就需要配置自定义的 JSON Schema。下面是一些实用技巧,帮助你更高效地设置 VSCode 的 JSON 验证规则。
1. 使用 json.schemas 设置自定义校验规则
VSCode 允许通过工作区或用户设置文件(settings.json)绑定某个 JSON Schema 到特定路径下的 JSON 文件。这样,当你编辑这些文件时,VSCode 就会自动使用指定的 schema 进行校验。
操作步骤:
- 打开 VSCode 设置(可以通过菜单 文件 > 首选项 > 设置 或快捷键 Ctrl + ,)
- 切换到“JSON”视图(右上角有 {} 图标)
- 添加如下格式的配置:
{ "json.schemas": [ { "fileMatch": ["your-config.json"], "url": "https://example.com/schema.json" } ] }
- fileMatch 指定要匹配哪些文件(支持通配符)
- url 可以是本地路径(如 ./schema.json)或远程地址
注意点:
- 如果你的 schema 是本地文件,确保路径正确,最好用相对路径
- VSCode 不会自动下载远程 schema,需要保证网络可达性
2. 创建 .vscode/settings.json 文件统一管理配置
如果你在团队中协作开发,建议把 JSON 校验规则放在项目根目录下的 .vscode/settings.json 中,这样所有开发者打开项目时都会应用相同的校验逻辑。
示例结构:
{ "json.schemas": [ { "fileMatch": ["/config/*.json"], "schema": { "type": "object", "required": ["name", "version"], "properties": { "name": { "type": "string" }, "version": { "type": "number" } } } } ] }
这种方式适合小型项目或简单规则,无需额外依赖外部 schema 文件。
3. 借助扩展增强 JSON 校验能力
虽然 VSCode 自带的 JSON 校验功能已经很强大,但有些高级需求(比如嵌套校验、动态引用、自定义错误提示等)可能需要借助插件来实现。
推荐扩展:
- JSON Schema Validator (by Peter Jausovec)
支持从 URL 或本地加载 schema,并提供详细的错误信息提示。 - Better JSON Schema IntelliSense
提供更好的自动补全和字段描述支持,尤其适合复杂结构的 JSON 编辑。
安装后通常只需按照插件说明调整配置即可,部分插件还支持保存时自动格式化等功能。
基本上就这些了。配置 JSON 校验其实不难,关键是根据项目规模选择合适的方式。小项目直接写内联 schema 最省事,大项目还是推荐用独立文件加版本控制,方便维护也利于多人协作。