Contents

Java 8 Lambdas的强大比较

1. 概述

在本教程中,我们将首先了解Java 8 中的 Lambda 支持,特别是如何利用它来编写Comparator并对 Collection 进行排序

首先,让我们定义一个简单的实体类:

public class Human {
    private String name;
    private int age;
    // standard constructors, getters/setters, equals and hashcode
}

2. 没有 Lambda 的基本排序

在 Java 8 之前,对集合进行排序需要为排序中使用的Comparator创建一个匿名内部类

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

这将仅用于对Human实体列表进行排序:

@Test
public void givenPreLambda_whenSortingEntitiesByName_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 10),
      new Human("Jack", 12)
    );
    
    Collections.sort(humans, new Comparator<Human>() {
        @Override
        public int compare(Human h1, Human h2) {
            return h1.getName().compareTo(h2.getName());
        }
    });
    Assert.assertThat(humans.get(0), equalTo(new Human("Jack", 12)));
}

3. 支持 Lambda 的基本排序

随着 Lambda 的引入,我们现在可以绕过匿名内部类,并通过简单的函数式语义实现相同的结果:

(final Human h1, final Human h2) -> h1.getName().compareTo(h2.getName());

同样,我们现在可以像以前一样测试行为:

@Test
public void whenSortingEntitiesByName_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 10), 
      new Human("Jack", 12)
    );
    
    humans.sort(
      (Human h1, Human h2) -> h1.getName().compareTo(h2.getName()));
 
    assertThat(humans.get(0), equalTo(new Human("Jack", 12)));
}

请注意,我们还使用了Java 8中添加到java.util.List的新sortAPI, 而不是旧的Collections.sort API。

4. 没有类型定义的基本排序

我们可以通过不指定类型定义来进一步简化表达式;编译器能够自行推断这些

(h1, h2) -> h1.getName().compareTo(h2.getName())

同样,测试仍然非常相似:

@Test
public void 
  givenLambdaShortForm_whenSortingEntitiesByName_thenCorrectlySorted() {
    
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 10), 
      new Human("Jack", 12)
    );
    
    humans.sort((h1, h2) -> h1.getName().compareTo(h2.getName()));
 
    assertThat(humans.get(0), equalTo(new Human("Jack", 12)));
}

5. 使用引用静态方法进行排序

接下来,我们将使用引用静态方法的 Lambda 表达式执行排序。 首先,我们将使用与Comparator<Human>对象中的compare方法 完全相同的签名定义方法compareByNameThenAge

public static int compareByNameThenAge(Human lhs, Human rhs) {
    if (lhs.name.equals(rhs.name)) {
        return Integer.compare(lhs.age, rhs.age);
    } else {
        return lhs.name.compareTo(rhs.name);
    }
}

然后我们将使用这个引用调用human.sort方法:

humans.sort(Human::compareByNameThenAge);

最终结果是使用静态方法作为Comparator对集合进行排序:

@Test
public void 
  givenMethodDefinition_whenSortingEntitiesByNameThenAge_thenCorrectlySorted() {
    
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 10), 
      new Human("Jack", 12)
    );
    
    humans.sort(Human::compareByNameThenAge);
    Assert.assertThat(humans.get(0), equalTo(new Human("Jack", 12)));
}

6. 对提取的比较器进行排序

我们还可以通过使用实例方法引用Comparator.comparing方法来避免定义比较逻辑本身,该方法基于该函数提取并创建一个Comparable

我们将使用*getName()*来构建 Lambda 表达式并按名称对列表进行排序:

@Test
public void 
  givenInstanceMethod_whenSortingEntitiesByName_thenCorrectlySorted() {
    
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 10), 
      new Human("Jack", 12)
    );
    
    Collections.sort(
      humans, Comparator.comparing(Human::getName));
    assertThat(humans.get(0), equalTo(new Human("Jack", 12)));
}

7. 反向排序

JDK 8 还引入了一种用于**反转比较器的辅助方法。**我们可以快速使用它来反转我们的排序:

