Java枚举获取静态成员方法详解

欢迎各位小伙伴来到golang学习网，相聚于此都是缘哈哈哈！今天我给大家带来《Java 静态成员获取枚举方法及最佳实践》，这篇文章主要讲到等等知识，如果你对文章相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

本文探讨了在 Java 中将现有类的静态 `String` 成员转换为枚举的挑战与解决方案。由于 Java 枚举的静态特性，无法通过反射动态创建枚举。推荐的方法是手动创建一个包装枚举，并结合使用反射编写单元测试来验证枚举的完整性，确保它与原始静态成员保持同步，从而提供类型安全和代码便利性。

理解 Java 枚举的局限性

Java 中的枚举（enum）是编译时常量集合，其结构在编译时就已经确定。这意味着你无法在运行时通过反射或其他机制动态地创建新的枚举类型或向现有枚举中添加成员。如果一个外部类（你无法修改的类）包含大量静态 String 成员，并且你希望以枚举的形式使用它们以获得更好的类型安全性和编码便利性，那么直接从这些静态成员“派生”一个枚举是不可能的。

例如，给定以下包含静态 String 成员的类：

public class ClassWithStaticMembers {
  public static String ONE = "one";
  public static String TWO = "dos";
  // ... 100+ 更多静态成员
}

我们期望得到一个类似这样的枚举：

public enum NUMBERS {
  ONE,
  TWO
}

虽然不能动态生成 NUMBERS 枚举，但我们可以通过一种结合手动定义和自动化验证的方法来实现类似的效果。

推荐方法：创建包装枚举

最直接的解决方案是手动创建一个枚举，该枚举作为原始静态成员的包装器。这样可以为你提供枚举的所有优势，例如类型安全、可读性和在 switch 语句中的使用。

以下是一个包装枚举的示例：

public enum NumbersEnumeration {
  ONE(ClassWithStaticMembers.ONE),
  TWO(ClassWithStaticMembers.TWO);
  // ... 如果有100+个，这里需要手动添加100+个条目

  private final String value; // 可以存储原始静态字符串的值

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

  public String getValue() {
    return value;
  }

  // 也可以添加一个静态方法，根据原始值查找枚举
  public static NumbersEnumeration fromValue(String text) {
      for (NumbersEnumeration b : NumbersEnumeration.values()) {
          if (b.value.equals(text)) {
              return b;
          }
      }
      throw new IllegalArgumentException("No enum constant with value " + text);
  }
}

优点：

• 提供了类型安全和编译时检查。
• 增强了代码的可读性和可维护性。
• 可以在 switch 语句中使用。

缺点：

• 需要手动将每个静态成员映射到枚举常量，对于大量成员来说，这可能很繁琐。
• 如果原始 ClassWithStaticMembers 类添加或删除了静态成员，NumbersEnumeration 不会自动更新，可能导致不同步问题。

使用反射进行完整性验证

为了解决手动映射的缺点并确保包装枚举与原始静态成员保持同步，我们可以编写一个单元测试，利用 Java 反射机制来验证 NumbersEnumeration 是否包含了 ClassWithStaticMembers 中所有相关的静态 String 成员。

以下是一个使用 JUnit 和 AssertJ（或任何其他断言库）的测试示例：

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

public class NumbersEnumerationTest {

