如何在 Java 中按字母顺序对枚举成员进行排序？

Question

我有一个如下所示的枚举类：

public enum Letter {
    OMEGA_LETTER("Omega"),
    GAMMA_LETTER("Gamma"),
    BETA_LETTER("Beta"),
    ALPHA_LETTER("Alpha");
    
    private final String description;
    
    Letter() {
        description = toString();
    }
        
    Letter(String description) {
        this.description = description;
    }
    
    public String getDescription() {
        return description;
    }
}

稍后在我的代码中，我基本上迭代 Letter 枚举并将其成员打印到控制台：

for (Letter letter : Letter.values()) {
    System.out.println(letter.getDescription());
}

我认为 values() 方法会给我一个枚举的有序视图（如此处所述） ，但事实并非如此。我只是按照我在 Letter 枚举类中创建枚举成员的顺序获取枚举成员。

有没有办法按字母顺序输出枚举的值？我是否需要一个单独的 Comparator 对象，或者是否有内置方法可以做到这一点？基本上我希望根据 getDescription() 文本按字母顺序对值进行排序：

Alpha
Beta
Gamma
Omega

Answer 1

SortedMap<String, Letter> map = new TreeMap<String, Letter>();
for (Letter l : Letter.values()) {
    map.put(l.getDescription, l);
}
return map.values();

或者只是重新排序声明:-)

编辑：正如 KLE 指出的，这假设描述在枚举中是唯一的。

Answer 2

我认为values()方法会给我一个枚举的有序视图（如此处提到的），但这里的情况并非如此。我只是按照我在 Letter 枚举类中创建枚举成员的顺序获取枚举成员。

准确地说，声明的顺序对于枚举来说很重要，因此我们很高兴它们完全按照该顺序返回。例如，当 int i 表示枚举值时，执行 values()[i] 是查找枚举实例的非常简单且有效的方法。相反，ordinal() 方法返回枚举实例的索引。

有没有办法按字母顺序输出枚举的值？我是否需要一个单独的比较器对象，或者是否有内置的方法可以做到这一点？基本上我希望根据 getDescription() 文本按字母顺序对值进行排序：

您所说的 value 并不是一般为枚举定义的东西。这里，在您的上下文中，您指的是 getDescription() 的结果。

正如您所说，您可以为这些描述创建一个比较器。这将是完美的:-)

---

请注意，一般来说，您可能需要这些实例的多个订单：

• 声明订单（这是官方订单）
• 描述订单
• 根据需要其他

---

订单您还可以推动 DescriptionComparator 的概念一点点：

1. 出于性能原因，您可以存储计算的描述。

2. 因为枚举不能继承，所以代码重用必须在枚举类之外。让我举一个我们将在项目中使用的示例：

现在是代码示例...

/** Interface for enums that have a description. */
public interface Described {
  /** Returns the description. */
  String getDescription();
}

public enum Letter implements Described {
  // .... implementation as in the original post, 
  // as the method is already implemented
}

public enum Other implements Described {
  // .... same
}

/** Utilities for enums. */
public abstract class EnumUtils {

  /** Reusable Comparator instance for Described objects. */
  public static Comparator<Described> DESCRIPTION_COMPARATOR = 
    new Comparator<Described>() {
      public int compareTo(Described a, Described b) {
        return a.getDescription().compareTo(b.getDescription);
      }
    };

  /** Return the sorted descriptions for the enum. */
  public static <E extends Enum & Described> List<String> 
    getSortedDescriptions(Class<E> enumClass) {
      List<String> descriptions = new ArrayList<String>();
      for(E e : enumClass.getEnumConstants()) {
        result.add(e.getDescription());
      }
      Collections.sort(descriptions);
      return descriptions;
  }
}

// caller code
List<String> letters = EnumUtils.getSortedDescriptions(Letter.class);
List<String> others = EnumUtils.getSortedDescriptions(Other.class);

请注意，EnumUtils 中的通用代码不仅适用于一个枚举类，而且适用于任何枚举类在实现Described接口的项目中。

如前所述，将代码放在枚举之外（本来应该属于的位置）的目的是重用代码。对于两个枚举来说这没什么大不了的，但是我们的项目中有超过一千个枚举，其中许多具有相同的接口......！

Answer 3

只需使用 Arrays.sort 和您自己的比较器对它们进行排序即可。

Answer 4

您可以在java8中使用带比较器的排序函数

enumlist.stream()
.sorted(Comparator.comparing(Enum::toString)).collect(Collectors.toList());

Answer 5

这是一种对任何类执行此操作的通用方法，无需在要排序的类上实现 Comparable 或创建自定义比较器。我发现在某些情况下我不想覆盖compareTo，因为它有不同的目的，无论如何你都不能用于枚举，并且不断创建包装类是一种痛苦。您可以传入一个函数，该函数输出您想要用于排序目的的 Comparable 对象。

toComparable 函数仅对列表中的每个元素调用一次（对于自定义比较器则不然），因此如果该调用对于某些类来说成本较高，则特别好。空值在内部处理，因此它比自定义比较器更容易使用。对 Java 7 的 TimSort 算法的一次调用比对 SortedMap（红黑树或其他平衡树实现）进行一堆 O(log N) 插入要高效得多。而且您不限于任何特定的类或接口。

在许多情况下，现实世界的性能提升是显着的。例如，在大小为 100k 的列表上使用 toString() 对 Double 进行排序时，性能提升大约是使用比较器的 5 倍。

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;

public class GenericLetterSorter {
    public enum Letter {
        OMEGA_LETTER("Omega"), 
        GAMMA_LETTER("Gamma"), 
        BETA_LETTER("Beta"), 
        ALPHA_LETTER("Alpha"); 

        private final String description;

        Letter() {
          description = toString();
        }

        Letter(String description) {
          this.description = description;
        }

        public String getDescription() {
          return description;
        }
    }

public static void main(String[] args) {
    List<Letter> list = new ArrayList<>(Arrays.asList(Letter.values()));

    sort(list, new ToComparable<Letter>() {
        @Override
        public Comparable toComparable(Letter letter) {
            // sort based on the letter's description
            return letter == null ? null : letter.getDescription();
        }
    });

    for (Letter letter : list)
        System.out.println(letter == null ? null : letter.name());
}

    public interface ToComparable<T, C extends Comparable<? super C>> {
         C toComparable(T t);
    }

    public static <T, C extends Comparable<? super C>> void sort(List<T> list, ToComparable<T, C> function) {
       class Pair implements Comparable<Pair> {
          final T original;
          final C comparable;

          Pair(T original, C comparable) {
             this.original = original;
             this.comparable = comparable;
          }

          @Override
          public int compareTo(Pair other) {
                return
                  comparable == null && other.comparable == null ? 0 :
                  comparable == null ? -1 :
                  other.comparable == null ? 1 :
                  comparable.compareTo(other.comparable);
          }
       }

       List<Pair> pairs = new ArrayList<>(list.size());
       for (T original : list)
          pairs.add(new Pair(original, function.toComparable(original)));

       Collections.sort(pairs);

       ListIterator<T> iter = list.listIterator();
       for (Pair pair : pairs) {
          iter.next();
          iter.set(pair.original);
       }
    }
}