@Test
public void whenSortingEntitiesByNameReversed_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 10), 
      new Human("Jack", 12)
    );
    
    Comparator<Human> comparator
      = (h1, h2) -> h1.getName().compareTo(h2.getName());
    
    humans.sort(comparator.reversed());
 
    Assert.assertThat(humans.get(0), equalTo(new Human("Sarah", 10)));
}

8. 多条件排序

比较 lambda 表达式不需要这么简单。我们也可以编写**更复杂的表达式,**例如先按名称排序实体,然后按年龄排序:

@Test
public void whenSortingEntitiesByNameThenAge_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 12), 
      new Human("Sarah", 10), 
      new Human("Zack", 12)
    );
    
    humans.sort((lhs, rhs) -> {
        if (lhs.getName().equals(rhs.getName())) {
            return Integer.compare(lhs.getAge(), rhs.getAge());
        } else {
            return lhs.getName().compareTo(rhs.getName());
        }
    });
    Assert.assertThat(humans.get(0), equalTo(new Human("Sarah", 10)));
}

9. 多条件排序

同样的比较逻辑,首先按名称排序,然后按年龄排序,也可以通过Comparator的新组合支持来实现。 从 JDK 8 开始,我们现在可以将多个比较器链接在一起以构建更复杂的比较逻辑:

@Test
public void 
  givenComposition_whenSortingEntitiesByNameThenAge_thenCorrectlySorted() {
    
    List<Human> humans = Lists.newArrayList(
      new Human("Sarah", 12), 
      new Human("Sarah", 10), 
      new Human("Zack", 12)
    );
    humans.sort(
      Comparator.comparing(Human::getName).thenComparing(Human::getAge)
    );
    
    Assert.assertThat(humans.get(0), equalTo(new Human("Sarah", 10)));
}

10. 使用*Stream.sorted()*对列表进行排序

我们还可以使用 Java 8 的Stream.sorted() API 对集合进行排序。 我们可以使用自然排序以及Comparator提供的排序对流进行排序。为此,我们有两个 sorted() API 的重载变体:

  • sorted() – 使用自然排序对Stream 的元素进行 排序;元素类必须实现 Comparable接口。
  • sorted(Comparator<?super T> comparator )  – 根据Comparator实例对元素进行排序

让我们看一个如何**使用自然排序的*sorted()***方法的示例:

@Test
public final void 
  givenStreamNaturalOrdering_whenSortingEntitiesByName_thenCorrectlySorted() {
    List<String> letters = Lists.newArrayList("B", "A", "C");
	
    List<String> sortedLetters = letters.stream().sorted().collect(Collectors.toList());
    assertThat(sortedLetters.get(0), equalTo("A"));
}

现在让我们看看如何将自定义Comparator与 sorted() API一起使用:

@Test
public final void 
  givenStreamCustomOrdering_whenSortingEntitiesByName_thenCorrectlySorted() {	
    List<Human> humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12));
    Comparator<Human> nameComparator = (h1, h2) -> h1.getName().compareTo(h2.getName());
	
    List<Human> sortedHumans = 
      humans.stream().sorted(nameComparator).collect(Collectors.toList());
    assertThat(sortedHumans.get(0), equalTo(new Human("Jack", 12)));
}

如果我们*使用*Comparator.comparing()方法,我们可以进一步简化上面的例子:

@Test
public final void 
  givenStreamComparatorOrdering_whenSortingEntitiesByName_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12));
 
    List<Human> sortedHumans = humans.stream()
      .sorted(Comparator.comparing(Human::getName))
      .collect(Collectors.toList());
      
    assertThat(sortedHumans.get(0), equalTo(new Human("Jack", 12)));
}

11. 使用*Stream.sorted()*对列表进行反向排序

我们还可以使用*Stream.sorted()对集合进行反向排序。 首先,让我们看一个如何将*sorted()方法与Comparator.reverseOrder()*结合起来以逆自然顺序对列表进行排序*的示例:

