本文將介紹Apache Commons Collection庫中的ListUtils類。這個類為JAVA中的List接口提供了實用功能和裝飾方法。

引入依賴包

<dependency>
   <groupId>org.apache.commons</groupId>
   <artifactId>commons-collections4</artifactId>
   <version>4.4</version>
 </dependency>

我們現在創建一個簡單的用戶對象，使用這個對象來測試ListUtils類的功能性。如下所示：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserObject {
    private String userName;
    private Integer userId;
    private Double userSalary;
}

接下來創建一個叫做 defaultUserList的列表：

List<UserObject> defaultUserList = Arrays.asList(
   new UserObject("User1", 1, 10000.0),
   new UserObject("User2", 2, 20000.0),
   new UserObject("User3", 3, 30000.0),
   new UserObject("User4", 4, 40000.0),
   new UserObject("User5", 5, 50000.0));

ListUtils核心功能

1）DefaultIfNull

它接收兩個參數：一個默認列表和一個用戶列表。如果現有的用戶列表為空，該方法將返回默認列表。當通過List實例處理引用數據時，這很有用。它可以防止發生空指針異常。

List<UserObject> nullList = null;
assertEquals(defaultUserList,ListUtils.defaultIfNull(defaultUserList, nullList));

2）EmptyIfNull

它接收一個用戶列表作為輸入參數，如果用戶列表為空，則返回一個空列表，避免發生空指針異常。

List<UserObject> nullList = null;
assertTrue(ListUtils.emptyIfNull(nullList).isEmpty());

3）FixedSizeList

這個方法是輸出一個固定大小的列表，不能添加或刪除元素，但可以編輯列表的元素。

如下面的代碼所示，如果我們嘗試從固定列表中添加還是刪除元素，都會拋出
UnsupportedOperationException。

 List < UserObject > fixedList = ListUtils.fixedSizeList(defaultUserList);

 assertEquals(Double.valueOf(10000), fixedList.get(0).getUserSalary());

 Exception exception = assertThrows(UnsupportedOperationException.class,
         () -> {
                 fixedList.add(new UserObject("User6", 6, 60000.0));
         });
 assertEquals("List is fixed size", exception.getMessage());

 assertThrows(UnsupportedOperationException.class, () -> {
         fixedList.remove(0);
 });

4）PredicatedList

當我們希望將謂詞作為對用戶列表的檢查時，這個方法非常有用，可以使用兩種方式。

方法1：創建一個包含用戶數據的列表，然后使用謂詞進行驗證。如果存在元素未通過謂詞條件，則拋出錯誤。

例如：ListUtils.predicatedList檢查輸入列表的所有元素的salary參數是否大于20000.0；如果不是，它將拋出IllegalArgumentException。

assertThrows(IllegalArgumentException.class, () -> {
   ListUtils.predicatedList(defaultUserList,
     userObj -> userObj.getUserSalary() > 20000.0);
  });

方法2：在數據插入列表時執行驗證。通過輸入一個空列表和一個謂詞條件，可以獲取一個預測列表。當我們嘗試添加一個新的數據條目時，它會與謂詞進行驗證，如果條件不滿足，就會拋出異常。

  List<UserObject> predicatedUserList = ListUtils.predicatedList(
    new ArrayList<UserObject>(),
    userObj -> userObj.getUserSalary() > 20000.0);

  assertThrows(IllegalArgumentException.class, () -> {
   predicatedUserList.add(new UserObject("User", 2, 10000.0));
  });

5）Partition

該方法通過指定子列表的大小將用戶列表劃分為子列表。如下所示：

 List<List<UserObject>> partitionedList = ListUtils
    .partition(defaultUserList, 2);
  assertEquals(3, partitionedList.size());

6）Index Of

該方法接受用戶列表和謂詞作為輸入。然后找到第一個滿足謂詞條件的元素并返回其下標。

int indexOfObject = ListUtils.indexOf(defaultUserList,
    userObj -> userObj.getUserSalary().equals(20000.0));
  assertEquals(1, indexOfObject);

7）Select

它與Java 8流過濾器的工作方式相同，接收用戶列表和謂詞作為輸入，并返回滿足謂詞條件的參數列表。

 // Java 8 Stream示例
 List<UserObject> java8List = defaultUserList
    .stream()
    .filter(userObj -> userObj.getUserSalary() > 20000.0)
    .collect(Collectors.toList());
  assertEquals(3, java8List.size());

// ListUtils.select方法使用示例
 List<UserObject> predicatedList = ListUtils.select(defaultUserList,
    userObj -> userObj.getUserSalary() > 20000.0);
  assertEquals(3, predicatedList.size());

8）SelectRejected

這個方法是ListUtils.select的逆操作。將用戶列表和謂詞作為輸入傳遞給此方法，并返回所有不滿足謂詞條件的元素列表。

List<UserObject> listNotMeetingPredicate = ListUtils.selectRejected(
    defaultUserList, userObj -> userObj.getUserSalary() > 20000.0);
  assertEquals(2, listNotMeetingPredicate.size());

9）IsEqualList

此方法用于比較兩個列表。僅當兩個列表具有相同的大小，并且兩個列表中所有相應的元素對都相等時，才返回true。

List<Integer> list1 = Arrays.asList(1, 2, 3, 4);
  List<Integer> list2 = Arrays.asList(1, 2, 3, 4);
  List<Integer> list3 = Arrays.asList(3, 4, 5, 6, 7);
  
  assertTrue(ListUtils.isEqualList(list1, list2));
  assertFalse(ListUtils.isEqualList(list1, list3));

它還可以比較兩個不同的List接口實現。示例如下：比較ArrayList、LinkedList和HashSet。

List<Integer> list1 = Arrays.asList(1, 2, 3, 4);
  List<Integer> linkedList = new LinkedList<>(list1);
  Set<Integer> hashSet = new HashSet<>(list1);
  assertTrue(ListUtils.isEqualList(list1, linkedList));
  assertTrue(ListUtils.isEqualList(list1, hashSet));

10）Intersection

該方法接受兩個列表作為輸入，并返回兩個列表的交集。

List<Integer> list1 = Arrays.asList(1, 2, 3, 4);
  List<Integer> list3 = Arrays.asList(3, 4, 5, 6, 7);
 
  assertEquals(Arrays.asList(3, 4), ListUtils.intersection(list1, list3));

11）LazyList

這是ListUtils類提供的另一個有趣的方法。它接收一個列表和一個轉換器或工廠作為輸入，然后返回一個懶加載列表，其元素在需要時創建。

如下所示：

Transformer<Integer, UserObject> transformer = input -> {
   if (defaultUserList.size() > input)
    return defaultUserList.get(input);
   else
    return new UserObject();
  };

  List<UserObject> lazyList = ListUtils
    .lazyList(new ArrayList<UserObject>(),
    transformer);

  assertEquals(defaultUserList.get(0), lazyList.get(0));
  assertEquals(new UserObject(), lazyList.get(6));
  assertEquals(1, lazyList.indexOf(null));