摘要：介紹使用Java Stream流排序器Comparator對List集合進行多字段排序的方法，包括復雜實體對象多字段升降序混合排序方法。

綜述

??Java 8 的 Stream 使用了函數式編程模式，人如其名，它可以被用來對集合或數組進行鏈狀流式的排序、過濾和統計等操作，從而讓我們更方便的對集合或數組進行操作。

??關于List排序，工作中，一般使用SQL中的order by進行排序，但有時候使用Java代碼進行排序，例如合并多個list對象的數據后，以年齡降序排列，這顯然是無法通過SQL語句搞定的，而一般的冒泡排序、希爾排序等需要手寫實現，容易出錯，而且代碼量大，測試工作量自然不容小覷。這時，就需要搬出Stream sort方法進行排序，重寫其中的Comparator。

??本文重點介紹使用Java Stream流排序器Comparator對List集合進行排序的技巧，包括復雜實體對象多字段升降序排序方法。

重寫類的Comparable接口

??重寫List中泛型Bean的compareTo方法實現排序，即流中泛型元素需實現Comparable接口，實現如下：

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

import java.io.Serializable;

/**
 * 用戶實體
 */
@Getter
@Setter
@ToString
public class UserDTO implements Serializable, Comparable<UserDTO> {

    private static final long serialVersionUID = -2618535482684811077L;
    /**
     * 用戶id
     */
    private Long id;

    /**
     * 姓名
     */
    private String name;
    /**
     * 年齡
     */
    private Integer age;

    /**
     * 是否男士，true 是
     */
    private Boolean isBoy;
    /**
     * 無參構造器
     */
    public UserDTO() {
        System.out.println("無參構造器");
    }

    private UserDTO(String userName) {
        this.name = userName;
        System.out.println("一個參數的構造器，private");
    }

    public UserDTO(Long id, String userName, Integer age) {
        this.id = id;
        this.name = userName;
        this.age = age;
    }
    public UserDTO(Long id, String userName, Integer age,  Boolean isBoy) {
        this.id = id;
        this.name = userName;
        this.age = age;
        this.isBoy = isBoy;
    }

    @Override
    public int compareTo(UserDTO o) {
        return id.compareTo(o.getId());
    }
}

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

使用Comparator排序

??使用stream的sorted(Comparator com)基于自定義規則排序，這需要為comparing 和thenComparing自定義Comparator排序器，以實現升序或者降序。接下來進行案例分析的時候，默認UserDTO沒有重寫類的Comparable接口。

sorted comparing 自然排序

??sorted 排序結果默認升序排序，它根據comparing來實現。語法糖：

// 從類型T中提取Comparable排序屬性，并返回該屬性的比較器Comparator<T> 
static <T,U extends Comparable<? super U>> Comparator<T> comparing(Function<? super T,? extends U> keyExtractor) 

// 從T類型對象提取U類型的排序字段，并返回一個根據此排序字段Comparator<T> 
static <T,U> Comparator<T> comparing(Function<? super T,? extends U> keyExtractor, Comparator<? super U> keyComparator) 

?? Function 是一個函數接口，包含一種 apply()方法，來實現方法調用。參數Function<? super T, ? extends U> keyExtractor表示輸入一個 T 類型形參，輸出一個 U 類型的對象。舉個例子，輸入一個 UserDTO 對象返回其Integer類型屬性年齡（age）的數值：

Function<UserDTO, Integer> getUserAge = UserDTO::getAge;

使用默認屬性排序：

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

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

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

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

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

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

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

or

list = list.stream().sorted(Comparator.comparing(UserDTO::getAge, Comparator.reverseOrder()))
.collect(Collectors.toList());

??像Integer、Long等基本類型的包裝類已經實現了Comparable接口，在使用sorted排序的時候，可以使用comparingInt、thenComparingInt、thenComparingLong等。

thenComparing 多字段排序

??在多于一個屬性排序的場景，可以結合 comparing 和 thenComparing進行解決——先使用comparing進行比較，再使用一個或者多個thenComparing進行排序。語法糖：

//用另一個比較器 other 返回一個字典順序排序比較器
default Comparator<T> thenComparing(Comparator<? super T> other) 
// 返回指定屬性的 Comparable順序比較器
default <U extends Comparable<? super U>> Comparator<T> thenComparing(Function<? super T,? extends U> keyExtractor) 
// 返回一個根據T對象U類型字段字段排序的Comparator
default <U> Comparator<T> thenComparing(Function<? super T,? extends U> keyExtractor, Comparator<? super U> keyComparator) 

??案例1：集合以泛型類的屬性一升序、屬性二升序排序：

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

??案例2：按用戶年齡升序，年齡相同時則按姓名升序：

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

??案例3：排序結果以屬性一降序，屬性二升序排列：

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

??這里自定義了一個比較器對象，修改對象排序規則即可。如果某個屬性需要降序，則在comparing中聲明Comparator.reverseOrder()，例如：

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

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

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

注意事項

??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(類::屬性二);

??3、sorted()方法返回的結果集是一個新的對象，和被排序對象的引用不一樣。

??4、參與排序的類屬性需要注意是否為null。如果為null可以設置一個默認值，或者使用如下方法解決：

//值為null的元素排在前面
Comparator<類> firstComparator = Comparator.nullsFirst(Comparator.comparing(類::屬性一));

//所有的空元素將被排在最后，不影響非空元素排序
Comparator<類> lastComparator = Comparator.nullsLast(Comparator.comparing(類::屬性一));

Reference

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