使用 PowerShell Test-Json 在修改前检查 JSON 配置

关于本文
本文是通过利用生成式 AI 的自动化工作流创建的。我们查阅了 PowerShell 中 Test-Json 的官方规范，并将其整理成一个极简示例，用于在将配置文件投入使用前对其语法进行只读检查。

验证状态：📘 已确认 Microsoft 官方规范・PowerShell 实机未验证

JSON 配置在加载到应用程序中导致失败之前，可以通过 Test-Json 进行检查。首先不要动生产环境文件，仅通过字符串来观察其行为。

首先尝试

$good = '{"name":"papanda","enabled":true}'
$bad  = '{"name":"papanda","enabled":true'

$good | Test-Json
$bad  | Test-Json

我们需要观察的是 True/False 以及错误信息。确认正确的 JSON 与删除了一个右花括号的 JSON 之间会产生什么差异。

尝试修改一处

true 请将字符串的 "true" 改为。由于两者作为 JSON 都是成立的，因此可以发现，单纯的语法检查并不能保证“类型是否符合预期”。

语法检查与规范检查是两码事

Test-Json 可用于确认是否能作为 JSON 读取，如果提供 Schema 还可以验证其结构。在部署配置前的检查中，如果按照首先检查语法、其次检查必填键与类型、最后检查应用程序特定含义的顺序进行分类，将更容易排查原因。

检查文件

Get-Content -LiteralPath .settings.json -Raw | Test-Json

此操作是只读的。在检查脚本阶段，最好不要自动修复并覆盖失败的 JSON，这样更安全。

如果在工作中应用

您可以在分发前检查 API 配置、VS Code 配置、内部工具的 JSON、传递给 AI 的结构化数据等。如果将其加入 CI，应避免将 False 或异常视为成功，而应设计为终止后续的分发处理。

官方信息与一手资料

• Microsoft Learn — Test-Json