# JSON

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/zh-cn/help/clion/llms.txt).

> **TL;DR**
> 必需插件  :
>
>
>
> `JavaScript 和 TypeScript`  -  插件与 CLion 捆绑在一起，并默认启用。

[JSON](https://www.json.org/) 格式通常用于存储数据和配置文件。 CLion 帮助您处理 JSON 文件 — 它检查其语法和格式。 在流行的配置文件类型中，CLion 基于 [JSON Schema](http://json-schema.org/) 验证代码并提供代码补全，JSON Schema 是一种描述此类文件结构和内容的特殊格式。

CLion 附带了一组  已注册  的模式，适用于大多数流行的格式。 您还可以 [使用来自 JSON Schema Store 的模式](#ws_json_using_schemas) 或 [自定义 JSON 模式](#ws_json_schema_add_custom)。

![捆绑的模式和来自 Schema Store 的模式](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_schema_types.png)

## 启用 JSON5

CLion 识别许多流行的 JSON 标准，包括 [JSON5](https://json5.org/)。 CLion 默认会将具有  `json5`  扩展名的文件视为 JSON5 文件，并在其中支持这种新语法。

![使用默认扩展名 .json5 的 JSON5 配置文件](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_five.png)

Procedure: 将 JSON5 语法扩展到所有 JSON 文件

1. 在   设置  对话框 ( `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))) 中，前往  `编辑器｜文件类型` 。

2. 在   识别的文件类型   列表中，选择   JSON5  。

3. 在   文件名模式  区域，点击 ![Add](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg)并在打开的   添加通配符  对话框中键入  `*.json` 。

![将 JSON5 语法扩展到所有 JSON 文件](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_extend_json5_to_all_json_files.png)

## 使用来自 JSON Schema Store 的模式

CLion 可以自动下载并使用 [JSON Schema Store](http://schemastore.org/) 中的架构，该平台托管许多最受欢迎的配置文件的架构文件。 当您打开一个与可用架构之一关联的文件（例如，  `tsconfig.json` ）时，CLion 将下载并使用此架构。 应用架构的名称显示在状态栏上。

![从 JSON Schema Store 下载的 JSON 模式，应用的模式名称显示在状态栏](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_schema_from_store_status_bar.png)

如果您的配置文件有一个自定义名称，或者您正在处理一个 [临时文件](scratches.html)，请点击状态栏上的   无 JSON schema   并从列表中选择所需的模式。 CLion 将当前文件与所选模式关联，并将此模式映射添加到   JSON Schema 映射   页面上的列表中。

或者，点击   新的 Schema Mapping   打开   JSON Schema 映射   页面并 [配置一个新的模式关联](#ws_json_schema_add_custom)。

![当前文件没有 JSON 模式](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_schema_no_schema_status_bar.png)

> **Tip:**
> JSON Schema Store 中的模式也可以应用于 [YAML](yaml.html) 文件。

默认情况下，JSON Schema Store 的模式自动下载功能处于启用状态。 如果它被关闭，您可以随时重新启用。

Procedure: 自动从 JSON Schema Store 下载模式

1. 在   设置  对话框 ( `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))) 中，前往  `语言与框架 | 架构和 DTD | 远程 JSON 架构` 。

2. 请选中   允许从远程来源下载 JSON 模式  和   使用 schemastore.org JSON Schema 目录  复选框。

CLion 捆绑了许多最受欢迎的的模式。 虽然这些模式会定期自动更新，但它们仍可能过时。

Procedure: 使用最新版本的内置模式

1. 在   设置  对话框 ( `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))) 中，前往  `语言与框架 | 架构和 DTD | 远程 JSON 架构` 。

2. 请选择   始终下载最新版本的模式   复选框。

## 使用自定义 JSON 模式

除了捆绑的已注册模式和 [来自 JSON Schema Store 的模式](#ws_json_using_schemas)，CLion 还允许您创建自己的模式或使用来自其他存储的自定义模式。 您可以创建或下载所需的模式，并将其存储在项目根目录下，或者指定资源的 URL，以便 CLion 可以自动下载该模式。

自定义架构必须符合 JSON 架构标准。 目前，CLion 支持 [2020-12](https://json-schema.org/draft/2020-12) 及更早版本的模式。

![自定义模式符合 2020-12 标准](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_custom_schema_meets_standard.png)

> **Note:**
> 您可以通过以下两种方式添加自定义JSON架构：
>
>
>
> * 在 设置 对话框中，将自定义JSON架构与文件模式关联 [，如下所述](#ws_json_schema_add_custom_procedure)。
>
> * [创建一个插件](https://plugins.jetbrains.com/docs/intellij/developing-plugins.html)，实现 `com.jetbrains.jsonSchema.extension.JsonSchemaFileProvider` 扩展点，然后按照 [插件管理](managing-plugins.html#install_plugin_from_disk)中的说明安装该插件。

Procedure: 创建自定义 JSON 模式关联

1. 在   设置  对话框 ( `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))) 中，前往  `语言与框架 | 架构和 DTD | JSON 架构映射` 。

