Java 進階使用 Lambda 表達式實現(xiàn)超強的排序功能

更新時間：2021年11月11日 09:49:35 作者：看山

今天要說的是第二種排序方式，在內(nèi)存中實現(xiàn)數(shù)據(jù)排序。這篇文章主要介紹了Java 進階使用 Lambda 表達式實現(xiàn)超強的排序功能,需要的朋友可以參考下

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student {
    private String name;
    private int age;

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Student student = (Student) o;
        return age == student.age && Objects.equals(name, student.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }
}

基于Comparator排序

在 Java8 之前，我們都是通過實現(xiàn)Comparator接口完成排序，比如：

new Comparator<Student>() {
    @Override
    public int compare(Student h1, Student h2) {
        return h1.getName().compareTo(h2.getName());
    }
};

這里展示的是匿名內(nèi)部類的定義，如果是通用的對比邏輯，可以直接定義一個實現(xiàn)類。使用起來也比較簡單，如下就是應用：

@Test
void baseSortedOrigin() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    Collections.sort(students, new Comparator<Student>() {
        @Override
        public int compare(Student h1, Student h2) {
            return h1.getName().compareTo(h2.getName());
        }
    });
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

這里使用了 Junit5 實現(xiàn)單元測試，用來驗證邏輯非常適合。

因為定義的Comparator是使用name字段排序，在 Java 中，String類型的排序是通過單字符的 ASCII 碼順序判斷的，J排在T的前面，所以Jerry排在第一個。

使用 Lambda 表達式替換Comparator匿名內(nèi)部類

使用過 Java8 的 Lamdba 的應該知道，匿名內(nèi)部類可以簡化為 Lambda 表達式為：

Collections.sort(students, (Student h1, Student h2) -> h1.getName().compareTo(h2.getName()));

在 Java8 中，List類中增加了sort方法，所以Collections.sort可以直接替換為：

students.sort((Student h1, Student h2) -> h1.getName().compareTo(h2.getName()));

根據(jù) Java8 中 Lambda 的類型推斷，我們可以將指定的Student類型簡寫：

students.sort((h1, h2) -> h1.getName().compareTo(h2.getName()));

至此，我們整段排序邏輯可以簡化為：

@Test
void baseSortedLambdaWithInferring() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    students.sort((h1, h2) -> h1.getName().compareTo(h2.getName()));
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

通過靜態(tài)方法抽取公共的 Lambda 表達式

我們可以在Student中定義一個靜態(tài)方法：

public static int compareByNameThenAge(Student s1, Student s2) {
    if (s1.name.equals(s2.name)) {
        return Integer.compare(s1.age, s2.age);
    } else {
        return s1.name.compareTo(s2.name);
    }
}

這個方法需要返回一個int類型參數(shù)，在 Java8 中，我們可以在 Lambda 中使用該方法：

@Test
void sortedUsingStaticMethod() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    students.sort(Student::compareByNameThenAge);
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

借助Comparator的comparing方法

在 Java8 中，Comparator類新增了comparing方法，可以將傳遞的Function參數(shù)作為比較元素，比如：

@Test
void sortedUsingComparator() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    students.sort(Comparator.comparing(Student::getName));
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

多條件排序

我們在靜態(tài)方法一節(jié)中展示了多條件排序，還可以在Comparator匿名內(nèi)部類中實現(xiàn)多條件邏輯：

@Test
void sortedMultiCondition() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12),
            new Student("Jerry", 13)
    );
    students.sort((s1, s2) -> {
        if (s1.getName().equals(s2.getName())) {
            return Integer.compare(s1.getAge(), s2.getAge());
        } else {
            return s1.getName().compareTo(s2.getName());
        }
    });
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

從邏輯來看，多條件排序就是先判斷第一級條件，如果相等，再判斷第二級條件，依次類推。在 Java8 中可以使用comparing和一系列thenComparing表示多級條件判斷，上面的邏輯可以簡化為：

@Test
void sortedMultiConditionUsingComparator() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12),
            new Student("Jerry", 13)
    );
    students.sort(Comparator.comparing(Student::getName).thenComparing(Student::getAge));
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

