静态分析 on Dorkytiger 的小屋

Clang-Tidy

Mon, 01 Jan 0001 00:00:00 +0000

一、Clang-Tidy 能做什么

Clang-Tidy 是 LLVM 的静态分析工具，在编译时分析代码中潜在的 Bug 和代码异味。和 GDB/Run-time sanitizer 不同，它不需要运行程序就能检测问题。

# 基本用法
clang-tidy --checks=* source.cpp -- -std=c++17

# 常用 check 组合
clang-tidy --checks=modernize-*,performance-*,bugprone-* source.cpp

二、它能抓到的问题

// 1. modernize —— 用现代 C++ 写法替代旧写法
int* ptr = new int(42);    // warning: use auto rather than explicit type
auto* ptr = new int(42);   // ✅ 推荐写法

// 2. performance —— 性能问题
std::vector<int> v;
for (int i = 0; i < v.size(); i++) {  // warning: range-for loop is faster
    foo(v[i]);
}
for (auto x : v) {                     // ✅ 推荐
    foo(x);
}

// 3. bugprone —— 潜在的 Bug
int x = 1;
if (x = 42) {   // warning: assignment in if condition, did you mean == ?
    // ...
}

void foo(const std::string& s) {
    std::cout << s.c_str() << std::endl;  // warning: unnecessary .c_str() call
    std::cout << s << std::endl;           // ✅ 推荐
}

// 4. clang-analyzer —— 深层逻辑错误
int* get_ptr() {
    int x = 42;
    return &x;  // warning: returning reference to local temporary
}

void test() {
    int* p = get_ptr();
    *p = 0;     // Use-After-Free（栈变量已失效）
}

三、在 CMake 中集成

# CMakeLists.txt 中添加 clang-tidy 支持
# ccmake 时设置 -DCMAKE_CXX_CLANG_TIDY=clang-tidy

# 或者编辑 CMakeCache.txt：
# CMAKE_CXX_CLANG_TIDY:STRING=clang-tidy;-checks=modernize-*,performance-*,bugprone-*

# 效果：每次编译时自动运行 clang-tidy，警告出现在编译输出中

四、用 `.clang-tidy` 配置项目规则

# .clang-tidy
Checks: >
    modernize-*,
    performance-*,
    bugprone-*,
    readability-*,
    -modernize-use-trailing-return-type,  # 排除某个不想要的检查

WarningsAsErrors: >
    bugprone-*     # 把 Bug 相关的警告视为错误

CheckOptions:
    { key: readability-identifier-naming.ClassCase, value: CamelCase }
    { key: readability-identifier-naming.FunctionCase, value: camelBack }

Clang Static Analyzer

Mon, 01 Jan 0001 00:00:00 +0000

一、比 Clang-Tidy 更深层的分析

Clang-Tidy 是"模式匹配"（找常见的代码模式问题），Clang Static Analyzer 是符号执行（模拟代码的执行路径）。

# 方法 1：用 scan-build 替代编译命令
scan-build make -j4

# 方法 2：直接分析单个文件
clang --analyze source.cpp -std=c++17

二、它能找到 Clang-Tidy 找不到的问题

// 1. 资源泄漏
void leak_example() {
    FILE* f = fopen("data.txt", "r");
    // 忘了 fclose(f)
    // clang-tidy 不会报告，但 scan-build 会标记"资源泄漏"
}

// 2. 野指针路径
void branch_bug(bool condition) {
    int* p = nullptr;
    if (condition) {
        p = new int(42);
    }
    // 如果 condition = false，p 还是 nullptr
    *p = 0;  // scan-build 警告：possible null pointer dereference
}

// 3. 死代码（Dead code）
bool always_true(int x) {
    if (x > 0) {
        return true;
    }
    return true;  // 永远不会执行的代码
}

clangd —— IDE 集成的实时分析

Mon, 01 Jan 0001 00:00:00 +0000

一、clangd 是什么

clangd 是 LLVM 的 LSP（Language Server Protocol） 实现，为编辑器提供代码补全、跳转定义、实时错误提示、重构建议。

# 安装
brew install llvm  # macOS，包含 clangd
apt install clangd  # Linux

# 生成编译数据库（clangd 需要知道编译选项）
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .
# 生成 compile_commands.json 文件

二、和 CLion 的配合

CLion 默认自带 clangd 支持。
VSCode 需要安装 clangd 插件（禁用默认的 C++ IntelliSense）。

配置后得到的实时提示：
  - 输入时显示类型不匹配
  - 悬停查看函数签名
  - 自动显示 clang-tidy 警告（红线）
  - 代码补全（包含 STL 模板的展开结果）
  - 重构（重命名变量/函数、提取函数）

第六阶段总结

Mon, 01 Jan 0001 00:00:00 +0000

Clang-Tidy：
    编译时的代码检查（模式匹配）
    bugprone-* / performance-* / modernize-*
    在 CMake 中用 CMAKE_CXX_CLANG_TIDY 集成

Clang Static Analyzer：
    符号执行（模拟代码路径）
    能发现资源泄漏、死代码、部分空指针

clangd：
    IDE 实时分析
    基于 compile_commands.json 提供语义支持

静态分析 on Dorkytiger 的小屋

Clang-Tidy

一、Clang-Tidy 能做什么

二、它能抓到的问题

三、在 CMake 中集成

四、用 .clang-tidy 配置项目规则

Clang Static Analyzer

一、比 Clang-Tidy 更深层的分析

二、它能找到 Clang-Tidy 找不到的问题

clangd —— IDE 集成的实时分析

一、clangd 是什么

二、和 CLion 的配合

第六阶段总结

四、用 `.clang-tidy` 配置项目规则