# 编译数据库

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

如果您正在处理的项目不是基于 [CMake](quick-cmake-tutorial.html)、 [Gradle](gradle-support.html)或 [Makefiles](makefiles-support.html)，您仍然可以利用 CLion 提供的高级 IDE 功能。 一种方法是 [导入](creating-new-project-from-scratch.html#import-prj)非 CMake 项目，并让 CLion 将其转换为简单的 CMake 结构。 另一种选择是通过加载其   编译数据库  来打开项目。

编译数据库使 CLion 能够检测项目文件并提取所有必要的编译器信息，例如包含路径和编译标志。 这种方法使您能够在 IDE 中操作并充分体验其功能，同时保持项目  独立 于 CMake、Makefile 或 Gradle。

一个 [编译数据库](https://clang.llvm.org/docs/JSONCompilationDatabase.html)是一个 [JSON](https://www.json.org/) 格式的文件，名为  `compile_commands.json` ，包含有关项目中每个编译单元的结构化数据。

以下代码片段显示了一个 JSON 编译数据库的示例：

```JSON
{
"directory": "/Users/me/prj/Calendar/",
"command": "/usr/local/bin/g++-7 -I/Users/me/prj/Calendar/calendars -g -std=c++11 -o calendar_run.dir/main.cpp.o -c /Users/me/prj/Calendar/main.cpp",
"file": "/Users/me/prj/Calendar/main.cpp"
},
{
"directory": "/Users/me/prj/Calendar/calendars",
"command": "/usr/local/bin/g++-7 -I/Users/me/prj/Calendar/calendars -g -std=c++11 -o calendars.dir/calendar_defs.cpp.o -c /Users/me/prj/Calendar/calendars/calendar_defs.cpp",
"file": "/Users/me/prj/Calendar/calendars/calendar_defs.cpp"
}

```

您可以看到一个名为  命令对象 的条目数组。 每个  命令对象 表示翻译单元的主要   文件  、工作   目录  、实际编译   命令  （或   实参  的列表），以及可选的由编译步骤创建的   输出  的名称。 有关格式的更多信息，请参阅 [官方文档](http://clang.llvm.org/docs/JSONCompilationDatabase.html#format)。

## 生成编译数据库

要为您的项目获取编译数据库，您有多种选择：它可以由编译器、构建系统和专用工具生成（请参阅 [扩展的变体列表](https://sarcasm.github.io/notes/dev/compilation-database.html)）。 以下是一些示例：

Procedure: CMake：

* 使用 [CMAKE_EXPORT_COMPILE_COMMANDS](https://cmake.org/cmake/help/v3.11/variable/CMAKE_EXPORT_COMPILE_COMMANDS.html)标志。 您可以运行

```CONSOLE
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .
```

或将以下行添加到您的 [CMakeLists.txt](cmakelists-txt-file.html)脚本中：

```CONSOLE
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
```

`compile_commands.json` 文件将被放入构建目录中。

> **Note:**
> `CMAKE_EXPORT_COMPILE_COMMANDS` 仅由 Makefile 和 Ninja [生成器](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#makefile-generators)实现。 对于其他生成器，此选项将被忽略。

Procedure: Clang（版本 5.0 及更高版本）：

* [-Mj](http://bcain-llvm.readthedocs.io/projects/clang/en/latest/ClangCommandLineReference/#cmdoption-clang-mj-arg)选项为每个输入文件写入一个编译条目。 您可以对项目中的每个文件使用它，然后将输出合并为 JSON 格式的编译数据库（请参阅 [过程示例](https://github.com/Sarcasm/notes/blob/master/dev/compilation-database.rst#clang)）。

Procedure: Ninja（版本 1.2 及更高版本）：

* 要获取编译数据库，请使用 [-t compdb](https://ninja-build.org/manual.html#_extra_tools)选项。 请注意，它需要规则名称作为参数：  `-t compdb rule1 rule2...` 规则列表在 Ninja 构建文件（默认名称 [构建.ninja](https://ninja-build.org/manual.html)）中提供，例如：

```CONSOLE
rule cc
    command = gcc -c -o $out $in
    description = CC $out

rule link
    command = gcc -o $out $in
    description = LINK $out
                    
```

如果只有一个规则名为  `cc` 的情况下生成编译数据库，请指定：

```CONSOLE
-t compdb cc > compile_commands.json
```

但对于多个规则，您需要从构建文件中获取其确切名称并将其传递给  `compdb` （请参阅 [可能的解决方案之一](https://sarcasm.github.io/notes/dev/compilation-database.html#ninja)）。

Procedure: 基于 Make 的项目：

* [compiledb-generator](https://github.com/nickdiego/compiledb-generator) 工具为基于 make 的构建系统创建编译数据库。

Procedure: Bear 和 intercept-构建 工具：

* [Bear](https://github.com/rizsotto/Bear) 和   intercept-构建   来自 [scan-构建](https://github.com/rizsotto/scan-build) 的工具可通过拦截构建期间的编译器调用来帮助您获取编译数据库。

Procedure: SourceTrail Visual Studio 扩展：

* [SourceTrail 扩展](https://marketplace.visualstudio.com/items?itemName=vs-publisher-1208751.SourcetrailExtension) 为 [Visual Studio 解决方案](https://learn.microsoft.com/en-us/visualstudio/ide/solutions-and-projects-in-visual-studio) 生成编译数据库。

## 在 CLion 中使用编译数据库

一旦为您的项目创建了编译数据库，您就可以在 CLion 中开始使用它。

Procedure: 加载项目

1. 从主菜单中选择  `文件 | 打开` 。

2. 找到  `compile_commands.json`  文件或包含它的目录，然后点击   打开  。

3. 点击   作为项目打开  ：

![打开编译数据库项目](https://resources.jetbrains.com/help/img/idea/2026.3/cl_compdb_openasproject.png)

4. CLion 将检测项目文件并在   构建   工具窗口中显示  `compile_commands.json`  中所有命令的状态：

![编译数据库项目](https://resources.jetbrains.com/help/img/idea/2026.3/cl_compdb_overview.png)

此时，CLion 的代码洞察、重构、分析和导航功能已完全可用于您的项目。

> **Tip:**
> 您的项目文件可以位于包含  `compile_commands.json`  的目录之外。 CLion 从编译数据库中提取实际路径，并收集项目文件，无论它们位于何处。

> **Note:**
> 在 VCS 下处理编译数据库项目时，请考虑不要共享  `.iml`  文件，因为它将在导入时重新生成。 有关更多信息，请参阅 [此说明](https://intellij-support.jetbrains.com/hc/en-us/articles/206544839-How-to-manage-projects-under-Version-Control-Systems)。

Procedure: 检查工具链

1. 转到  `设置 | 构建、执行、部署 | 编译数据库`

2. 选择用于解析项目文件的工具链：

![编译数据库的工具链](https://resources.jetbrains.com/help/img/idea/2026.3/cl_compdb_wsl_toolchain.png)

CLion 会从  `设置 | 构建、执行、部署 | 工具链`  提供所有可用的工具链。 请注意，   远程主机   工具链目前不支持编译数据库项目。

> **Note:**
> 请记住，更改工具链需要使用新工具链重新生成  `compile_commands.json`  文件。

Procedure: 更改项目根目录

默认情况下，项目根目录设置为包含编译数据库文件的目录。 然而，这并不总是方便的：例如，如果某些项目文件位于包含  `compile_commands.json`  的目录之外（即项目根目录之外），这些文件将被列在树中，而不考虑实际的文件夹结构。 在这种情况下，您需要将项目根目录设置为包含  `compile_commands.json`  和项目文件的父目录。

1. 要更改项目根目录，请从主菜单中选择  `工具 | 编译数据库 | 更改项目根目录` ，并为项目根目录设置新位置。

Procedure: 配置自动重新加载

默认情况下，CLion 不会在  `compile_commands.json`  中发生更改时自动重新加载您的项目，除非是 VCS 更新等外部事件。 您可以在   构建工具   设置中更改此行为。

1. 转到  `设置 | 构建、执行、部署 | 构建工具` 。

2. 选择一个自动重新加载选项：

![自动重新加载设置](https://resources.jetbrains.com/help/img/idea/2026.3/cl_autoreload_settings.png)

* 任何更改 - 项目将在 `compile_commands.json` 中的任何更改时触发重新加载。

* 外部更改 （默认）- 您的项目仅在外部事件（如 VCS 更新）时重新加载。 如果 `compile_commands.json` 中发生其他更改，您需要手动重新加载项目。 使用以下选项之一： * 请按 `Ctrl+Shift+O` (Windows), `⌘ ⇧ I` (macOS), `⌘ ⇧ O` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ I` (macOS System Shortcuts), `Ctrl+Shift+O` (XWin), `Ctrl+Shift+O` (GNOME), `Ctrl+Shift+O` (KDE), `Ctrl+Shift+O` (Emacs), `Ctrl+Shift+O` (Sublime Text), `⌘ ⇧ I` (Sublime Text (macOS)), `⌘ ⇧ I` (Xcode), `Ctrl+Shift+O` (Visual Studio), `⌘ ⇧ I` (Visual Studio (macOS)), `Ctrl+Shift+O` (ReSharper), `⌘ ⇧ I` (ReSharper (macOS)), `Ctrl+Shift+O` (QtCreator), `Ctrl+Shift+O` (QtCreator (macOS)), `Ctrl+Shift+O` (NetBeans), `Ctrl+Shift+O` (Eclipse), `Ctrl+Shift+O` (Eclipse (macOS)) * 点击编辑器中出现的弹出窗口： ![用于重新加载项目的编辑器弹出窗口](https://resources.jetbrains.com/help/img/idea/2026.3/cl_compdb_reload_popup.png) * 点击 ![重新导入编译数据库项目](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.refresh.svg) 在 构建 工具窗口中： ![重新导入项目图标](https://resources.jetbrains.com/help/img/idea/2026.3/cl_compdb_reimport_syncwindow.png) * 从主菜单中选择 `工具 | 编译数据库 | 重新加载编译数据库项目` 。

> **Tip:**
> 此设置适用于每个项目。 自动重新加载选项应分别为您的每个编译数据库、 [Makefile](makefiles-support.html) 或 [Gradle](gradle-support.html) 项目配置。

### 在 compile_database.json 中的代码辅助功能

CLion 原生支持 [JSON](clion-features-in-different-languages.html) 文件格式，因此您可以直接在 IDE 中编辑  `compile_database.json`  文件，并提供高亮和代码补全帮助：

![在 compile_database.json 中的代码补全](https://resources.jetbrains.com/help/img/idea/2026.3/cl_compdb_jsoncompletion.png)

CLion 检查您的  `compile_database.json`  文件是否符合编译数据库 JSON 模式。 您可以在  `设置 | 编辑器 | 检查 | JSON 和 JSON5`  中调整相应的检查。

![针对 compile_database.json 的 JSON 检查](https://resources.jetbrains.com/help/img/idea/2026.3/调试配置](custom-build-targets.html#custom-rundebug)来设置工作流程。

## See also

### 外部链接

[Working with Makefiles in CLion using Compilation DB and File Watchers](https://blog.jetbrains.com/clion/2018/08/working-with-makefiles-in-clion-using-compilation-db/)

