Java 枚举的 valueOf() 方法与 Stream API 查找枚举对象

文章目录

- 一、枚举类型概述
- 二、valueOf() 方法详解
- - 1. 什么是 valueOf() 方法？
  - 2. 使用示例
- 三、使用 Stream API 查找枚举对象
- - 1. 使用 Stream 查找枚举对象
  - 2. 使用 Stream 统计枚举对象
- 四、总结
- - 推荐阅读文章

在 Java 中，枚举（enum）是一种特殊的类，用于表示一组常量。它不仅使代码更具可读性，还提供了类型安全性。Java 枚举还带有一些有用的方法，其中最常用的之一是 valueOf() 方法。此外，结合 Java 8 引入的 Stream API，我们可以轻松地处理枚举。本文将深入探讨 valueOf() 方法的使用以及如何通过 Stream API 查找枚举对象。

一、枚举类型概述

枚举类型是用 enum 关键字定义的，表示一组固定的常量。例如，表示一个星期的枚举类型：

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

二、valueOf() 方法详解

1. 什么是 valueOf() 方法？

valueOf() 是枚举类的一个静态方法，允许我们根据指定的字符串返回对应的枚举常量。这个方法的签名如下：

public static T valueOf(String name)

其中，T 是枚举类型的名称，name 是枚举常量的名称（必须完全匹配，区分大小写）。

2. 使用示例

让我们看看如何使用 valueOf() 方法：

public class EnumExample {
    public static void main(String[] args) {
        // 获取枚举常量
        Day day = Day.valueOf("MONDAY");
        System.out.println("Selected day: " + day); // 输出: Selected day: MONDAY

        // 处理无效的输入
        try {
            Day invalidDay = Day.valueOf("FUNDAY"); // 这将抛出 IllegalArgumentException
        } catch (IllegalArgumentException e) {
            System.out.println("Error: " + e.getMessage()); // 输出: Error: No enum constant Day.FUNDAY
        }
    }
}

在上述代码中，我们成功获取了 MONDAY 枚举常量。如果尝试使用无效的常量名，如 FUNDAY，将会抛出 IllegalArgumentException。

三、使用 Stream API 查找枚举对象

Java 8 引入的 Stream API 使得操作集合更加简单高效。对于枚举类型，我们可以使用 Stream API 来查找、过滤和处理枚举常量。

1. 使用 Stream 查找枚举对象

假设我们想要查找所有工作日（MONDAY 到 FRIDAY）的枚举常量，可以使用 Stream 来实现：

import java.util.Arrays;

public class EnumStreamExample {
    public static void main(String[] args) {
        // 查找工作日
        Day[] workdays = Arrays.stream(Day.values())
                .filter(day -> day != Day.SATURDAY && day != Day.SUNDAY)
                .toArray(Day[]::new);

        System.out.println("Workdays: " + Arrays.toString(workdays)); // 输出: Workdays: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY]
    }
}

在这个例子中，我们使用 Day.values() 方法获取所有的枚举常量，然后通过 Stream 进行过滤，只保留工作日。

2. 使用 Stream 统计枚举对象

除了查找，我们还可以使用 Stream 来统计枚举对象的数量，例如计算一周中的天数：

public class EnumCountExample {
    public static void main(String[] args) {
        long totalDays = Arrays.stream(Day.values()).count();
        System.out.println("Total days in a week: " + totalDays); // 输出: Total days in a week: 7
    }
}

但是如果是枚举值的话，推荐还是使用 valueOf() 进行枚举查询(通常用)。

实际中的一个案例演示

    @Override
    public WeaResult<Map<String, Object>> customAction(Map<String, Object> params) {
        EsbActionFlag esbActionFlag = Arrays.stream(EsbActionFlag.values())
                .filter(e -> e.name().equals(Optional.ofNullable(params.get("esbActionFlag")).map(Object::toString).orElse(null)))
                .findFirst()
                .orElse(null);
        Assert.notNull(esbActionFlag, SystemEnv.getHtmlLabelName(272064,"请确认动作流必传参数(esbActionFlag)是否传递正确"));
        return WeaResult.success(esbActionHandleBeanFactory.getEsbActionHandleBean(esbActionFlag).doAction(params));
    }

通过 valueOf() 方法直接简化成一行代码，如下：

    @Override
    public WeaResult<Map<String, Object>> customAction(Map<String, Object> params) {
        EsbActionFlag esbActionFlag = EsbActionFlag.valueOf(String.valueOf(params.get("esbActionFlag")));
        Assert.notNull(esbActionFlag, SystemEnv.getHtmlLabelName(272064,"请确认动作流必传参数(esbActionFlag)是否传递正确"));
        return WeaResult.success(esbActionHandleBeanFactory.getEsbActionHandleBean(esbActionFlag).doAction(params));
    }