如何用ArchUnit或其他手段提前验证ResourceBundle键的合法性？

我开发的Java应用使用了带静态工具类的ResourceBundle，简化实现如下：

class Bundle {
    static String get(String key) {
        return resourceBundle.getString(key);
    }
}

class UiClass {
    UiClass() {
        new Label(Bundle.get("key.to.resource"));
    }
}

如果传入错误的键（比如大小写错误的"Key.To.Resource"），应用只会在运行时抛出异常，编译或测试阶段不会报错。我已通过Maven引入ArchUnit 1.2.1版本，想用它编写测试检查项目中所有Bundle.get()调用的参数是否有效；不确定ArchUnit是否支持这类测试，如果不支持，该怎么在编译或测试阶段确保所有键的有效性？

一、用ArchUnit实现键有效性检查 #

ArchUnit完全支持这类静态检查，核心思路是先加载资源文件中的所有有效键，再通过规则校验所有Bundle.get()的字面量参数是否在有效键集合内。

具体实现步骤 #

1. 加载有效资源键
   先写工具方法读取目标资源文件的所有键：

   private static Set<String> loadValidBundleKeys() {
       // 替换为你的资源文件基础名称（不带.properties后缀）
       ResourceBundle bundle = ResourceBundle.getBundle("your.app.bundle");
       return bundle.keySet();
   }
   

2. 编写ArchUnit测试规则

   @ArchTest
   static final ArchRule valid_bundle_keys_only = ArchRuleDefinition
       .methodCalls()
       .that().callMethod(Bundle.class, "get", String.class)
       .should().haveParameterEqualTo(0, argument -> {
           // 仅校验字符串字面量参数，动态参数（如变量、方法返回值）无法静态分析
           if (argument instanceof StringLiteral) {
               String key = ((StringLiteral) argument).getValue();
               return loadValidBundleKeys().contains(key);
           }
           // 非字面量参数可选择跳过或标记为警告，根据需求调整
           return true;
       })
       .because("所有Bundle.get()的参数必须是资源文件中存在的有效键");
   

   注意：ArchUnit只能覆盖字符串字面量作为参数的场景，动态生成的键（如Bundle.get(userInput)）无法通过静态分析校验，需要结合其他手段补充。

二、ArchUnit覆盖不到的场景：替代方案 #

如果项目中有大量动态键，或者需要更严格的编译期约束，可选用以下方案：

1. 编译期生成常量/枚举类 #

用注解处理器（如Google Auto或自定义处理器）从资源文件自动生成包含所有键的枚举类，示例：

public enum BundleKey {
    KEY_TO_RESOURCE("key.to.resource");

    private final String value;

    BundleKey(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}

然后修改Bundle类的get方法，强制接收BundleKey类型参数：

class Bundle {
    static String get(BundleKey key) {
        return resourceBundle.getString(key.getValue());
    }
}

这样编译期就会拦截所有无效键的传入，从根源避免问题。

2. 字节码扫描型单元测试 #

如果不想修改现有代码结构，可以用ASM等字节码分析工具写单元测试，扫描所有类的Bundle.get()调用，提取参数并验证有效性。不过这种方式复杂度高于ArchUnit，仅适合特殊场景。

3. IDE插件辅助 #

IntelliJ IDEA等IDE的Resource Bundle插件可以在编码时实时提示无效键，提前发现问题，但这属于开发环境辅助，无法在构建阶段强制校验。

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