C / C++ / 系统课时

用 clang-tidy 检查常见问题

用 clang-tidy 检查常见问题

clang-tidy 能在编译之外发现空指针、可疑控制流和代码质量问题,但它只有在知道真实编译参数时才能正确理解源码。本节通过一个可运行的 CMake 工程,重点掌握如何生成并使用编译数据库。

学习目标

  • 使用 CMake 生成 compile_commands.json 并运行 clang-tidy
  • 理解头文件路径、宏定义和编译选项为什么会影响静态分析结果
  • 根据诊断位置和检查项名称确认问题,而不是机械接受所有提示

clang-tidy 为什么需要编译上下文

clang-tidy 并不是只读取一个 .c 文件做文本扫描。它会像编译器一样解析源码,因此必须知道头文件搜索路径、宏定义、语言标准和其他编译选项。同一份源码在不同参数下甚至可能进入不同的条件编译分支。

CMake 可以把每个源文件实际使用的编译命令写入 compile_commands.json。运行 clang-tidy -p <PATH> 时,工具会从该数据库取得对应文件的参数,而不是依靠一套猜测出来的默认配置。

CMake 编译数据库与 clang-tidy 的关系

生成编译数据库并执行检查

下面的最小工程故意使用 FEATURE_LEVEL 控制一个存在空指针解引用的分支。该宏只由 CMake 编译配置提供,因此正好可以验证编译数据库是否被 clang-tidy 正确使用。

bash
mkdir -p tidy-demo/src
cd tidy-demo
cat > CMakeLists.txt <<'EOF'
cmake_minimum_required(VERSION 3.20)
project(tidy_demo C)

add_executable(app src/main.c)
target_compile_definitions(app PRIVATE FEATURE_LEVEL=2)
EOF

cat > src/main.c <<'EOF'
#ifndef FEATURE_LEVEL
#define FEATURE_LEVEL 0
#endif

int main(void) {
#if FEATURE_LEVEL >= 2
    int *p = 0;  /* 条件编译打开后,这里会形成确定的空指针。 */
    return *p;
#else
    return 0;
#endif
}
EOF

cmake -S . -B build -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
clang-tidy -p build -checks='-*,clang-analyzer-core.NullDereference' src/main.c

预期输出

text
<PATH>/src/main.c:<LINE>:<COL>: warning: Dereference of null pointer [clang-analyzer-core.NullDereference]

诊断的路径、行号、列号和附加说明可能随 clang-tidy 版本不同而变化,但应能看到 clang-analyzer-core.NullDereference。这里的 <PATH>、<LINE> 和 <COL> 表示实际环境中的动态值。

编译数据库解决了什么

打开 build/compile_commands.json 可以看到 CMake 为 src/main.c 记录的真实编译命令,其中包含类似 FEATURE_LEVEL=2 的定义。clang-tidy 因而能够进入实际构建时会启用的代码分支。

如果直接对文件运行检查却不提供正确的编译上下文,工具可能使用默认宏值、找不到项目头文件,或者按照错误的语言标准解析代码。结果既可能产生误报,也可能像本例一样漏掉真正会进入构建产物的代码路径。

处理诊断时先看检查项

一条 clang-tidy 诊断通常同时给出位置、文字说明和方括号中的检查项名称。定位问题时,先确认源码是否确实按项目配置被解析,再判断该检查是否适合当前代码库。

对于确定的空指针解引用、越界访问等高风险问题,应优先修正根因;对于风格或现代化建议,则需要结合项目语言版本、兼容性和团队规范决定是否启用。真正稳定的工程实践不是把检查项全部打开,而是让选定规则在本地和 CI 中使用同一份编译上下文持续执行。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 clang-tidy 检查常见问题

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通