确保 switch 语句的完整性

运行时的每次执行都将找到一个适当的分支,在这种意义上来说,确保每个 switch 语句的完整性是一种好做法。当将所有以下内容都考虑在内时,这实际上并不是一项简单任务:

此外,JLS 要求对可能导致意外编译时错误的枚举 switch 语句进行流分析:

    enum Colors { RED, GREEN, BLUE }
    String colorString(Color c) {
        switch(c) {
            case RED: return "red";
            case GREEN: return "green";
            case BLUE: return "blue";
        }
    }

编译器将响应:

“此方法必须返回 String 类型的结果。请注意,已阻止有关“switch”上缺少“default:”的问题,该问题也许与此问题相关。”

此消息旨在提醒用户完整性的不同概念:JLS 要求的流分析会将没有 default case 的每个枚举 switch 语句都视为不完整,即使该语句列出了所有(当前已知的)枚举常量也是如此。这涉及 return 语句以及局部变量或空白终态字段的明确赋值。但是,如果您遵循以下的所有建议,那么以上错误消息绝不会发生。

有关用于报告各种不完整性级别的各个配置选项,请查阅编译器首选项。接着,我们讨论不同的设计目标和策略,以及如何使用 Eclipse Java 编译器对其进行检查。

关于使用“default:”

最理想的情况是,每个 switch 语句都应具有一个有意义的 default 分支,它用于处理未使用“始终合理的”策略显式列出的所有情况。很明显,在许多情况下,很难或甚至无法找到这样的策略,但如果您可以找到有意义的缺省实现,那么这肯定就是最好的解决方案。

建议:通过使编译器就每个缺少 default case 的 switch 语句向您发出警告,将提醒您为每个 switch 语句搜索适当的缺省实现。

如果编译器就缺少 default case 向您发出警告,但缺省情况下应执行的合理操作是不执行任何操作,那么最好还是对其进行记录。

建议:如果“不执行任何操作”是合理的 default 策略,那么您应添加 default: 标签,该标签的操作仅是一个注释,说明在此 switch 中不执行任何操作是适当的做法(以及原因)。通过此操作,您也使编译器了解您并非只是忘了 default case。

如果确定找不到任何合理的缺省实现,那么作为最后手段,您可能希望阻止意外值成为下游其他错误的根本原因,即,您可能希望在运行时较早地失败。

建议:如果既找不到合理的缺省实现,而“不执行任何操作”似乎也不是适当的策略,请添加将抛出异常和/或记录问题的 default: case。

每个 switch 语句都应该可以分配给以上三个类别其中的某个类型。这表示使编译器就每个缺少的 default case 向您发出警告是普遍有效的策略。

处理所有枚举常量

对枚举值执行 switch 时,通过相应的 case 语句来显式涵盖每个枚举常量可能是可取的做法。

建议:如果希望收到有关对于任何枚举常量缺少 case 语句的枚举 switch 语句的警告,请考虑启用选项即使“default”case 存在也发出信号。

如果不希望使用所有枚举 switch 都应提到所有枚举常量的选项,但仍希望获得有关某些枚举 switch 语句缺少 case 标签的警告,那么您将需要为每个单独的枚举 switch 语句选择策略。

建议:如果以上警告对于某些 switch 语句是可取的,请考虑全局启用警告,并确定可以为某些枚举常量省略 case 的 switch 语句,因为这些语句适合由 default case 处理。对于这些 switch 语句,请使用“//$CASES-OMITTED$”标记注释来记录您的决策:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
            default:
        	return "unknown color";
        }
    }

提示:如果编译器报告类似于“枚举常量 BLUE 应在此有关 Color 的枚举 switch 中具有相应的 case 标签”的内容,那么将提供一个快速修订以用于插入标记注释。

总结

以上注意事项已显示,如果您(就有关不完整的 switch 语句)启用所有可选警告,并使用空的记录 default case 加上 //$CASES-OMITTED$ 标记注释来标记不完整本身就属于正常现象的 switch 语句,那么您将从编译器获得最大的帮助。如果您遵循这些建议,那么当意外省略分支时(包括后添加一个或多个枚举常量的情况),您将收到所有相关警告(或错误,如果您愿意)。此最大完整性的所有异常都将记录在代码中,并不再使用警告进行标记。

编译器仍然无法阻止在运行时使用不一致的类版本,因此可以针对枚举类型的旧版本来编译类,但在正在运行的应用程序中,该枚举类型可能具有多个枚举常量。对于这些情况和类似的情况,适当的“catch-all”缺省实现可能会发出运行时异常,以提醒此不一致性,并阻止将错误进一步传播到应用程序中。

作为上文建议的严格编译器设置的附加值,将不会再出现上文所示的有关缺少 return 语句的可疑错误消息(或有关未初始化变量的类似消息)。