或者，点击状态栏上的   无 JSON 架构  ，然后选择   新的 Schema Mapping  。 在这种情况下，CLion 会自动将文件包含在 [关联的文件、文件夹和模式列表](#ws_json_scope) 中。

2. 在显示所有先前配置的模式的中央窗格中，点击工具栏上的 ![Add](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg)，并指定映射的名称。

3. 在   架构文件或 URL   字段中，指定先前创建或下载的模式文件的位置，或所需模式可用的 URL。 Schema 文件的名称或相应的 URL 地址显示在   架构文件或 URL  字段中。

![指定一个模式文件](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_schema_add_custom_select_schema_file.png)

> **Tip:**
> 如果您指定了 URL，请确保选中   允许从远程来源下载 JSON 模式   页面上的   远程 JSON 架构   复选框。

4. 指定您的模式符合的 [模式规范版本](http://json-schema.org/specification-links.html)。

![选择模式版本](https://resources.jetbrains.com/help/img/idea/2026.3/*.yaml` 匹配所有名称包含 `.yaml` 、 `role` 和 `/` 的 `/` 文件。

* `role-**.yaml` 匹配所有名称以 `role-` 开头的 `.yaml` 文件。

要将项目添加到列表，请点击 ![添加映射](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg)。

![向作用域中添加一个项目](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_scope_add.png)

指定文件或文件夹的路径，或键入文件模式。 指定相对于项目根目录的路径。

![指定文件模式](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_scope_add_pattern.png)

> **Tip:**
> 如果您通过为文件选择   新的 Schema Mapping   打开了   JSON Schema 映射   页面，则该文件已添加到列表中。

Procedure: 启用从远程来源自动下载 JSON 架构

1. 在   设置  对话框 ( `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))) 中，前往  `语言与框架 | 架构和 DTD | 远程 JSON 架构` 。

2. 请选择   允许从远程来源下载 JSON 模式  。

当该复选框被清除时，关于 JSON Schemas 的任何网络活动，包括来自 JSON Schema Store 的架构，将被禁用。

## 禁用 JSON 模式

Procedure:

* 要为文件禁用模式，请点击状态栏上的   JSON 架构   小部件，然后从弹出列表中选择   忽略文件的 JSON 架构  。

![忽略当前文件的模式](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_ignore_schema.png)

或者，选择   编辑架构映射   并 [编辑模式的作用域](#ws_json_scope)。 例如，您可以编辑适当的模式或从列表中删除文件（如果文件名已明确指定）。

最后，您可以选择   新的 Schema Mapping   并配置模式关联， [如上所述](#ws_json_schema_add_custom_procedure)。

![忽略模式并创建新映射](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_ignore_schema_new_schema_mapping.png)

* 要恢复当前文件的模式关联，请点击状态栏上的   无 JSON 架构  ，并从弹出列表中选择   停止忽略文件的 JSON 架构  。

![恢复文件的模式关联](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_restore_schema_for_file.png)

* 要为整个当前项目禁用自定义模式，请打开   设置   对话框（ `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))），转到  `语言与框架 | 架构和 DTD | JSON 架构映射` ，在中央窗格中选择模式关联，然后点击工具栏上的 ![删除按钮](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.remove.svg)。

## 处理模式作用域之间的冲突

如果文件、文件夹或模式属于两个或多个模式的作用域，CLion 会检测到此冲突，并在编辑器和   JSON Schema 映射   页面上的   设置   对话框中显示警告。

在编辑器中，当您打开属于多个作用域的文件时，会显示警告。

![编辑器中关于模式作用域冲突的通知](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_schemas_conflict_of_scopes_dynamic.png)

在   JSON Schema 映射   页面上的   设置   对话框中，当多个映射的作用域重叠时，会显示警告。

![设置对话框中关于模式作用域冲突的通知](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_schemas_conflict_of_scopes.png)

## 在 JSON 模式中使用 HTML 描述

默认情况下，CLion 会在文档弹出窗口中显示 JSON schema 定义的文档时转义 HTML 字符。

假设您的模式使用了  `description`  属性：

```JSON
{
    "id":  "http://some.site.somewhere/entry-schema#",
    "$schema":  "https://json-schema.org/draft/2020-12/json-schema-core",
    "type":  "object",
    "required":  [ "options" ],
    "properties":  {
        "options":  {
            "type":  "array",
            "description": "Interesting details: Fresh New Awesome",
            "minItems":  1,
            "items":  { "type":  "string" },
            "uniqueItems":  true
        },
        "readonly":  { "type":  "boolean" }
    }
}

```

然后   快速文档   弹出窗口将如下所示：

![文档中没有带有 description 属性的 JSON schema 定义的格式化](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_quick_doc_description_property.png)

要获得带有丰富 HTML 标记的美观文档，请将 HTML 描述存储在  `x-intellij-html-description`  扩展属性中，而不是  `description` ：

```JSON
{
  "id":  "http://some.site.somewhere/entry-schema#",
  "$schema":  "https://json-schema.org/draft/2020-12/json-schema-core",
  "type":  "object",
  "required":  [ "options" ],
  "properties":  {
    "options":  {
      "type":  "array",
      "x-intellij-html-description": "<p><b>Interesting</b> <i>details:</i></p>\n
                    <ul><li>Fresh</li><li>New</li><li>Awesome</li></ul>\n
                    <div style='background-color: #fff77c'>Choose schema with HTML description =)</div>",
      "minItems":  1,
      "items":  { "type":  "string" },
      "uniqueItems":  true
    },
    "readonly":  { "type":  "boolean" }
  }
}
                
```

现在   快速文档   弹出窗口如下所示：

![在文档中使用 x-intellij-html-description 属性进行 JSON schema 定义时的 HTML 描述](https://resources.jetbrains.com/help/img/idea/2026.3/ws_json_quick_doc_pure_html.png)

## 配置语法高亮

您可以根据自己的偏好和习惯配置 JSON 感知语法高亮。

Procedure:

1. 在   设置  对话框 ( `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))) 中，前往  `编辑器 | 颜色方案 | JSON` 。

2. 选择颜色方案，接受从默认设置继承的高亮设置，或按照 [颜色和字体](configuring-colors-and-fonts.html) 中的描述自定义它们。

