java enum 重写tostring

原创

mob64ca12e1497a 2023-08-07 07:58:24 ©著作权

文章标签 Java 字符串 java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e1497a的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java Enum 重写toString

在Java中，枚举（Enum）是一种特殊的数据类型，它允许我们定义一个有限的、预定义的值集合。枚举类型在很多情况下非常有用，例如表示颜色、星期几、状态等。在使用枚举类型时，我们通常想要以可读的方式打印枚举值，而不是默认的枚举名称。

为什么要重写toString方法？

在Java中，每个对象都有一个toString方法，用于返回该对象的字符串表示。默认情况下，Enum类的toString方法返回的是枚举的名称，这在某些情况下可能不是我们想要的。

考虑一个例子，我们有一个枚举类型表示星期几：

public enum DayOfWeek {
    MONDAY,
    TUESDAY,
    WEDNESDAY,
    THURSDAY,
    FRIDAY,
    SATURDAY,
    SUNDAY
}

如果我们直接打印一个星期几的枚举值，例如System.out.println(DayOfWeek.MONDAY)，输出将会是MONDAY。然而，我们更希望输出的是星期一，这对于用户来说更容易理解。

如何重写toString方法？

要重写Enum的toString方法，我们只需要为每个枚举值添加一个自定义的toString方法，然后在方法中返回我们期望的字符串表示。

以下是一个重写了DayOfWeek枚举的toString方法的示例：

public enum DayOfWeek {
    MONDAY("星期一"),
    TUESDAY("星期二"),
    WEDNESDAY("星期三"),
    THURSDAY("星期四"),
    FRIDAY("星期五"),
    SATURDAY("星期六"),
    SUNDAY("星期日");

    private String chineseName;

    private DayOfWeek(String chineseName) {
        this.chineseName = chineseName;
    }

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

在这个示例中，我们为每个枚举值添加了一个chineseName成员变量，并在构造函数中初始化它。然后，我们重写了toString方法，使其返回chineseName。

现在，如果我们打印一个星期几的枚举值，例如System.out.println(DayOfWeek.MONDAY)，输出将会是星期一。

进一步优化

上面的示例中，我们为每个枚举值都添加了一个chineseName成员变量，并在构造函数中初始化它。这种方式虽然简单，但在维护枚举值时可能会变得冗长。为了更好地组织代码，我们可以将重写toString方法的逻辑放在一个接口中，并让每个枚举值实现该接口。

以下是优化后的DayOfWeek示例：

public interface Printable {
    String toString();
}

public enum DayOfWeek implements Printable {
    MONDAY("星期一"),
    TUESDAY("星期二"),
    WEDNESDAY("星期三"),
    THURSDAY("星期四"),
    FRIDAY("星期五"),
    SATURDAY("星期六"),
    SUNDAY("星期日");

    private String chineseName;

    private DayOfWeek(String chineseName) {
        this.chineseName = chineseName;
    }

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

这样，我们只需要在每个枚举值上实现Printable接口，并提供自己的toString方法即可。