JSON 文件里的 “$schema” 是干什么用的?

news2024/9/21 0:34:53

最近我在做一些前端项目,我发现有的配置文件,比如 .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 文件来提供此项功能。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1480467.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

电梯物联网之梯控相机方案-防止电瓶车进电梯

梯控现状 随着电梯产品在智能化建筑的日益普及,对于电梯的智能化管理 安全性需求 的要求越来越迫切。尤其今年来随着电瓶车的大量普及,发起多起楼道、轿厢电瓶车着火恶性事件, 造成了极大的社会 负面影响。控制电瓶车进入单元门,楼道以及电梯…

浅析智能照明控制系统在图书馆照明节能中的应用

彭姝麟 Acrelpsl 0 引 言 照明耗电在各国总发电量中都占有很大比例,根据2004年国家住房和城乡建设部的统计, 我国照明耗电约占全国发电总量的10%一12%。 对一些照明时间较长、照明场所较多的机构,如高等学校&#xf…

百度新版VMP

百度搞事情哇最近,新上验证类型,曲线匹配!!! 这年头儿,连百度都还是上vmp了兄弟们,越来越难咯。 个人感觉 想学好vm的话,首先得找个好位置插装,然后慢慢分析。 轨迹信息…

Spring注解之json 数据处理

目录 1. 过滤 json 数据 2. 格式化 json 数据 3. 扁平化对象 1. 过滤 json 数据 JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析。 //生成json时将userRoles属性过滤 JsonIgnoreProperties({"userRoles"}) public class User { ​private S…

C++的继承和多态

继承和多态 继承继承的权限继承的子父类访问派生类的默认成员函数菱形继承(C独有)【了解】虚拟继承什么是菱形继承?菱形继承的问题是什么?什么是菱形虚拟继承?如何解决数据冗余和二义性的继承和组合的区别?…

Redis冲冲冲——事务支持,AOF和RDB持久化

目录 引出Redis事务支持,AOF和RDB持久化1、Redis的事务支持2、Redis的持久化 Redis冲冲冲——缓存三兄弟:缓存击穿、穿透、雪崩缓存击穿缓存穿透缓存雪崩 总结 引出 Redis冲冲冲——事务支持,AOF和RDB持久化 Redis事务支持,AOF和…

Windows系统x86机器安装龙芯(loongarch64)3A5000虚拟机系统详细教程

本次介绍在window系统x86机器上安装loongarch64系统的详细教程。 1.安装环境准备。 首先,你得有台电脑。 配置别太差,至少4核8G内存,安装window10或者11都行(为啥不能是Window7,你要用也不是不行,你先解决…

模拟算法题练习(二)(DNA序列修正、无尽的石头)

(一、DNA序列修正) 问题描述 在生物学中,DNA序列的相似性常被用来研究物种间的亲缘关系。现在我们有两条 DNA序列,每条序列由 A、C、G、T 四种字符组成,长度相同。但是现在我们记录的 DNA序列存在错误,为了…

解析电源模块测试条件与测试步骤 快速完成测试

高温高湿储存测试是电源模块环境适应性测试内容之一,在实际使用过程中由于应用场景不同电源所处的环境也是多样的,因此需要测试电源对各种环境的适应能力,提高电源的性能和可靠性。 电源高温高湿存储测试的目的是为了测量环境对电源结构、元件…

Spring - InitializingBean、@PostConstruct、@Bean(initMethod = “init“)和构造方法执行优先级比较

执行顺序优先级 构造方法 > postConstruct > afterPropertiesSet > init方法 代码案例 Component public class InitializingBeanTest implements InitializingBean {public InitializingBeanTest(){System.out.println("构造方法");}Overridepublic void…

现代企业架构框架——技术架构

现代企业架构框架——技术架构。 技术架构是对某一技术问题(需求)解决方案的结构化描述,由构成解决方案的组件结构及之间的交互关系构成。广义上的技术架构是一系列涵盖多类技术问题设计方案的统称,例如部署方案、存储方案、缓存方案、日志方案等等。 现代企业架构框架(M…

直观理解卷积

卷积直观理解 原文来自最容易理解的对卷积(convolution)的解释 🎬个人简介:一个全栈工程师的升级之路! 📋个人专栏:计算机杂记 🎀CSDN主页 发狂的小花 🌄人生秘诀:学习的本质就是极致…

linux操作docker

docker地址 官方地址 centos7安装docker 卸载旧版本docker sudo //在前面表示以管理员权限操作yum remove docker \docker-client \docker-client-latest \docker-common \docker-latest \docker-latest-logrotate \docker-logrotate \docker-engine安装docker //安装所需资…

Perforce Helix Core:摄像机内视觉特效(ICVFX)行业首选的版本控制工具

在当今数字娱乐时代,摄像机内视觉特效(ICVFX)和LED墙虚拟制片方法(有时也称为现场虚拟制片),正在被用于创造一些最前沿的媒体作品。然而,实现令人惊叹的虚拟画面不仅需要先进的技术,…

QT TCP传输文件+ui

TCPFile tcp协议传输文件 TCPFile.pro QT core gui networkclientwidget.h #include <QWidget> #include <QTcpSocket> // 通信套接字 #include <QFile>private slots:void on_pushButton_clicked();private:QTcpSocket *tcpSocket;QFile file; /…

九州金榜|导致孩子厌学因素有哪些?家庭教育中要怎样解决?

现在如今孩子出现厌学的情况越来越严重&#xff0c;这也难坏了很多家长&#xff0c;众所周知&#xff0c;当下社会竞争越来越激烈&#xff0c;孩子的压力也越来越大&#xff0c;这也是导致孩子厌学的主要因素。其实家庭因素也是引起孩子厌学情绪产生的重要原因&#xff0c;在家…

通过一篇文章让你了解数据结构和算法的重要性

通过一篇文章让你了解数据结构和算法的重要性 前言一、 什么是数据结构&#xff1f;二、什么是算法&#xff1f;三、数据结构和算法的重要性在校园招聘的笔试中&#xff1a;在校园招聘的面试中&#xff1a;在未来的工作中&#xff1a; 四、如何学好数据结构和算法4.1 死磕代码&…

pom文件写入依赖爆红

pom.xml文件中每次写入依赖后都会爆红&#xff0c;因为单纯引入依赖并没有真正下载依赖包到本地仓库 重载maven项目&#xff0c;检测到没有的依赖后会自动下载依赖包&#xff0c;这时候等待右下角的下载进度条下载完毕即可

swift 长按桌面图标弹出快捷选项

文章目录 一、3D Touch二、主屏交互1. 静态添加2. 动态添加三、监听主屏交互按钮的点击事件四、预览和跳转1. 注册3D touch2. 实现协议3. 在目标控制器复写previewActionItems4. 使用UIContextMenuConfiguration一、3D Touch 3D Touch通过屏幕下方的压力感应器来感知不同的压力…

【InternLM 实战营笔记】基于 InternLM 和 LangChain 搭建MindSpore知识库

InternLM 模型部署 准备环境 拷贝环境 /root/share/install_conda_env_internlm_base.sh InternLM激活环境 conda activate InternLM安装依赖 # 升级pip python -m pip install --upgrade pippip install modelscope1.9.5 pip install transformers4.35.2 pip install str…