EnumSet排序机制与自定义方法解析

本文旨在探讨Java中`EnumSet`的元素排序行为，解释其为何不保留创建时的写入顺序，而是遵循枚举常量的自然声明顺序。针对需要特定排序的场景，文章将提供两种主要解决方案：一是通过`List`来简单地保持插入顺序；二是通过结合`TreeSet`与自定义比较器，为枚举集合实现更复杂的逻辑排序。

理解EnumSet的排序特性

EnumSet是Java集合框架中专门为枚举类型设计的Set实现，它在内部以位向量（bit vector）的形式存储元素，效率极高。然而，EnumSet的一个核心特性是它不保证元素的插入顺序。相反，它始终以枚举类型定义时的自然声明顺序来返回其包含的元素。这意味着无论你在EnumSet.of()方法中以何种顺序传入枚举常量，迭代器或forEach循环遍历时，元素都将按照它们在枚举类中声明的顺序出现。

考虑以下枚举定义和EnumSet创建示例：

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

// 示例1：创建EnumSet并观察输出
EnumSet weekend = EnumSet.of(DayOfWeek.SATURDAY, DayOfWeek.FRIDAY);
weekend.forEach(System.out::println);

预期输出将是：

FRIDAY
SATURDAY

这表明EnumSet忽略了of()方法中SATURDAY先于FRIDAY的传入顺序，而是按照DayOfWeek枚举中FRIDAY先于SATURDAY的声明顺序进行输出。

再看一个更明显的例子，如果枚举定义如下：

public enum MyType {
    TYPE_1,
    TYPE_2,
    TYPE_3
}

public static Set getTypes() {
    return EnumSet.of(
            MyType.TYPE_3,
            MyType.TYPE_1,
            MyType.TYPE_2
    );
}

尽管在getTypes()方法中传入的顺序是TYPE_3, TYPE_1, TYPE_2，但当你遍历这个EnumSet时，输出顺序将始终是TYPE_1, TYPE_2, TYPE_3，因为它遵循MyType枚举的声明顺序。

实现自定义排序的策略

当EnumSet的默认自然排序不满足需求时，我们需要考虑其他集合类型或结合自定义逻辑来实现所需的排序。

策略一：使用List保留插入顺序

如果你的核心需求是保留元素被添加时的确切顺序，并且不强制要求使用Set接口（即允许重复元素或不关心Set的唯一性特性），那么List接口是更直接的选择。List的实现（如ArrayList、LinkedList）天然地维护元素的插入顺序。

import java.time.DayOfWeek;
import java.util.List;

public class ListOrderExample {
    public static void main(String[] args) {
        List customOrderDays = List.of(
                DayOfWeek.SATURDAY,
                DayOfWeek.FRIDAY,
                DayOfWeek.THURSDAY
        );

        System.out.println("使用List保留插入顺序:");
        customOrderDays.forEach(System.out::println);
    }
}

输出将严格按照List.of()中定义的顺序：

使用List保留插入顺序:
SATURDAY
FRIDAY
THURSDAY

这种方法简单有效，适用于大多数仅需保持插入顺序的场景。

策略二：结合TreeSet与自定义比较器实现特定排序

如果业务逻辑确实需要Set的唯一性特性，同时又要求按照非自然声明顺序的某种逻辑进行排序，那么可以考虑使用TreeSet并为其提供一个自定义的Comparator。TreeSet是一个有序集合，它根据元素的自然顺序或Comparator来对元素进行排序。

为了实现自定义排序，首先需要在枚举类型中引入一个用于排序的属性。例如，我们为枚举常量定义一个order值：

import java.util.Comparator;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public enum MyEnum {
    ONE(3), TWO(2), THREE(1); // 这里的数字表示我们期望的排序优先级

    private final int order;

    MyEnum(int order) {
        this.order = order;
    }

    public int getOrder() {
        return order;
    }
}

接下来，当我们将这些枚举常量收集到一个TreeSet中时，需要提供一个Comparator，它会根据MyEnum的order属性进行比较：

public class TreeSetCustomOrderExample {
    public static void main(String[] args) {
        Set customOrderedSet = Stream.of(MyEnum.ONE, MyEnum.TWO, MyEnum.THREE)
                .collect(Collectors.toCollection(
                        () -> new TreeSet<>(Comparator.comparing(MyEnum::getOrder)) // 根据order属性进行排序
                ));

        System.out.println("\n使用TreeSet和自定义比较器实现排序:");
        customOrderedSet.forEach(System.out::println);
    }
}

输出将是：

使用TreeSet和自定义比较器实现排序:
THREE
TWO
ONE

这是因为THREE的order值为1，TWO为2，ONE为3，Comparator.comparing(MyEnum::getOrder)会按照order值的升序排列。

注意事项与选择建议

• EnumSet的优势与局限： EnumSet在处理枚举类型集合时性能卓越且内存占用低。如果只需要枚举的自然声明顺序，EnumSet是最佳选择。
• List的适用场景： 当你需要精确地保持元素被添加时的顺序，且不介意集合中可能存在重复元素时，List是更简单直接的解决方案。
• TreeSet的适用场景： 当你既需要Set的唯一性，又需要根据枚举类型中某个特定属性（而非自然声明顺序）进行排序时，TreeSet结合自定义Comparator提供了强大的灵活性。但请注意，TreeSet的性能通常低于EnumSet和HashSet，因为它需要维护元素的有序性。
• 性能考量： EnumSet通常比其他Set实现更快。ArrayList和LinkedList在不同操作上各有优劣。TreeSet由于需要进行比较和维护树结构，在添加和查找元素时通常比HashSet慢。在选择集合类型时，应综合考虑性能、内存以及功能需求。

总结

EnumSet作为Java中处理枚举集合的专用工具，其核心特性是根据枚举常量的自然声明顺序进行排序。若要实现不同于此的自定义排序，开发者需要根据具体需求选择合适的集合类型：对于简单的插入顺序保持，List是理想选择；而对于需要在Set中实现基于特定逻辑的排序，则应考虑使用TreeSet并提供一个自定义的Comparator。理解这些集合的排序机制及其适用场景，有助于编写出更高效、更符合业务逻辑的Java代码。