使用LibTooling检索并存储C++实体元数据的方案咨询

核心限制：AST上下文的生命周期 #

首先明确：ClangTool::run()执行完毕后，AST上下文（ASTContext）会被完全销毁，所有AST节点的原始指针都会变成野指针，直接存储原始指针的方案完全不可行，必须放弃。

常见实践方案 #

1. 提取元数据到自定义数据结构（最常用） #

这是LibTooling开发者最普遍的做法——不需要完整包装所有Clang的Decl类，只提取后续处理需要的元数据即可，比如：

• 类的完整名称（含命名空间前缀）
• 基类列表
• 成员函数/变量的关键信息
• 模板参数（针对类模板）
• 源文件位置（行号、列号）

在run()方法里直接从AST节点中提取这些信息，存入自定义的结构体或类中，示例代码如下：

// 自定义的类元数据结构
struct ClassMetadata {
  std::string FullName;
  std::vector<std::string> BaseClasses;
  std::string SourceFile;
  unsigned LineNumber;
};

struct Handler : MatchFinder::MatchCallback {
  // 存储所有提取的元数据
  std::vector<ClassMetadata> CollectedClasses;

  void run(const MatchFinder::MatchResult& result) override {
    if (const auto* record = result.Nodes.getNodeAs<clang::CXXRecordDecl>("rec")) {
      if (!record->isImplicit() && record->isDefined()) { // 过滤隐式生成或未定义的类
        ClassMetadata meta;
        // 提取完整名称（含命名空间）
        meta.FullName = record->getQualifiedNameAsString();
        // 提取基类信息
        for (const auto& base : record->bases()) {
          if (const auto* baseType = base.getType()->getAs<clang::RecordType>()) {
            meta.BaseClasses.push_back(baseType->getDecl()->getQualifiedNameAsString());
          }
        }
        // 提取源位置信息
        const auto& loc = record->getLocation();
        if (loc.isValid() && result.SourceManager->isInMainFile(loc)) {
          meta.SourceFile = result.SourceManager->getFilename(loc).str();
          meta.LineNumber = result.SourceManager->getSpellingLineNumber(loc);
        }
        CollectedClasses.push_back(std::move(meta));
      }
    }
  }
};

这种方式轻量灵活，只保留必要信息，完全脱离Clang的AST上下文，后续处理不受任何限制。

2. 利用Clang的序列化机制（进阶方案） #

如果确实需要保留完整的AST节点信息用于复杂后续处理，可以使用Clang的AST序列化功能，将AST节点序列化为字节流保存，后续需要时再反序列化恢复。不过该方案复杂度较高，需要熟悉Clang的Serialization模块，且序列化内容体积较大，仅适合特定场景。

3. 延迟处理（在AST生命周期内完成所有操作） #

如果后续处理逻辑可以在ClangTool::run()执行期间完成，完全不需要存储元数据——直接在run()方法里处理AST节点，比如生成代码、输出分析报告等，处理完成后直接结束。这是最直接的方案，clang-tidy的检查器等多数LibTooling工具都采用这种模式。

总结 #

• 直接存储AST节点指针：绝对不可行，AST上下文销毁后指针会失效。
• 自定义元数据结构：最推荐，适配绝大多数场景，灵活且轻量。
• AST序列化：适合需要完整AST信息的复杂场景，但学习成本高。
• 延迟处理：若后续逻辑可在AST生命周期内完成，优先选择。

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