如何实现编译时检查宿主程序是否引用库的静态shutdown方法？

针对你遇到的新人遗漏调用库静态shutdown方法导致异常的问题，以下是几种不同语言环境下的编译时检查方案，均无需考虑反射、继承场景：

Java环境：注解处理器方案 #

• 自定义一个仅在源码阶段生效的注解，要求宿主的入口类（含main方法的类）添加该注解
• 编写注解处理器，在编译时扫描带注解的类，检查其中是否存在对YourLibrary.shutdown()的调用
• 未检测到调用时直接抛出编译错误

核心代码示例：

// 自定义注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface RequireShutdown {}

// 注解处理器核心逻辑
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (Element element : roundEnv.getElementsAnnotatedWith(RequireShutdown.class)) {
        if (element.getKind() == ElementKind.CLASS) {
            boolean hasShutdownCall = checkMethodInvocation((TypeElement) element, "YourLibrary", "shutdown");
            if (!hasShutdownCall) {
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, 
                    "必须调用YourLibrary.shutdown()方法以保证库资源正常释放", element);
            }
        }
    }
    return true;
}

// 辅助方法：检查类中是否存在指定方法调用
private boolean checkMethodInvocation(TypeElement clazz, String className, String methodName) {
    // 遍历类中所有方法，借助AST工具检查是否有目标方法调用的语法节点
    return /* 遍历逻辑结果 */;
}

C#环境：Roslyn分析器方案 #

• 创建Roslyn代码分析器，注册对方法符号的分析回调
• 定位到程序的Main入口方法，遍历其语法节点，检查是否存在YourLibrary.Shutdown()的调用
• 未找到调用时触发编译错误

核心代码示例：

public override void Initialize(AnalysisContext context)
{
    context.EnableConcurrentExecution();
    context.RegisterSymbolAction(AnalyzeMainMethod, SymbolKind.Method);
}

private void AnalyzeMainMethod(SymbolAnalysisContext context)
{
    var methodSymbol = (IMethodSymbol)context.Symbol;
    // 判断是否是程序入口Main方法
    if (!methodSymbol.Name.Equals("Main", StringComparison.Ordinal) || !methodSymbol.IsStatic)
        return;

    var syntaxRef = methodSymbol.DeclaringSyntaxReferences.FirstOrDefault();
    if (syntaxRef == null) return;

    var methodSyntax = (MethodDeclarationSyntax)syntaxRef.GetSyntax(context.CancellationToken);
    // 检查方法体内是否有目标调用
    var hasShutdownCall = methodSyntax.DescendantNodes()
        .OfType<InvocationExpressionSyntax>()
        .Any(inv => inv.Expression.ToString() == "YourLibrary.Shutdown");

    if (!hasShutdownCall)
    {
        context.ReportDiagnostic(Diagnostic.Create(
            DiagnosticRules.RequireShutdownCall,
            methodSyntax.GetLocation(),
            "必须调用YourLibrary.Shutdown()方法"));
    }
}

C/C++环境：链接器强制方案 #

• 在库的头文件中声明一个未实现的外部函数：extern void __require_shutdown_call();
• 在库的shutdown方法中添加对该函数的调用：

  void YourLibrary::shutdown() {
      __require_shutdown_call();
      // 原有资源释放逻辑
  }
  

• 要求宿主程序必须实现这个函数（如在宿主代码中添加void __require_shutdown_call() {}），否则链接阶段会报未定义符号错误
• 此方案间接强制宿主调用shutdown（若宿主仅实现空函数但不调用shutdown，仍会触发链接错误，因为只有调用shutdown才会触发符号引用检查）

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