  @Test
  public void checkEnumCompleteness() throws Exception {
    // 获取 ClassWithStaticMembers 中所有公共、静态、非最终的 String 字段的名称
    // 通常我们只关心那些被设计为常量但可能被外部引用的字段
    List staticMemberNames = Arrays.stream(ClassWithStaticMembers.class.getDeclaredFields())
        .filter(field -> Modifier.isStatic(field.getModifiers())) // 必须是静态的
        .filter(field -> Modifier.isPublic(field.getModifiers()))  // 必须是公共的
        .filter(field -> field.getType().equals(String.class))    // 必须是String类型
        // 如果你的静态成员是 final 的，可以移除这个 filter，或者根据实际情况调整
        // .filter(field -> !Modifier.isFinal(field.getModifiers()))
        .map(Field::getName)
        .collect(Collectors.toList());

    System.out.println("Found static members: " + staticMemberNames);

    // 遍历所有静态成员的名称，并尝试在 NumbersEnumeration 中查找对应的枚举常量
    for (String memberName : staticMemberNames) {
      try {
        // 使用 Enum.valueOf() 方法，如果不存在会抛出 IllegalArgumentException
        NumbersEnumeration.valueOf(memberName);
        System.out.println("Enum constant found for: " + memberName);
      } catch (IllegalArgumentException e) {
        // 如果找不到对应的枚举常量，测试失败
        Assertions.fail("Missing enum constant for static member: " + memberName);
      }
    }
  }

  // 也可以反向检查，确保枚举中没有多余的常量
  @Test
  public void checkNoExtraEnumConstants() throws Exception {
      List staticMemberNames = Arrays.stream(ClassWithStaticMembers.class.getDeclaredFields())
              .filter(field -> Modifier.isStatic(field.getModifiers()))
              .filter(field -> Modifier.isPublic(field.getModifiers()))
              .filter(field -> field.getType().equals(String.class))
              .map(Field::getName)
              .collect(Collectors.toList());

      for (NumbersEnumeration enumConstant : NumbersEnumeration.values()) {
          Assertions.assertTrue(staticMemberNames.contains(enumConstant.name()),
                  "Enum constant " + enumConstant.name() + " does not have a corresponding static member in ClassWithStaticMembers.");
      }
  }
}

代码解释：

1. ClassWithStaticMembers.class.getDeclaredFields()：获取 ClassWithStaticMembers 类声明的所有字段（包括私有字段）。
2. Modifier.isStatic(field.getModifiers())：过滤出静态字段。
3. Modifier.isPublic(field.getModifiers())：过滤出公共字段。
4. field.getType().equals(String.class)：过滤出 String 类型的字段。
5. Field::getName：获取字段的名称。
6. NumbersEnumeration.valueOf(memberName)：尝试将静态成员的名称转换为 NumbersEnumeration 枚举常量。如果 memberName 在 NumbersEnumeration 中没有对应的常量，此方法将抛出 IllegalArgumentException。
7. Assertions.fail()：如果捕获到异常，则使测试失败，并提供清晰的错误消息。

通过运行这个单元测试，你可以在开发过程中自动检查 NumbersEnumeration 是否完整地覆盖了 ClassWithStaticMembers 中的所有相关静态成员。当 ClassWithStaticMembers 发生变化时，这个测试会失败，提醒你更新 NumbersEnumeration。

注意事项与最佳实践

• 反射性能： 反射操作通常比直接代码慢，但在单元测试中，这种性能开销是完全可以接受的。
• 字段筛选： 在使用反射时，请仔细考虑需要筛选哪些字段。例如，你可能只关心 public static final String 类型的字段，或者其他特定修饰符组合的字段。根据你的实际需求调整 filter 条件。
• 错误处理： Enum.valueOf() 方法在找不到匹配的枚举常量时会抛出 IllegalArgumentException。在测试中，我们通过 try-catch 块捕获并转换为更明确的断言失败。
• 可维护性： 尽管这种方法需要手动创建枚举，但通过自动化测试可以大大提高其可维护性，降低因外部类变更导致不同步的风险。
• 替代方案（如果不需要严格的枚举）： 如果你只是需要一个方便的查找机制，而不是严格的枚举类型，可以考虑在 ClassWithStaticMembers 中添加一个静态 Map，将所有静态成员的名称和值存储起来。但这会失去枚举的类型安全优势。

总结

虽然 Java 不支持在运行时动态创建枚举，但我们可以通过结合手动创建包装枚举和使用反射进行单元测试的方法，有效地管理来自外部类的静态 String 成员。这种方法既提供了枚举的类型安全和编码便利性，又通过自动化测试确保了数据的一致性和可维护性，是处理此类场景的专业且健壮的解决方案。

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~