java 枚举返回key

原创

mob649e81664bd9 2024-08-23 06:00:18 ©著作权

文章标签 枚举类 System Java 文章分类 Java 后端开发

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

Java 枚举与返回 Key 的实现指南

引言

Java 枚举是一种特殊的 Java 类型，表示一组常量。使用枚举可以提高代码的可读性和维护性。在实际开发中，可能会有需求需要根据某个值返回对应的键（或名称）。本文将指导你如何实现这一功能。

流程概述

我们可以将整个实现过程分为几个主要步骤。以下是一个简要的步骤表格：

步骤	描述
1	创建一个枚举类
2	在枚举类中定义常量及其对应的值
3	实现一个方法，根据值返回键
4	测试枚举类的功能

接下来，我们将详细讲解每一步的实现。

步骤 1: 创建一个枚举类

首先，我们将创建一个枚举类。假设我们需要表示交通信号灯的状态：红灯、黄灯和绿灯。

public enum TrafficLight {
    RED(1),    // 红灯，值为 1
    YELLOW(2), // 黄灯，值为 2
    GREEN(3);  // 绿灯，值为 3

    private int value; // 成员变量，存储每个枚举值的对应整型值

    // 构造函数
    TrafficLight(int value) {
        this.value = value;
    }

    // 获取值的方法
    public int getValue() {
        return value;
    }

    // 通过值获取枚举的键
    public static TrafficLight fromValue(int value) {
        for (TrafficLight light : TrafficLight.values()) {
            if (light.getValue() == value) {
                return light;
            }
        }
        throw new IllegalArgumentException("Invalid value: " + value);
    }
}

步骤 2: 定义常量及其对应值

在上述代码中，我们创建了一个名为 TrafficLight 的枚举类，其中定义了三个常量：RED，YELLOW 和 GREEN。每个常量都与一个整数值相对应。我们还为这个枚举添加了一个私有变量 value，用以存储这些值，并在构造方法中对其进行初始化。

步骤 3: 实现方法返回枚举的键

在代码中，我们实现了一个 fromValue(int value) 方法，通过传入一个整数值来查找并返回对应的枚举实例。如果值不匹配任何枚举常量，我们抛出一个 IllegalArgumentException 异常，以便调用者能得知输入值的错误。

步骤 4: 测试枚举类的功能

现在我们需要验证我们的 TrafficLight 枚举是否按预期工作。我们可以创建一个简单的测试类：

public class TrafficLightTest {
    public static void main(String[] args) {
        try {
            // 测试正确值
            System.out.println(TrafficLight.fromValue(1)); // 输出: RED
            System.out.println(TrafficLight.fromValue(2)); // 输出: YELLOW
            System.out.println(TrafficLight.fromValue(3)); // 输出: GREEN
            
            // 测试错误值
            System.out.println(TrafficLight.fromValue(4)); // 抛出异常
        } catch (IllegalArgumentException e) {
            System.err.println(e.getMessage());
        }
    }
}

在这个测试类中，我们调用了 fromValue 方法并打印返回的结果。当我们输入有效的值时，程序会正常输出对应的枚举名称。当输入无效值时，捕获到的异常会打印出提示信息。

类图

为了进一步帮助大家理解，我们可以使用 Mermaid 语法来表示这个枚举的类图：

classDiagram
    class TrafficLight {
        +int value
        +TrafficLight(int value)
        +int getValue()
        +static TrafficLight fromValue(int value)
    }
    TrafficLight <|-- RED : 1
    TrafficLight <|-- YELLOW : 2
    TrafficLight <|-- GREEN : 3