Spring中如何使用Comparator接口

Posted on by

我們先來回顧下Comparator接口在我們日常開發中的作用，Comparator比較器接口可以將自身傳遞給排序方法（比如Collections.sort或Arrays.sort），以便對排序順序進行精確控制。比如：

List<Integer> intList = Arrays.asList(2, 3, 1);
Collections.sort(intList, (o1, o2) -> {
   return o2-o1;
});

輸出

[3, 2, 1]

Comparator可以用來控制某些數據結構（如sored sets 或sorted maps）的順序，或者為沒有自然順序的對象集合提供順序,比如：

public class Emp {
   private int empNo;
   private String eName;
   //省略getter setter
   @Override
   public String toString()
   {
      return "empno:\t"+empno+"\tename:\t"+ename;
   }
}
Comparator<Emp> comparator = (o1, o2) -> {
            return o1.getEmpno()-o2.getEmpno();
};
empList.sort(comparator);

從以上使用方法可以看出Comparator是策略模式的一個經典體現，在Spring中它為實現瞭Ordered接口的類寫瞭一個比較器名叫OrderComparator，我們來看看它的compare方法：

@Override
public int compare(@Nullable Object o1, @Nullable Object o2) {
   return doCompare(o1, o2, null);
}
private int doCompare(@Nullable Object o1, @Nullable Object o2, @Nullable OrderSourceProvider sourceProvider) {
   //判斷是否實現瞭PriorityOrdered接口
    //o1為原先的後一個元素
    //o2為原先的前一個元素
   boolean p1 = (o1 instanceof PriorityOrdered);
   boolean p2 = (o2 instanceof PriorityOrdered);
  //p1實現瞭PriorityOrdered，但是p2沒實現PriorityOrdered，則p1優先級更高
   if (p1 && !p2) {
         ////小於0 表示逆序 o1排前
      return -1;
   }
   else if (p2 && !p1) {
     //p2實現瞭PriorityOrdered，但是p1沒實現PriorityOrdered，則p2優先級更高
            //大於0 表示正序 o2排前
      return 1;
   }
   int i1 = getOrder(o1, sourceProvider);
   int i2 = getOrder(o2, sourceProvider);
   return Integer.compare(i1, i2);
}
 
    protected int getOrder(@Nullable Object obj) {
        if (obj != null) {
            Integer order = findOrder(obj);
            if (order != null) {
                return order;
            }
        }
    //Integer.MAX_VALUE代表最低優先級
        return Ordered.LOWEST_PRECEDENCE;
    }
 
    @Nullable
    protected Integer findOrder(Object obj) {
        return (obj instanceof Ordered ? ((Ordered) obj).getOrder() : null);
    }

OrderComparator主要是通過實現Order接口方法getOrder返回的值來比較的，而通過註解Order比較的話是采用繼承OrderComparator類的AnnotationAwareOrderComparator類來重載getOrder方法來實現：

@Override
@Nullable
protected Integer findOrder(Object obj) {
   // Check for regular Ordered interface
   //檢查常規的Order接口
   Integer order = super.findOrder(obj);
   if (order != null) {
      return order;
   }
     //檢查@Order註解和@Priority註解
   // Check for @Order and @Priority on various kinds of elements
   if (obj instanceof Class) {
      return OrderUtils.getOrder((Class<?>) obj);
   }
   else if (obj instanceof Method) {
      Order ann = AnnotationUtils.findAnnotation((Method) obj, Order.class);
      if (ann != null) {
         return ann.value();
      }
   }
   else if (obj instanceof AnnotatedElement) {
      //AnnotatedElement代表在當前運行的java虛擬機中一個可以被註解的元素，這個接口允許通過反射讀取元素上面的註解，這與我們之                前的理解是一致的
      //https://www.yuque.com/cuihualong/javaseries/sh91es
      Order ann = AnnotationUtils.getAnnotation((AnnotatedElement) obj, Order.class);
      if (ann != null) {
         return ann.value();
      }
   }
   else {
      order = OrderUtils.getOrder(obj.getClass());
      if (order == null && obj instanceof DecoratingProxy) {
         order = OrderUtils.getOrder(((DecoratingProxy) obj).getDecoratedClass());
      }
   }
   return order;
}

這裡順便提下在SpringBoot中ConditionalOnBean，ConditionalOnProperty，ConditionalOnClass等註解實際上都采用瞭實現Order註解的方法來進行排序。這裡我就截個圖看下瞭：

Conditional註解中的OnClassCondition類就標瞭@Order註解

實現Comparator接口compare方法的時候主要是要註意以下幾點(翻譯自官方文檔)：

用中文簡單來說就是在 JDK7 版本以上默認使用Timsort排序方法來實現，Comparator 比較器要滿足自反性，傳遞性，反對稱性，不然 Arrays.sort，Collections.sort有可能會報 IllegalArgumentException 異常。

以上就是Spring中如何使用Comparator接口的詳細內容，更多關於Spring 使用Comparator接口的資料請關註WalkonNet其它相關文章！

推薦閱讀：