[Guava] 3 列表排序Ordering

排序器(Ordering)是Guava流畅风格比较器[Comparator]的实现，它可以用来为构建复杂的比较器，以完成集合排序的功能。

API以及基本使用

首先定一个实体类

public class Entity {

    public int status;
    public String name;

    public Entity(int status, String name) {
        this.status = status;
        this.name = name;
    }

    public Entity(int status) {
        this.status = status;
    }

    @Override
    public String toString() {
        return "Entity{" +
                "status=" + status +
                ", name='" + name + '\'' +
                '}';
    }
}

测试数据：

List<Entity> list = Lists.newArrayList(
       new Entity(1, "h"),
       new Entity(2, "f"),
       new Entity(3, "a"),
       new Entity(0, "d"),
       new Entity(2, "b")
);

1 Ordering的初始化

Ordering的初始化方法主要有三种，分别用于不同的场景。

• 对可排序的数据类型的排序器，如整型，日期
  适用于指定数据类型的列表排序

// 整型按照大小排序
Ordering<Integer> integerOrdering = Ordering.natural();
// 日期先后排序
Ordering<Date> dateOrdering = Ordering.natural();

• 按照对象的字符串形式（toString()）做字典排序

// 排序结果：[Entity{status=0, name='d'}, Entity{status=1, name='h'}, Entity{status=2, name='b'}, Entity{status=2, name='f'}, Entity{status=3, name='a'}]

Ordering<Object> ordering3 = Ordering.usingToString();

image.png

• 根据自定义Comparator初始化

// 排序结果：[Entity{status=0, name='d'}, Entity{status=1, name='h'}, Entity{status=2, name='f'}, Entity{status=2, name='b'}, Entity{status=3, name='a'}]
// 按照status字段升序排序
Ordering<Entity> ordering1 = Ordering.from(Comparator.comparingInt(o -> o.status));

2 链式调用方法

• reverse()方法
  倒序排序

// 倒序排序
// 排序结果：[Entity{status=3, name='a'}, Entity{status=2, name='f'}, Entity{status=2, name='b'}, Entity{status=1, name='h'}, Entity{status=0, name='d'}]
Ordering<Object> ordering3 = Ordering.usingToString().reverse();

• nullsFirst()、nullsLast()：将null值排到最前面/最后面位置。

• compound(Comparator<? super U> secondaryComparator)：合成另一个比较器，以处理当前排序器中的相等情况。
  比如说首先按照A属性比较，相等的情况下再按照B属性排序

// status升序排序
Ordering<Entity> ordering1 = Ordering.from(Comparator.comparingInt(o -> o.status));
// status相等，按照name升序排序
// 排序结果：[Entity{status=0, name='d'}, Entity{status=1, name='h'}, Entity{status=2, name='b'}, Entity{status=2, name='f'}, Entity{status=3, name='a'}]
Ordering<Entity> ordering4 = ordering1.compound((o1, o2) -> StringUtils.compare(o1.name, o2.name));

• onResultOf(Function<F, ? extends T> function)
  对集合中元素调用Function，再按照返回值用当前排序器排序

// status升序 null的对象放在最后面
// 排序结果：[Entity{status=0, name='d'}, Entity{status=1, name='h'}, Entity{status=2, name='f'}, Entity{status=2, name='b'}, Entity{status=3, name='a'}, null]

Ordering<Entity> ordering = Ordering.natural().onResultOf(new Function<Entity, Comparable>() {
        @Override
        public Comparable apply(Entity entity) {
            if (entity != null) {
                return entity.status;
            }
            return -1;
        }
    }).nullsLast();

当阅读链式调用产生的排序器时，应该从后往前读，但是注意：用compound方法包装排序器时，就不应遵循从后往前读的原则。为了避免理解上的混乱，请不要把compound写在一长串链式调用的中间，你可以另起一行，在链中最先或最后调用compound。

3 运用排序器方法

• greatestOf(Iterable iterable, int k)/leastOf

// 排序结果：[null, Entity{status=3, name='a'}, Entity{status=2, name='f'}, Entity{status=2, name='b'}]
// nullLast()导致null最大，最大的四个元素
ordering.greatestOf(list, 4)
// 排序结果：[Entity{status=0, name='d'}, Entity{status=1, name='h'}, Entity{status=2, name='f'}, Entity{status=2, name='b'}]
// 最小的四个元素
ordering.leastOf(list, 4)

• min(Iterable iterable)/max

// 结果：Entity{status=0, name='d'}
ordering.min(list)
// 还支持N个对象的比较
// 结果：Entity{status=1, name='y'}
ordering.min(new Entity(1, "y"), new Entity(2, "x"))

• sortedCopy(Iterable iterable)
  在sortedCopy过程中，Ordering将排序结果作为新的列表对象，原有列表并没有改动。

// 数据：
 List<Entity> list = new ArrayList<Entity>() {{
            add(new Entity(1, "h"));
            add(new Entity(2, "f"));
            add(new Entity(3, "a"));
            add(new Entity(0, "d"));
            add(new Entity(2, "b"));
            add(null);
        }};
// 结果：[Entity{status=0, name='d'}, Entity{status=1, name='h'}, Entity{status=2, name='f'}, Entity{status=2, name='b'}, Entity{status=3, name='a'}, null]
[Entity{status=1, name='h'}, Entity{status=2, name='f'}, Entity{status=3, name='a'}, Entity{status=0, name='d'}, Entity{status=2, name='b'}, null]

System.out.println(ordering.sortedCopy(list));
System.out.println(list);