Java stream sorted使用 Comparator 進行多欄位排序

摘要：介紹使用Java Stream流排序器Comparator對List集合進行多欄位排序的方法，包括複雜實體物件多欄位升降序排序方法。

綜述

工作中，一般使用SQL中的order by進行排序，但有時候在Java程式碼中進行排序，例如合併多個list物件的資料後，以年齡降序排列，這顯然是無法通過SQL語句搞定的，而一般的氣泡排序、希爾排序等需要手寫實現，容易出錯，而且程式碼量大，測試工作量自然不容小覷。這時，就需要搬出Stream sort方法進行排序，重寫其中的Comparator。

重寫類的Comparable介面

重寫compareTo方法實現排序，即流中泛型元素需實現Comparable介面

import lombok.*;

@Data
public class Student implements Comparable<Student> {
    private int id;
    private String name;
    private int age;
    @Override
    public int compareTo(Student ob) {
        return name.compareTo(ob.getName());
    }
    @Override
    public boolean equals(final Object obj) {
        if (obj == null) {
            return false;
        }
        final Student std = (Student) obj;
        if (this == std) {
            return true;
        } else {
            return (this.name.equals(std.name) && (this.age == std.age));
        }
    }
    @Override
    public int hashCode() {
        int hashno = 7;
        hashno = 13 * hashno + (name == null ? 0 : name.hashCode());
        return hashno;
    }   
}

缺點是所有類都會使用這個排序規則，不適用於排序規則靈活多變的複雜業務場景。

2 使用Comparator排序

使用stream的sorted(Comparator com)基於自定義規則排序，這需要自定義Comparator排序器。

自然排序

sorted排序結果預設升序排序：

list = list.stream().sorted().collect(Collectors.toList());

下面是根據年齡升序排序的範例：

list = list.stream().sorted(Comparator.comparing(Student::getAge))
.collect(Collectors.toList());

如果想實現降序排列，可以使用Comparator 提供的reverseOrder() 方法

list = list.stream().sorted(Comparator.reverseOrder()).collect(Collectors.toList());

下面是根據年齡降序排列的範例：

list = list.stream().sorted(Comparator.comparing(Student::getAge).reversed())
.collect(Collectors.toList());

像Integer、Long等這些基本型別的包裝類已經實現了Comparable介面，在使用sorted的時候，可以使用comparingInt、thenComparingInt、thenComparingLong等。

多欄位排序

物件集合以類屬性一升序、屬性二升序排序：

Comparator<類> comparator = Comparator.comparing(類::屬性一).thenComparing(類::屬性二);
  
list=list.stream().sorted(comparator).collect(Collectors.toList());

例如，先按學生姓名升序，姓名相同時則按年齡升序。

List<Student> sortedList=list.sorted(Comparator.comparing(Student::getName).thenComparing(Student::getAge))
.collect(Collectors.toList());
sortedList.stream().forEach(System.out::println);

升序結果以屬性一降序，屬性二升序排列：

Comparator<類> comparator = Comparator.comparing(類::屬性一,Comparator.reverseOrder()).thenComparing(類::屬性二);
  
list=list.stream().sorted(comparator).collect(Collectors.toList());

這裡自定義了一個比較器物件，修改物件排序規則即可。如果某個屬性需要降序，則在comparing中宣告Comparator.reverseOrder()，例如：

Comparator<Student> comparator = Comparator.comparing(Student::getName, Comparator.reverseOrder()).thenComparing(Student::getAge)
list=list.sorted(comparator).collect(Collectors.toList());

當然了，也可以把Comparator.reverseOrder()放到屬性二的位置，此時表示以屬性一升序、屬性二降序排列：

list=list.stream().sorted(Comparator.comparing(類::屬性一).thenComparing(類::屬性二,Comparator.reverseOrder()))
  .collect(Collectors.toList());

注意事項

sorted()方法返回的結果集是一個新的物件，和被排序物件的參照不一樣。

1、降序排列時，只需要在 comparator 末尾寫一個 reversed()，不需要每個比較屬性都寫

Comparator<類> comparator1 =
 Comparator.comparing(類::屬性一).thenComparing(類::屬性二).reversed();

但是，不建議這樣寫，推薦如下語意更清晰的語法糖：

Comparator<類> comparator1 = Comparator.comparing(類::屬性一, Comparator.reverseOrder()).thenComparing(類::屬性二, Comparator.reverseOrder())

2、構建比較器時如果分兩行，不能寫成下列形式，否則會排序不正確

Comparator<類> comparator2 = Comparator.comparing(類::屬性一);
comparator2.thenComparing(類::屬性二);

可以寫成

Comparator<類> comparator2 = Comparator.comparing(類::屬性一);
comparator2 = comparator2.thenComparing(類::屬性二);

Reference

https://blog.csdn.net/weixin_48212105/article/details/126175816