這里的thenComparing方法是可以有多個的，用于表示多級條件判斷，這也是函數(shù)式編程的方便之處。

在Stream中進行排序

Java8 中，不但引入了 Lambda 表達式，還引入了一個全新的流式 API：Stream API，其中也有sorted方法用于流式計算時排序元素，可以傳入Comparator實現(xiàn)排序邏輯：

@Test
void streamSorted() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    final Comparator<Student> comparator = (h1, h2) -> h1.getName().compareTo(h2.getName());
    final List<Student> sortedStudents = students.stream()
            .sorted(comparator)
            .collect(Collectors.toList());
    Assertions.assertEquals(sortedStudents.get(0), new Student("Jerry", 12));
}

同樣的，我們可以通過 Lambda 簡化書寫：

@Test
void streamSortedUsingComparator() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    final Comparator<Student> comparator = Comparator.comparing(Student::getName);
    final List<Student> sortedStudents = students.stream()
            .sorted(comparator)
            .collect(Collectors.toList());
    Assertions.assertEquals(sortedStudents.get(0), new Student("Jerry", 12));
}

倒序排列

調(diào)轉(zhuǎn)排序判斷

排序就是根據(jù)compareTo方法返回的值判斷順序，如果想要倒序排列，只要將返回值取返即可：

@Test
void sortedReverseUsingComparator2() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    final Comparator<Student> comparator = (h1, h2) -> h2.getName().compareTo(h1.getName());
    students.sort(comparator);
    Assertions.assertEquals(students.get(0), new Student("Tom", 10));
}

可以看到，正序排列的時候，我們是h1.getName().compareTo(h2.getName())，這里我們直接倒轉(zhuǎn)過來，使用的是h2.getName().compareTo(h1.getName())，也就達到了取反的效果。在 Java 的Collections中定義了一個java.util.Collections.ReverseComparator內(nèi)部私有類，就是通過這種方式實現(xiàn)元素反轉(zhuǎn)。

借助Comparator的reversed方法倒序

在 Java8 中新增了reversed方法實現(xiàn)倒序排列，用起來也是很簡單：

@Test
void sortedReverseUsingComparator() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    final Comparator<Student> comparator = (h1, h2) -> h1.getName().compareTo(h2.getName());
    students.sort(comparator.reversed());
    Assertions.assertEquals(students.get(0), new Student("Tom", 10));
}

在Comparator.comparing中定義排序反轉(zhuǎn)

comparing方法還有一個重載方法，java.util.Comparator#comparing(java.util.function.Function<? super T,? extends U>, java.util.Comparator<? super U>)，第二個參數(shù)就可以傳入Comparator.reverseOrder()，可以實現(xiàn)倒序：

@Test
void sortedUsingComparatorReverse() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    students.sort(Comparator.comparing(Student::getName, Comparator.reverseOrder()));
    Assertions.assertEquals(students.get(0), new Student("Jerry", 12));
}

在Stream中定義排序反轉(zhuǎn)

在Stream中的操作與直接列表排序類似，可以反轉(zhuǎn)Comparator定義，也可以使用Comparator.reverseOrder()反轉(zhuǎn)。實現(xiàn)如下：

@Test
void streamReverseSorted() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    final Comparator<Student> comparator = (h1, h2) -> h2.getName().compareTo(h1.getName());
    final List<Student> sortedStudents = students.stream()
            .sorted(comparator)
            .collect(Collectors.toList());
    Assertions.assertEquals(sortedStudents.get(0), new Student("Tom", 10));
}

@Test
void streamReverseSortedUsingComparator() {
    final List<Student> students = Lists.newArrayList(
            new Student("Tom", 10),
            new Student("Jerry", 12)
    );
    final List<Student> sortedStudents = students.stream()
            .sorted(Comparator.comparing(Student::getName, Comparator.reverseOrder()))
            .collect(Collectors.toList());
    Assertions.assertEquals(sortedStudents.get(0), new Student("Tom", 10));
}

null 值的判斷

前面的例子中都是有值元素排序，能夠覆蓋大部分場景，但有時候我們還是會碰到元素中存在null的情況：

列表中的元素是 null
列表中的元素參與排序條件的字段是 null

