前言

在 Java 中，retainAll() 是 Collection 接口（List、Set 等集合類實現(xiàn)該接口）的一種方法，用于保留集合中與指定集合交集的元素，刪除其他所有元素。

以下是對 retainAll() 方法的詳細講解。

1. 方法定義

方法簽名

boolean retainAll(Collection<?> c)

參數(shù)

• c：一個集合，用于指定要保留的元素。

返回值

• 返回一個 boolean 值：
  • true：如果集合內(nèi)容因調(diào)用此方法而改變。
  • false：如果集合內(nèi)容沒有改變（即調(diào)用此方法前后集合中的元素相同）。

2. 功能描述

• retainAll() 方法會將調(diào)用該方法的集合（假設(shè)為 A）中的所有元素與參數(shù)集合（假設(shè)為 B）進行比較，保留兩者交集的元素。
• 如果 A 中的元素不在 B 中，它們會被移除。
• 參數(shù)集合 B 不會被修改。

3. 使用示例

基本用法

import java.util.ArrayList;
import java.util.Arrays;

public class RetainAllExample {
    public static void main(String[] args) {
        ArrayList<Integer> list1 = new ArrayList<>(Arrays.asList(1, 2, 3, 4, 5));
        ArrayList<Integer> list2 = new ArrayList<>(Arrays.asList(3, 4, 5, 6, 7));

        // 保留 list1 和 list2 的交集
        list1.retainAll(list2);

        System.out.println(list1); // 輸出：[3, 4, 5]
    }
}

返回值示例

import java.util.ArrayList;
import java.util.Arrays;

public class RetainAllExample {
    public static void main(String[] args) {
        ArrayList<String> list1 = new ArrayList<>(Arrays.asList("A", "B", "C"));
        ArrayList<String> list2 = new ArrayList<>(Arrays.asList("B", "C"));

        boolean isModified = list1.retainAll(list2);

        System.out.println(isModified); // 輸出：true，因為 list1 發(fā)生了改變
        System.out.println(list1); // 輸出：[B, C]
    }
}

4. 常見場景

場景 1：找出兩個集合的交集

使用 retainAll() 可以快速找到兩個集合的交集：

Set<Integer> set1 = new HashSet<>(Arrays.asList(1, 2, 3, 4));
Set<Integer> set2 = new HashSet<>(Arrays.asList(3, 4, 5, 6));

set1.retainAll(set2);

System.out.println(set1); // 輸出：[3, 4]

場景 2：從集合中刪除不需要的元素

通過與一個已知集合比較，保留需要的元素，其余元素被刪除：

List<String> fruits = new ArrayList<>(Arrays.asList("Apple", "Banana", "Mango", "Orange"));
List<String> preferredFruits = Arrays.asList("Apple", "Orange");

fruits.retainAll(preferredFruits);

System.out.println(fruits); // 輸出：[Apple, Orange]

5. 注意事項和常見問題

注意事項

• 不支持 null 集合：

  • 如果參數(shù)集合為 null，調(diào)用 retainAll() 會拋出 NullPointerException。

    List<Integer> list = new ArrayList<>(Arrays.asList(1, 2, 3));
    list.retainAll(null); // 拋出 NullPointerException
    

• 原集合會被修改：

  • 調(diào)用此方法后，原集合的內(nèi)容會被更改，僅保留交集元素。

• 參數(shù)集合不可修改：

  • retainAll() 不會修改參數(shù)集合。

常見問題

• 空交集：
  如果兩個集合沒有交集，則調(diào)用 retainAll() 后，原集合會變?yōu)榭铡?/p>

  List<Integer> list1 = new ArrayList<>(Arrays.asList(1, 2, 3));
  List<Integer> list2 = new ArrayList<>(Arrays.asList(4, 5, 6));
  
  list1.retainAll(list2);
  
  System.out.println(list1); // 輸出：[]
  

• 順序保留：
  如果使用 List（如 ArrayList），retainAll() 保留交集時，元素的順序按照原集合的順序。

  List<Integer> list1 = new ArrayList<>(Arrays.asList(1, 2, 3, 4));
  List<Integer> list2 = new ArrayList<>(Arrays.asList(4, 3));
  
  list1.retainAll(list2);
  
  System.out.println(list1); // 輸出：[3, 4]
  

6. 內(nèi)部原理

執(zhí)行流程

• 遍歷調(diào)用 retainAll() 的集合（如 list1）。
• 對于每個元素，檢查它是否存在于參數(shù)集合中（如 list2）。
• 如果不存在，移除該元素。
• 返回 true，如果至少有一個元素被移除；否則返回 false。

效率

• 取決于參數(shù)集合的類型：
  • 如果參數(shù)集合是一個 HashSet，retainAll() 的性能較好，因為 HashSet 提供了快速的查找操作（O(1)）。
  • 如果參數(shù)集合是一個 List，性能可能會較低，因為查找操作需要線性時間（O(n)）。

7. 與其他方法的區(qū)別

removeAll()

• 區(qū)別：removeAll() 是刪除當前集合中與指定集合交集的元素，而 retainAll() 是保留交集元素。
• 示例：

  List<Integer> list1 = new ArrayList<>(Arrays.asList(1, 2, 3, 4));
  List<Integer> list2 = new ArrayList<>(Arrays.asList(3, 4, 5));
  
  // removeAll 刪除交集
  list1.removeAll(list2);
  System.out.println(list1); // 輸出：[1, 2]
  
  // retainAll 保留交集
  list1 = new ArrayList<>(Arrays.asList(1, 2, 3, 4));
  list1.retainAll(list2);
  System.out.println(list1); // 輸出：[3, 4]
  

8. 總結(jié)

retainAll() 是操作集合的一個常用方法，能夠幫助開發(fā)者快速進行集合間的交集操作。在使用時，需要注意原集合會被修改，因此在某些場景下可能需要備份原集合數(shù)據(jù)以避免數(shù)據(jù)丟失。

到此這篇關(guān)于Java retainAll()方法的文章就介紹到這了,更多相關(guān)Java retainAll()方法內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論