最近我在做一些前端项目,我发现有的配置文件,比如 .prettierrc.json
或者 tsconfig.json
里面都会看到一个 $schema
字段,有点好奇,就查了一下。
什么是 JSON Schema
JSON Schema是一种基于JSON (JavaScript Object Notation) 的格式,用于描述JSON数据的结构和验证 JSON 数据。它提供了一套定义性语言来指定 JSON 格式的规则,包括对象的属性、数据类型、数据间的关系、条件约束等,从而使得可以自动化地对 JSON 数据进行校验、注解和操作。通过使用JSON Schema,开发者可以确保他们的数据遵循特定的结构和约束,这对于数据交换和 API 的使用尤为重要。
{"productId": 1,"productName": "A green door","price": 12.50,"tags": [ "home", "green" ]
}
这是一个产品目录的 JSON,JSON 对象是人类可读的,但它不包含任何上下文或元数据。仅从对象本身无法判断键的含义或可能的输入是什么。JSON Schema是一个提供这些问题答案的标准。
为什么使用 JSON Schema
JSON Schema是一套词汇表,它使得JSON数据在大规模应用中保持一致性、有效性和互操作性。
简单来说,就是写一个描述文件,描述一个标准的 JSON 文件,应该包含哪些字段,各个层级的 key 的结构如何,分别是什么数据类型,每个键的作用等等。
可以认为是一个 JSON 文件遵循的标准,比如开头提到的, .prettierrc.json
文件,里面有一个 schema
:
{"$schema": "https://json.schemastore.org/prettierrc","printWidth": 100,"tabWidth": 2,"useTabs": false,"semi": false,"singleQuote": true,"trailingComma": "all","bracketSameLine": true,"arrowParens": "always","bracketSpacing": true,"endOfLine": "auto"
}
有了这个 schema
你就可以使用工具来验证,每个字段有没有拼错,有什么作用等等。
怎么验证一个 JSON 的格式?
首先,你编写一个 JSON 文件的时候,应该附上对应的 schema
,比如上面的例子,就是有一个预定义的 schema
,如果是你自己的项目,你需要遵循 JSON Schema 的规范,来编写对应的 Schema 文件。
如果你像我一样使用 VS Code,默认就是有 JSON Schema 校验的:
除了在 json 文件中,注入 schema 字段来指定,也可以通过 VS Code 的 settings.json 来配置,如上图的样子。
如果是别的 IDE,应该也有很多实现的插件和工具来进行此项校验。这样就不担心配置文件写错了。
总结
JSON Schema 是一种编码规范,帮助检查 JSON 文件的格式,有效约束 JSON 文件的标准化,各种 IDE 都有 Schema 验证的插件和工具,合理使用可以减少配置文件编写带来的错误。如果自己项目里使用的 JSON,也可以自己创建对应的 Schema 文件来提供此项功能。