文章目录
使用 Clang-Tidy 进行静态代码分析：完整的配置与 CMake 集成实例
-
关于Cppcheck 的使用请参考： 使用 Cppcheck 进行静态代码分析：完整的 shell 脚本与 CMake 集成实例
-
关于OCLint的使用请参考： 使用 OCLint进行静态代码分析：一个完整的配置示例
-
本文重点介绍与CMake 集成，如需shell脚本进行clang-tidy检测请参考: 使用多进程shell脚本进行clang-tidy静态代码分析 和 使用 shell 脚本进行 clang-tidy 静态代码分析
0. 概要
Clang-Tidy 是一款功能强大的静态代码分析工具。
现在clang-tidy实现有100+个check，请查看list列表。根据check不同种类(从check名字的前缀就能知道哪一类)，分为如下几大类：
- boost 检测boost库API使用问题
- cert 检测CERT的代码规范
- cpp-core-guidelines 检测是否违反cpp-core-guidelines
- google 检测是否违反google code style
- llvm 检测是否违反llvm code style
- readability 检测代码上相关问题，但又不明确属于任何代码规范的
- misc 其它一些零碎的check
- mpi 检测MPI API问题
- modernize 把C++03代码转换成C++11代码，使用C++11新特性
- performance 检测performance相关问题
本文将详细介绍其安装与配置方法，并展示与 CMake 的集成，通过自动化分析帮助读者提升 C++ 代码质量。
1. 安装 Clang-Tidy
Clang-Tidy 是一款基于 LLVM/Clang 框架的强大静态代码分析工具，专门用于检测 C++ 代码中的潜在问题和改进建议。它通过生成和解析抽象语法树（AST）深入理解代码结构和语义，从而提供高精度的检测结果，帮助开发者提升代码质量。
要安装最新版本的 Clang-Tidy，推荐使用 llvm.sh 脚本，直接apt-get安装后的clang-tidy版本较旧。
-
先使用
llvm.sh脚本：- 下载并运行
llvm.sh脚本来安装 LLVM 和 Clang-Tidy：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
本次配置比较详细，主要是为了减少误报。
---
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,
misc-unconventional-assign-operator,
misc-unused-parameters'
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' # 检查并标识可能导致数据丢失的窄化转换。
# 杂项（Miscellaneous）
- key: misc-unconventional-assign-operator
value: 'true' # 检查并标识不常见的赋值操作符重载，以确保代码的一致性和可维护性。
- key: misc-unused-parameters
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 风格的类型转换。提高类型转换的安全性和可读性。
- 检查并建议使用 C++ 风格的类型转换（如
3.4 可读性（Readability）
readability-braces-around-statements:- 建议在单行语句周围添加大括号。提高代码的可读性和一致性，防止因省略大括号导致的错误。
readability-identifier-naming.ClassCase:- 类名应使用 CamelCase 风格，例如
MyClassName。提高代码命名的一致性和规范性。
- 类名应使用 CamelCase 风格，例如
readability-identifier-naming.StructCase:- 结构体名应使用 CamelCase 风格，例如
MyStructName。统一结构体的命名风格。
- 结构体名应使用 CamelCase 风格，例如
readability-identifier-naming.TypedefCase:- 类型定义应使用 CamelCase 风格，例如
MyTypeDef。规范类型定义的命名方式。
- 类型定义应使用 CamelCase 风格，例如
readability-identifier-naming.EnumCase:- 枚举名应使用 CamelCase 风格，例如
MyEnumName。保持枚举命名的一致性。
- 枚举名应使用 CamelCase 风格，例如
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:- 检查并标识不常见的赋值操作符重载。确保代码的一致性和可维护性，防止意外的行为。
-
misc-unused-parameters:- 检测未使用的参数。
4. 使用 Clang-Tidy
4.1 生成 compile_commands.json
使用 CMake 时，可以这样生成包含编译命令的 JSON 文件，该文件包含项目中所有源文件的编译信息。
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++14 **
添加 -extra-arg=-std=c++14 参数可以指定 C++ 标准版本。例如：
clang-tidy -p build -config-file=./.clang-tidy -extra-arg=-std=c++14 <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.
.....
如果没有错误时的提示
clang-tidy-18 -extra-arg=-std=c++14 -p=. --config-file=./.clang-tidy /home/test/Desktop/memory_analysis_v2/example.cpp
832 warnings generated.
Suppressed 832 warnings (830 in non-user code, 2 with check filters).
Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
4.4 如何屏蔽warnings?
在代码的后面添加// NOLINT即可屏蔽检测。
4.5 与 CMake 集成
通过将 Clang-Tidy 与 CMake 集成，可以在编译阶段自动运行代码分析，早期发现潜在问题。本节将介绍如何在 CMake 构建系统中集成 Clang-Tidy，并解释相关脚本的工作原理。
CMake 脚本详解
cmake_minimum_required(VERSION 3.10)
# Project name
project(ExampleProject)
# Generate compile_commands.json to enable clang-tidy checks
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
# example target
add_executable(example example.cpp)
# Find all .cpp files in the project source directory
file(GLOB_RECURSE ALL_CPP_FILES ${CMAKE_SOURCE_DIR}/*.cpp)
# Clang-tidy custom targets for running and checking results
add_custom_target(run_clang_tidy
COMMAND clang-tidy -p ${CMAKE_BINARY_DIR} --warnings-as-errors=* ${ALL_CPP_FILES} || ${CMAKE_COMMAND} -E touch ${CMAKE_BINARY_DIR}/clang_tidy_failed
COMMENT "Running clang-tidy"
VERBATIM)
add_custom_target(check_clang_tidy
COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_BINARY_DIR}/clang_tidy_failed
COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target run_clang_tidy
COMMENT "Checking clang-tidy results"
VERBATIM)
# Ensure run_clang_tidy and check_clang_tidy are run before building any target
add_dependencies(example run_clang_tidy)
# Function to add Clang-Tidy pre-build check
function(add_clang_tidy_pre_build target_name)
add_custom_command(TARGET ${target_name} PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E echo "Running Clang-Tidy pre-build check for ${target_name}"
COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_BINARY_DIR}/clang_tidy_failed
COMMAND /bin/bash -c "if [ -f ${CMAKE_BINARY_DIR}/clang_tidy_failed ]; then echo 'Stopping build due to Clang-tidy errors.'; exit 1; else echo 'No Clang-tidy issues found. Continuing build.'; fi"
COMMENT "Checking for Clang-tidy issues before building ${target_name}"
VERBATIM)
endfunction()
# Add Clang-Tidy pre-build check for targets
add_clang_tidy_pre_build(example)
脚本细节解析
-
CMake 基本设置：
set(CMAKE_EXPORT_COMPILE_COMMANDS ON): 生成compile_commands.json文件，提供编译数据库，方便 Clang-Tidy 使用。
-
目标文件和源文件：
file(GLOB_RECURSE ALL_CPP_FILES ${CMAKE_SOURCE_DIR}/*.cpp): 递归查找项目源目录下的所有.cpp文件，并将其存储在ALL_CPP_FILES变量中。这一步确保所有的源文件都包含在 Clang-Tidy 的检查范围内。
-
定义 Clang-Tidy 自定义目标：
add_custom_target(run_clang_tidy ...):COMMAND clang-tidy -p ${CMAKE_BINARY_DIR} --warnings-as-errors=* ${ALL_CPP_FILES} || ${CMAKE_COMMAND} -E touch ${CMAKE_BINARY_DIR}/clang_tidy_failed: 运行 Clang-Tidy，检查所有的.cpp文件。若发现任何警告，将其视为错误并生成clang_tidy_failed文件。COMMENT "Running clang-tidy": 提供执行过程中显示的注释。VERBATIM: 确保命令字符串的精确性，不对其进行解释或修改。
add_custom_target(check_clang_tidy ...):COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_BINARY_DIR}/clang_tidy_failed: 删除clang_tidy_failed文件，以确保每次检查前都是干净的状态。COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target run_clang_tidy: 构建run_clang_tidy目标，实际执行 Clang-Tidy 检查。COMMENT "Checking clang-tidy results": 提供执行过程中显示的注释。VERBATIM: 确保命令字符串的精确性。
-
目标依赖关系：
add_dependencies(example run_clang_tidy): 定义example目标依赖于run_clang_tidy目标。这确保在构建example之前，先运行 Clang-Tidy 检查。
-
添加预构建检查：
function(add_clang_tidy_pre_build target_name): 定义一个函数，用于为指定的目标添加 Clang-Tidy 预构建检查。add_custom_command(TARGET ${target_name} PRE_BUILD ...):COMMAND ${CMAKE_COMMAND} -E echo "Running Clang-Tidy pre-build check for ${target_name}": 在构建前输出一条消息，表示正在进行 Clang-Tidy 预构建检查。COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_BINARY_DIR}/clang_tidy_failed: 删除clang_tidy_failed文件，确保检查开始前是干净的。COMMAND /bin/bash -c "if [ -f ${CMAKE_BINARY_DIR}/clang_tidy_failed ]; then echo 'Stopping build due to Clang-tidy errors.'; exit 1; else echo 'No Clang-tidy issues found. Continuing build.'; fi": 运行一个 Bash 脚本，检查clang_tidy_failed文件是否存在。如果存在，则终止构建并输出错误消息；如果不存在，则继续构建。COMMENT "Checking for Clang-tidy issues before building ${target_name}": 提供执行过程中显示的注释。VERBATIM: 确保命令字符串的精确性。
-
为目标添加预构建检查：
add_clang_tidy_pre_build(example): 为example目标添加 Clang-Tidy 预构建检查，确保在每次构建之前进行代码分析。
5. 资源阅读
转载自CSDN-专业IT技术社区
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
原文链接：https://blog.csdn.net/stallion5632/article/details/139545885