@Test
public final void 
  givenStreamNaturalOrdering_whenSortingEntitiesByNameReversed_thenCorrectlySorted() {
    List<String> letters = Lists.newArrayList("B", "A", "C");
    List<String> reverseSortedLetters = letters.stream()
      .sorted(Comparator.reverseOrder())
      .collect(Collectors.toList());
      
    assertThat(reverseSortedLetters.get(0), equalTo("C"));
}

现在让我们看看如何使用sorted()方法和自定义Comparator

@Test
public final void 
  givenStreamCustomOrdering_whenSortingEntitiesByNameReversed_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12));
    Comparator<Human> reverseNameComparator = 
      (h1, h2) -> h2.getName().compareTo(h1.getName());
    List<Human> reverseSortedHumans = humans.stream().sorted(reverseNameComparator)
      .collect(Collectors.toList());
    assertThat(reverseSortedHumans.get(0), equalTo(new Human("Sarah", 10)));
}

注意compareTo的调用是翻转的,它负责反转。 最后,让我们使用*Comparator.comparing()*方法来简化上面的例子:

@Test
public final void 
  givenStreamComparatorOrdering_whenSortingEntitiesByNameReversed_thenCorrectlySorted() {
    List<Human> humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12));
    List<Human> reverseSortedHumans = humans.stream()
      .sorted(Comparator.comparing(Human::getName, Comparator.reverseOrder()))
      .collect(Collectors.toList());
    
    assertThat(reverseSortedHumans.get(0), equalTo(new Human("Sarah", 10)));
}

12. 空值

到目前为止,我们实现Comparator的方式是它们无法对包含null的集合进行排序。也就是说,如果集合至少包含一个 null元素,那么 sort方法会抛出 NullPointerException

@Test(expected = NullPointerException.class)
public void givenANullElement_whenSortingEntitiesByName_thenThrowsNPE() {
    List<Human> humans = Lists.newArrayList(null, new Human("Jack", 12));
    humans.sort((h1, h2) -> h1.getName().compareTo(h2.getName()));
}

最简单的解决方案是 在我们的Comparator实现中手动 处理null

@Test
public void givenANullElement_whenSortingEntitiesByNameManually_thenMovesTheNullToLast() {
    List<Human> humans = Lists.newArrayList(null, new Human("Jack", 12), null);
    humans.sort((h1, h2) -> {
        if (h1 == null) {
            return h2 == null ? 0 : 1;
        }
        else if (h2 == null) {
            return -1;
        }
        return h1.getName().compareTo(h2.getName());
    });
    Assert.assertNotNull(humans.get(0));
    Assert.assertNull(humans.get(1));
    Assert.assertNull(humans.get(2));
}

在这里,我们将所有 null元素推向集合的末尾。为此,比较器认为null 大于非 null 值。当两者都为 null时,它们被认为是相等的。 此外,我们可以将任何非 null 安全的Comparator传递给Comparator.nullsLast() 方法并获得相同的结果

@Test
public void givenANullElement_whenSortingEntitiesByName_thenMovesTheNullToLast() {
    List<Human> humans = Lists.newArrayList(null, new Human("Jack", 12), null);
    humans.sort(Comparator.nullsLast(Comparator.comparing(Human::getName)));
    Assert.assertNotNull(humans.get(0));
    Assert.assertNull(humans.get(1));
    Assert.assertNull(humans.get(2));
}

同样,我们可以使用 *Comparator.nullsFirst() *将 null元素移向集合的开头:

@Test
public void givenANullElement_whenSortingEntitiesByName_thenMovesTheNullToStart() {
    List<Human> humans = Lists.newArrayList(null, new Human("Jack", 12), null);
    humans.sort(Comparator.nullsFirst(Comparator.comparing(Human::getName)));
    Assert.assertNull(humans.get(0));
    Assert.assertNull(humans.get(1));
    Assert.assertNotNull(humans.get(2));
}

**强烈建议使用*nullsFirst()*或 nullsLast()装饰器,因为它们更加灵活和可读。