如果還是使用前面的那些實現(xiàn)，我們會碰到NullPointException異常，即 NPE，簡單演示一下：

@Test
void sortedNullGotNPE() {
    final List<Student> students = Lists.newArrayList(
            null,
            new Student("Snoopy", 12),
            null
    );
    Assertions.assertThrows(NullPointerException.class,
            () -> students.sort(Comparator.comparing(Student::getName)));
}

所以，我們需要考慮這些場景。

元素是 null 的笨拙實現(xiàn)

最先想到的就是判空：

@Test
void sortedNullNoNPE() {
    final List<Student> students = Lists.newArrayList(
            null,
            new Student("Snoopy", 12),
            null
    );
    students.sort((s1, s2) -> {
        if (s1 == null) {
            return s2 == null ? 0 : 1;
        } else if (s2 == null) {
            return -1;
        }
        return s1.getName().compareTo(s2.getName());
    });

    Assertions.assertNotNull(students.get(0));
    Assertions.assertNull(students.get(1));
    Assertions.assertNull(students.get(2));
}

我們可以將判空的邏輯抽取出一個Comparator，通過組合方式實現(xiàn)：

class NullComparator<T> implements Comparator<T> {
    private final Comparator<T> real;

    NullComparator(Comparator<? super T> real) {
        this.real = (Comparator<T>) real;
    }

    @Override
    public int compare(T a, T b) {
        if (a == null) {
            return (b == null) ? 0 : 1;
        } else if (b == null) {
            return -1;
        } else {
            return (real == null) ? 0 : real.compare(a, b);
        }
    }
}

在 Java8 中已經(jīng)為我們準備了這個實現(xiàn)。

使用Comparator.nullsLast和Comparator.nullsFirst

使用Comparator.nullsLast實現(xiàn)null在結(jié)尾：

@Test
void sortedNullLast() {
    final List<Student> students = Lists.newArrayList(
            null,
            new Student("Snoopy", 12),
            null
    );
    students.sort(Comparator.nullsLast(Comparator.comparing(Student::getName)));
    Assertions.assertNotNull(students.get(0));
    Assertions.assertNull(students.get(1));
    Assertions.assertNull(students.get(2));
}

使用Comparator.nullsFirst實現(xiàn)null在開頭：

@Test
void sortedNullFirst() {
    final List<Student> students = Lists.newArrayList(
            null,
            new Student("Snoopy", 12),
            null
    );
    students.sort(Comparator.nullsFirst(Comparator.comparing(Student::getName)));
    Assertions.assertNull(students.get(0));
    Assertions.assertNull(students.get(1));
    Assertions.assertNotNull(students.get(2));
}

是不是很簡單，接下來我們看下如何實現(xiàn)排序條件的字段是 null 的邏輯。

排序條件的字段是 null

這個就是借助Comparator的組合了，就像是套娃實現(xiàn)了，需要使用兩次Comparator.nullsLast，這里列出實現(xiàn)：

@Test
void sortedNullFieldLast() {
    final List<Student> students = Lists.newArrayList(
            new Student(null, 10),
            new Student("Snoopy", 12),
            null
    );
    final Comparator<Student> nullsLast = Comparator.nullsLast(
            Comparator.nullsLast( // 1
                    Comparator.comparing(
                            Student::getName,
                            Comparator.nullsLast( // 2
                                    Comparator.naturalOrder() // 3
                            )
                    )
            )
    );
    students.sort(nullsLast);
    Assertions.assertEquals(students.get(0), new Student("Snoopy", 12));
    Assertions.assertEquals(students.get(1), new Student(null, 10));
    Assertions.assertNull(students.get(2));
}

代碼邏輯如下：

代碼 1 是第一層 null-safe 邏輯，用于判斷元素是否為 null；
代碼 2 是第二層 null-safe 邏輯，用于判斷元素的條件字段是否為 null；
代碼 3 是條件Comparator，這里使用了Comparator.naturalOrder()，是因為使用了String排序，也可以寫為String::compareTo。如果是復雜判斷，可以定義一個更加復雜的Comparator，組合模式就是這么好用，一層不夠再套一層。