如何在C++项目中禁用指定函数、类及头文件并加入CI/CD验证

针对你要在CI流水线中阻止使用iostream库（及相关类/函数）、同时支持忽略特定目录和单行的需求，以下是几种实用方案：

1. 静态代码扫描（CI流水线首选） #

这种方式可以在编译前快速检测违规代码，适合集成到CI的前置检查步骤。

用Grep快速扫描 #

直接用系统自带的grep命令就能实现基础检查，配合排除规则和忽略标记：

• 扫描禁用头文件：

  grep -r "#include.*iostream" ./src \
    --exclude-dir=third_party \
    --exclude-dir=tests \
    --exclude-dir=mocks \
    --include="*.cpp" \
    --include="*.h"
  

• 扫描禁用类/函数：

  grep -r -E "std::istream|std::ostream|std::getline" ./src \
    --exclude-dir=third_party \
    --exclude-dir=tests \
    --exclude-dir=mocks \
    --include="*.cpp" \
    --include="*.h"
  

• 支持忽略单行：在允许违规的代码行末尾加注释（比如// allow-iostream），然后修改grep命令排除这些行：

  grep -r "#include.*iostream" ./src \
    --exclude-dir=third_party \
    --exclude-dir=tests \
    --exclude-dir=mocks \
    --include="*.cpp" \
    --include="*.h" | grep -v "// allow-iostream"
  

如果扫描到匹配内容，grep会返回非零退出码，CI流水线会自动终止。

用Clang-Tidy做精准检查 #

如果需要更精准的语法级检测（比如区分std::getline和自定义的getline），可以用Clang-Tidy自定义检查规则：

1. 编写一个简单的Clang-Tidy Check，检测：
   • 是否包含<iostream>头文件
   • 是否使用std::istream、std::ostream等禁用类型
   • 是否调用std::getline等禁用函数
2. 在项目的.clang-tidy配置文件中启用该检查，并指定排除目录：

   Checks: '-*,your-custom-iostream-check'
   HeaderFilterRegex: '^./src/'
   ExcludeRegex: 'third_party/|tests/|mocks/'
   

3. 在CI中运行clang-tidy -p build/ ./src/**/*.cpp ./src/**/*.h，违规时直接报错终止流水线。
   另外，Clang-Tidy原生支持// NOLINT或// NOLINTNEXTLINE注释，用来忽略单行或下一行的违规。

2. 编译时拦截（强制阻止违规） #

通过预编译宏在编译阶段直接报错，从根源上阻止代码使用禁用内容：
在项目的全局公共头文件（比如project_common.h）中添加以下代码：

#ifdef __cplusplus
// 拦截禁用头文件
#define iostream "ERROR: 禁止使用iostream，请改用stdio库"
// 拦截禁用类和函数
#define std::istream __FORBIDDEN_TYPE_ISTREAM__
#define std::ostream __FORBIDDEN_TYPE_OSTREAM__
#define std::getline(...) __FORBIDDEN_FUNC_GETLINE__

// 如果是间接包含iostream，触发静态断言
#ifdef _IOSTREAM_
static_assert(false, "禁止间接包含iostream库");
#endif
#endif

这样只要代码中包含<iostream>或使用禁用的类/函数，编译时就会直接抛出错误。如果需要临时忽略某个文件，可以在该文件开头添加#undef _DISABLE_IOSTREAM（前提是把上面的代码包在#ifndef _DISABLE_IOSTREAM块里）。

3. 构建系统集成 #

把检查步骤集成到CMake或Makefile中，确保每次构建都会自动执行检查：
比如在CMake中添加自定义目标：

add_custom_target(
  check_forbidden_code
  COMMAND grep -r "#include.*iostream" ${PROJECT_SOURCE_DIR}/src --exclude-dir=third_party --exclude-dir=tests --exclude-dir=mocks --include="*.cpp" --include="*.h"
  COMMAND grep -r -E "std::istream|std::ostream|std::getline" ${PROJECT_SOURCE_DIR}/src --exclude-dir=third_party --exclude-dir=tests --exclude-dir=mocks --include="*.cpp" --include="*.h"
  COMMENT "Checking for forbidden iostream usage..."
)

# 让构建目标依赖检查目标
add_dependencies(your_project_target check_forbidden_code)

这样在CI中执行构建时，会先运行检查，失败则直接终止构建。

内容的提问来源于stack exchange，提问作者Danya Smelskiy