使用 Clang-Tidy 进行C++静态代码分析：一个完整的配置实例

文章目录

[使用 Clang-Tidy 进行静态代码分析：一个完整的配置实例](#使用 Clang-Tidy 进行静态代码分析：一个完整的配置实例)
- [0. Clang-Tidy简介](#0. Clang-Tidy简介)
- [1. 安装 Clang-Tidy](#1. 安装 Clang-Tidy)
- [2. 配置 `.clang-tidy`](#2. 配置 .clang-tidy)
- [3. 检查项详解](#3. 检查项详解)
- - [3.1 静态分析器（Static Analyzer）](#3.1 静态分析器（Static Analyzer）)
  - [3.2 现代化（Modernize）](#3.2 现代化（Modernize）)
  - [3.3 Google 代码风格（Google）](#3.3 Google 代码风格（Google）)
  - [3.4 可读性（Readability）](#3.4 可读性（Readability）)
  - [3.5 CERT 安全编码标准（CERT）](#3.5 CERT 安全编码标准（CERT）)
  - [3.6 Bug 检测（Bugprone）](#3.6 Bug 检测（Bugprone）)
  - [3.7 C++ 核心指南（CppCoreGuidelines）](#3.7 C++ 核心指南（CppCoreGuidelines）)
  - [3.8 杂项（Miscellaneous）](#3.8 杂项（Miscellaneous）)
- [4. 使用 Clang-Tidy](#4. 使用 Clang-Tidy)
- - [4.1 生成 `compile_commands.json`](#4.1 生成 compile_commands.json)
  - [4.2 运行检测](#4.2 运行检测)
  - [4.3 执行结果](#4.3 执行结果)
- [5. 资源阅读](#5. 资源阅读)

使用 Clang-Tidy 进行静态代码分析：一个完整的配置实例

0. Clang-Tidy简介

Clang-Tidy 是一款功能强大的静态代码分析工具，用于检测 C++ 代码中的潜在问题和改进建议。它基于 LLVM/Clang 框架构建，能够深入理解代码结构和语义，并提供高精度的检测结果。

Clang-Tidy 是一个基于 LLVM/Clang 的代码分析工具，通过解析代码生成抽象语法树（AST），深入理解代码结构和语义，从而进行静态代码分析。AST 是一种树状数据结构，代表了程序的语法结构。Clang-Tidy 利用这个结构来检测代码中潜在的问题和改进的建议。

1. 安装 Clang-Tidy

要安装最新版本的 Clang-Tidy，推荐使用 llvm.sh 脚本，直接apt-get安装后的clang-tidy版本较旧。

先使用 llvm.sh 脚本：

下载并运行 llvm.sh 脚本来安装 LLVM 和 Clang-Tidy：

sh 复制代码

wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 18  # 安装了18版本

接着使用 apt-get 安装 Clang-Tidy：
sh 复制代码
```
sudo apt-get install clang-tidy
```

2. 配置 `.clang-tidy`

本次配置比较详细，主要是为了减少误报。

.clang-tidy 复制代码

---
Checks: '-*,
        clang-analyzer-core.*,
        clang-analyzer-cplusplus.*,
        modernize-redundant-void-arg,
        modernize-use-bool-literals,
        modernize-use-equals-default,
        modernize-use-nullptr,
        modernize-use-override,
        google-explicit-constructor,
        google-readability-casting,
        readability-braces-around-statements,
        readability-identifier-naming.ClassCase,
        readability-identifier-naming.StructCase,
        readability-identifier-naming.TypedefCase,
        readability-identifier-naming.EnumCase,
        readability-non-const-parameter,
        cert-dcl21-cpp,
        bugprone-undelegated-constructor,
        bugprone-macro-parentheses,
        bugprone-macro-repeated-side-effects,
        bugprone-forward-declaration-namespace,
        bugprone-bool-pointer-implicit-conversion,
        bugprone-misplaced-widening-cast,
        cppcoreguidelines-narrowing-conversions,
        cppcoreguidelines-pro-type-reinterpret-cast,
        misc-unconventional-assign-operator'
WarningsAsErrors: ''
HeaderFilterRegex: ''
CheckOptions:
  # 现代化（Modernize）
  - key:             modernize-redundant-void-arg
    value:           'true'  # 检查并移除函数声明中冗余的 void 参数。
  - key:             modernize-use-bool-literals
    value:           'true'  # 建议使用布尔字面量 true 和 false 代替整数值 0 和 1。
  - key:             modernize-use-equals-default
    value:           'true'  # 建议在默认构造函数、复制构造函数和赋值运算符中使用 = default，以简化代码。
  - key:             modernize-use-nullptr
    value:           'true'  # 建议使用 nullptr 代替 NULL 或 0 来表示空指针。
  - key:             modernize-use-override
    value:           'true'  # 建议在覆盖基类虚函数时使用 override 关键字，以增加代码的清晰性和安全性。

  # Google 代码风格（Google）
  - key:             google-explicit-constructor
    value:           'true'  # 检查并建议在单参数构造函数中使用 explicit 关键字，以防止隐式转换。
  - key:             google-readability-casting
    value:           'true'  # 检查并建议使用 C++ 风格的类型转换（如 static_cast、dynamic_cast、const_cast 和 reinterpret_cast）代替 C 风格的类型转换。

  # 可读性（Readability）
  - key:             readability-braces-around-statements
    value:           'true'  # 建议在单行语句周围添加大括号，以提高代码的可读性和一致性。
  - key:             readability-identifier-naming.ClassCase
    value:           'CamelCase'  # 类名应使用 CamelCase 风格，例如 MyClassName。
  - key:             readability-identifier-naming.StructCase
    value:           'CamelCase'  # 结构体名应使用 CamelCase 风格，例如 MyStructName。
  - key:             readability-identifier-naming.TypedefCase
    value:           'CamelCase'  # 类型定义应使用 CamelCase 风格，例如 MyTypeDef。
  - key:             readability-identifier-naming.EnumCase
    value:           'CamelCase'  # 枚举名应使用 CamelCase 风格，例如 MyEnumName。
  - key:             readability-non-const-parameter
    value:           'true'  # 检查并标识非 const 参数，以提高代码的可读性和安全性。

  # CERT 安全编码标准（CERT）
  - key:             cert-dcl21-cpp
    value:           'true'  # 检查并标识在头文件中不应包含无命名空间的 using 声明和指令，以防止命名空间污染。

  # Bug 检测（Bugprone）
  - key:             bugprone-undelegated-constructor
    value:           'true'  # 检查并标识未委托的构造函数，以确保构造函数的正确性。
  - key:             bugprone-macro-parentheses
    value:           'true'  # 检查并建议在宏定义中使用括号，以防止潜在的错误。
  - key:             bugprone-macro-repeated-side-effects
    value:           'true'  # 检查并标识宏中重复的副作用，以防止潜在的错误。
  - key:             bugprone-forward-declaration-namespace
    value:           'true'  # 检查并标识命名空间前向声明的潜在问题。
  - key:             bugprone-bool-pointer-implicit-conversion
    value:           'true'  # 检查并标识布尔指针的隐式转换，以防止潜在的错误。
  - key:             bugprone-misplaced-widening-cast
    value:           'true'  # 检查并标识错误的宽化转换，以防止潜在的错误。

  # C++ 核心指南（CppCoreGuidelines）
  - key:             cppcoreguidelines-narrowing-conversions
    value:           'true'  # 检查并标识可能导致数据丢失的窄化转换。
  - key:             cppcoreguidelines-pro-type-reinterpret-cast
    value:           'true'  # 检查并警告使用 reinterpret_cast 的地方，以提高代码的类型安全性。

  # 杂项（Miscellaneous）
  - key:             misc-unconventional-assign-operator
    value:           'true'  # 检查并标识不常见的赋值操作符重载，以确保代码的一致性和可维护性。
...

-*: 禁用所有默认的检查。

3. 检查项详解

3.1 静态分析器（Static Analyzer）

clang-analyzer-core.*:
- 用于检测代码中的基本问题，包括内存管理错误、未初始化变量、空指针引用等。这些检查器会深入分析代码逻辑，找出潜在的错误。
- 主要功能 ：
  - 检查未初始化变量使用。
  - 检查空指针解引用。
  - 检查内存泄漏。
  - 检查未处理的返回值。
  - 检查资源泄漏。
clang-analyzer-cplusplus.*:
- 专注于 C++ 代码中的特定问题。这些检查器可以检测 C++ 特有的错误，如对象的生命周期管理、构造函数和析构函数的使用等。
- 主要功能 ：
  - 检查 C++ 对象的正确构造和析构。
  - 检查对象的移动和复制语义。
  - 检查异常安全性。
  - 检查智能指针的正确使用。

3.2 现代化（Modernize）

modernize-redundant-void-arg:
- 检查并移除函数声明中冗余的 void 参数。使函数签名更简洁。
modernize-use-bool-literals:
- 建议使用布尔字面量 true 和 false 代替整数值 0 和 1。提高代码的可读性和表达性。
modernize-use-equals-default:
- 建议在默认构造函数、复制构造函数和赋值运算符中使用 = default，以简化代码，并确保编译器生成更高效的代码。
modernize-use-nullptr:
- 建议使用 nullptr 代替 NULL 或 0 来表示空指针。避免类型不匹配的风险。
modernize-use-override:
- 建议在覆盖基类虚函数时使用 override 关键字。确保函数覆盖的正确性，避免意外的函数隐藏。

3.3 Google 代码风格（Google）

google-explicit-constructor:
- 检查并建议在单参数构造函数中使用 explicit 关键字。防止隐式转换带来的意外行为。
google-readability-casting:
- 检查并建议使用 C++ 风格的类型转换（如 static_cast、dynamic_cast、const_cast 和 reinterpret_cast）代替 C 风格的类型转换。提高类型转换的安全性和可读性。

3.4 可读性（Readability）

readability-braces-around-statements:
- 建议在单行语句周围添加大括号。提高代码的可读性和一致性，防止因省略大括号导致的错误。
readability-identifier-naming.ClassCase:
- 类名应使用 CamelCase 风格，例如 MyClassName。提高代码命名的一致性和规范性。
readability-identifier-naming.StructCase:
- 结构体名应使用 CamelCase 风格，例如 MyStructName。统一结构体的命名风格。
readability-identifier-naming.TypedefCase:
- 类型定义应使用 CamelCase 风格，例如 MyTypeDef。规范类型定义的命名方式。
readability-identifier-naming.EnumCase:
- 枚举名应使用 CamelCase 风格，例如 MyEnumName。保持枚举命名的一致性。
readability-non-const-parameter:
- 检查并标识非 const 参数。提高代码的可读性和安全性，防止意外修改参数值。

3.5 CERT 安全编码标准（CERT）

cert-dcl21-cpp:
- 检查并标识在头文件中不应包含无命名空间的 using 声明和指令。防止命名空间污染，提高代码的可维护性。

3.6 Bug 检测（Bugprone）

bugprone-undelegated-constructor:
- 检查并标识未委托的构造函数。确保构造函数的正确性，避免重复代码。
bugprone-macro-parentheses:
- 检查并建议在宏定义中使用括号。防止宏扩展带来的优先级问题。
bugprone-macro-repeated-side-effects:
- 检查并标识宏中重复的副作用。防止宏多次展开时的副作用问题。
bugprone-forward-declaration-namespace:
- 检查并标识命名空间前向声明的潜在问题。确保命名空间前向声明的正确性。
bugprone-bool-pointer-implicit-conversion:
- 检查并标识布尔指针的隐式转换。防止隐式转换带来的潜在错误。
bugprone-misplaced-widening-cast:
- 检查并标识错误的宽化转换。避免由于类型转换导致的数据丢失或错误。

3.7 C++ 核心指南（CppCoreGuidelines）

cppcoreguidelines-narrowing-conversions:
- 检查并标识可能导致数据丢失的窄化转换。确保类型转换的安全性，防止数据丢失。
cppcoreguidelines-pro-type-reinterpret-cast:
- 检查并警告使用 reinterpret_cast 的地方。提高代码的类型安全性，避免使用不安全的类型转换。

3.8 杂项（Miscellaneous）

misc-unconventional-assign-operator:

检查并标识不常见的赋值操作符重载。确保代码的一致性和可维护性，防止意外的行为。

4. 使用 Clang-Tidy

4.1 生成 `compile_commands.json`

使用 CMake 时，可以这样生成包含编译命令的 JSON 文件，该文件包含项目中所有源文件的编译信息。

sh 复制代码

mkdir build
cd build
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..

4.2 运行检测

有了 compile_commands.json，就可以使用run-clang-tidy或者clang-tidy检测指定源文件：

推荐使用 run-clang-tidy，例如

run-clang-tidy -p build -config-file=./.clang-tidy

.clang-tidy 配置文件也可以不用手动指定。

run-clang-tidy 和 clang-tidy 的区别
- clang-tidy：单独检测一个源文件，主要用于小规模或单文件测试。
- run-clang-tidy：可以批量检测多个源文件，非常适用于大规模项目。
**是否添加 -extra-arg=-std=c++11 **

添加 -extra-arg=-std=c++11 参数可以指定 C++ 标准版本。例如：

sh 复制代码

clang-tidy -p build -config-file=./.clang-tidy -extra-arg=-std=c++11 <source_file>

4.3 执行结果

.....
clang-tidy-18 -extra-arg=-std=c++11 -p=. --config-file=./.clang-tidy /home/test/clang-tidy/example.cpp
/home/test/Desktop/memory_analysis_v2/example.cpp:33:21: warning: narrowing conversion from 'size_t' (aka 'unsigned long') to signed type 'int' is implementation-defined [cppcoreguidelines-narrowing-conversions]
   33 |       arrayPtr[i] = i;
      |                     ^
830 warnings generated.
.....

5. 资源阅读

官方文档：Clang-Tidy Documentation
社区论坛：LLVM Discussion Forums

使用 Clang-Tidy 进行C++静态代码分析：一个完整的配置实例

文章目录

使用 Clang-Tidy 进行静态代码分析：一个完整的配置实例

0. Clang-Tidy简介

1. 安装 Clang-Tidy

2. 配置 .clang-tidy

3. 检查项详解

3.1 静态分析器（Static Analyzer）

3.2 现代化（Modernize）

3.3 Google 代码风格（Google）

3.4 可读性（Readability）

3.5 CERT 安全编码标准（CERT）

3.6 Bug 检测（Bugprone）

3.7 C++ 核心指南（CppCoreGuidelines）

3.8 杂项（Miscellaneous）

4. 使用 Clang-Tidy

4.1 生成 compile_commands.json

4.2 运行检测

4.3 执行结果

5. 资源阅读

2. 配置 `.clang-tidy`

4.1 生成 `compile_commands.json`