HOWTO · Java

如何在 Java 中将枚举转换为字符串

本教程介绍了用 Java 枚举类将枚举转换为字符串的两种方法。

本页内容

枚举定义一组固定的命名常量。每个常量都是其枚举类型的实例,Java 提供了获取字符串表示形式的方法。应根据用途选择方法:你需要的是源码中声明的确切标识符,还是用于显示的文本。

使用 name() 转换枚举常量

需要常量声明中的确切标识符时,可以对该常量调用 name()。例如,Directions.WEST.name() 返回字符串 WEST。返回值保留枚举声明中的拼写和大小写。name() 是 final 方法,因此枚举不能通过重写它来改变返回结果。

当代码需要标识符本身时,这种方法很有用,例如将一个值与已知的常量名称进行比较。请注意,重命名枚举常量也会改变 name() 返回的字符串。如果文本是给人阅读的,像 NORTH_EAST 这样的标识符可能不是你想展示的措辞。

使用 toString() 转换枚举常量

调用 toString() 同样会得到字符串。对于没有重写此方法的枚举,默认返回常量名称,因此 Directions.WEST.toString() 返回 WEST。与 name() 不同,枚举可以重写 toString(),使其返回其他文本。

应根据值的用途来选择方法。声明的标识符很重要时,使用 name();枚举选定的字符串表示适合调用方时,使用 toString()。并非所有场景都必然适合其中某一种。如果其他程序或存储格式依赖稳定的标识符,应明确设计并管理该格式,不要假设显示文本永远不会改变。

重写 toString() 以返回自定义文本

枚举可以通过构造函数为每个常量关联一个字符串,并在重写的 toString() 中返回该字段。这样,代码就能保留 USD 这样的简短标识符,同时生成 US dollars 这样更易读的文本。声明枚举时,每个常量都可以提供自己的值。

在下面的示例中,name() 仍会返回声明的标识符,而 toString() 则返回自定义标签。当自定义措辞适用时,这种区别对日志或面向用户的输出很有用。调用方调用 toString() 会得到自定义值;如果代码确实需要 USD,则应调用 name()。

将每个枚举常量作为字符串打印

Java 会为每种枚举类型生成 values() 方法。该方法返回一个数组,其中包含该类型按声明顺序排列的常量;它不是从 Enum 继承的方法。遍历这个数组即可处理每个值。将枚举常量与文本拼接时,会调用它的 toString() 方法,因此下面的循环会打印自定义标签。

运行这个完整示例,可以比较确切名称、默认字符串、自定义显示文本以及所有货币常量。示例输出中的自定义货币显示标签仍为英文,例如 US dollars 和 Japanese yen;代码块保持原样,因此这些标签没有本地化。

public class EnumToString {
    enum Directions {
        NORTH, SOUTH, EAST, WEST
    }

    enum PlainCurrencies {
        USD, YEN, EUR, INR
    }

    enum Currencies {
        USD("US dollars"),
        YEN("Japanese yen"),
        EUR("euros"),
        INR("Indian rupees");

        private final String displayText;

        Currencies(String displayText) {
            this.displayText = displayText;
        }

        @Override
        public String toString() {
            return displayText;
        }
    }

    public static void main(String[] args) {
        System.out.println(Directions.WEST.name());
        System.out.println(PlainCurrencies.USD.toString());
        System.out.println(Currencies.INR.name());
        System.out.println(Currencies.INR.toString());

        for (Currencies currency : Currencies.values()) {
            System.out.println(currency);
        }
    }
}
WEST
USD
INR
Indian rupees
US dollars
Japanese yen
euros
Indian rupees