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 最省事,大項目還是推薦用獨立文件加版本控制,方便維護也利于多人協作。