java - 如何在 Java 中查找潜在的未经检查的异常？

Question

根据 Java 规范，Java 编译器会根据“throw”语句和方法签名自动验证是否捕获了所有已检查的异常，并忽略未检查的异常。

但是，有时开发人员找出可以抛出哪些未经检查的异常是有用的，例如，在开发人员倾向于期望检查异常的情况下(例如 Long.parseLong)，某些第 3 方代码可能会抛出未经检查的异常).或者开发人员可能会抛出一个未经检查的异常作为 future 检查异常的占位符，而忘记替换它。

在这些例子中，理论上是可以找到这些未捕获的未检查异常的。在第一种情况下，Long.parseLong 的签名表明它抛出 NumberFormatException，而在第二种情况下，源代码是可用的，因此编译器知道抛出哪些未经检查的异常。

我的问题是:是否有可以报告这些案例的工具？或者也许有一种方法可以让 Java 编译器暂时将未检查的异常视为已检查的异常？这对于手动验证和修复可能导致整个线程或应用程序在运行时崩溃的潜在错误非常有用。

编辑:经过一些回答后，我必须强调我的目标不是找到系统中可能出现的未检查异常的详尽列表，而是由于未检查异常导致的潜在错误。我认为归结为两种情况:

1. 一个方法的签名表明它抛出一个未经检查的异常，而调用者没有捕获它
2. 方法体显式抛出未经检查的异常，调用者不会捕获它们

Answer 1

是的，您可以编写静态分析来执行此操作。我自己做过类似的事情，并在名为 Atlas 的程序分析工具中编写了我的程序. Here: https://github.com/EnSoftCorp/java-toolbox-commons/.../ThrowableAnalysis.java是一些可能对您需要的东西有帮助的代码，它静态计算软件中 throw 站点和潜在捕获站点的匹配项(保守地说，它不考虑路径可行性)。对于您的情况，您对没有相应 catch block 的 throw 站点感兴趣。

以下是分析的重要部分。

1. 所有检查或未检查的异常必须扩展 Throwable .听起来您只对“未经检查的”throwables 感兴趣，因此您应该考虑直接扩展的类或者是扩展 Error 的类的子类或 RuntimeException .

在 Atlas Shell 中，您可以编写以下查询来查找所有未检查的可抛出对象。

var supertypeEdges = Common.universe().edgesTaggedWithAny(XCSG.Supertype)
var errors = supertypeEdges.reverse(Common.typeSelect("java.lang", "Error"))
var uncheckedExceptions = supertypeEdges.reverse(Common.typeSelect("java.lang", "RuntimeException"))
show(errors.union(uncheckedExceptions))

1. 任何可以在运行时捕获的异常(选中或未选中)都必须有相应的“抛出”站点。虽然抛出的检查异常必须在方法签名中声明，但不需要为抛出的未经检查的异常声明。然而，这并不是那么重要，因为我们可以简单地通过查看我们在步骤 1 中讨论的类型层次结构来检测所有抛出的未经检查的异常。

2. 为了将抛出站点与相应的 catch block 相匹配，我们必须记住，抛出的异常会传播回调用堆栈，直到它被捕获(或者在未被 main 方法或线程入口捕获时使程序崩溃)观点)。要进行此分析，您需要一个调用图(调用图越精确，您在这里的分析就越准确)。对于每个未经检查的异常类型的抛出，沿着调用图向后退回到可能抛出未经检查的异常的方法的调用点。检查调用点是否包含在 try block 中(或者如果您正在分析字节码，则有陷阱区域)。如果是，您必须检查捕获 block /陷阱区域的兼容性并确定是否会捕获异常。如果未捕获到异常，则重复该过程，沿着调用图向后步进到每个调用点，直到捕获到异常或没有可能的捕获 block 。

使用 ThrowableAnalysis我之前分享的代码，您可以将它们放在一起以找到每个未捕获的抛出的未检查的可抛出类型。

public class Analysis {

    // execute show(Analysis.run()) on the Atlas shell
    public static Q run(){
        Q supertypeEdges = Common.universe().edgesTaggedWithAny(XCSG.Supertype);
        Q errors = supertypeEdges.reverse(Common.typeSelect("java.lang", "Error"));
        Q uncheckedExceptions = supertypeEdges.reverse(Common.typeSelect("java.lang", "RuntimeException"));
        Q typeOfEdges = Common.universe().edgesTaggedWithAny(XCSG.TypeOf);
        Q thrownUncheckedThrowables = typeOfEdges.predecessors(errors.union(uncheckedExceptions)).nodesTaggedWithAny(XCSG.ThrownValue);

        AtlasSet<Node> uncaughtThrownUncheckedThrowables = new AtlasHashSet<Node>();
        for(Node thrownUncheckedThrowable : thrownUncheckedThrowables.eval().nodes()){
            if(ThrowableAnalysis.findCatchForThrows(Common.toQ(thrownUncheckedThrowable)).eval().nodes().isEmpty()){
                uncaughtThrownUncheckedThrowables.add(thrownUncheckedThrowable);
            }
        }

        Q uncaughtThrownUncheckedThrowableMethods = Common.toQ(uncaughtThrownUncheckedThrowables).containers().nodesTaggedWithAny(XCSG.Method);
        Q callEdges = Common.universe().edgesTaggedWithAny(XCSG.Call);
        Q rootMethods = callEdges.reverse(uncaughtThrownUncheckedThrowableMethods).roots();
        Q callChainToUncaughtThrowables = callEdges.between(rootMethods, uncaughtThrownUncheckedThrowableMethods);
        return callChainToUncaughtThrowables.union(Common.toQ(uncaughtThrownUncheckedThrowables));
    }

}

这是在以下测试用例上运行此代码的结果的屏幕截图。

public class Test {

    public static void main(String[] args) {
        foo();
    }

    private static void foo(){
        throw new Pig("Pigs can fly!");
    }

    public static class Pig extends RuntimeException {
        public Pig(String message){
            super(message);
        }
    }

}

重要注意事项:您必须考虑是否在此处进行整个程序分析。如果您只分析您的代码而不是完整的 JDK(几百万行代码)，那么您将只能检测到源自您的应用程序内部的未捕获的运行时异常。例如，您不会捕获“test”.substring(0,10)，它会在 JDK 的 String 类中声明的 substring 方法中抛出越界异常。虽然 Atlas 支持使用 Java 源代码或字节码进行部分或整个程序分析，并且可以扩展到完整的 JDK，但如果您计划包含完整的 JDK，则需要分配大约一个小时的预处理时间和 20 GB 的内存。