Java?retainAll()方法的超詳細(xì)講解

更新時(shí)間：2025年03月13日 09:38:59 作者：飛滕人生TYF

這篇文章主要介紹了Java?retainAll()方法的相關(guān)資料,retainAll()是Java集合接口中的一個(gè)方法,用于保留集合中與指定集合交集的元素,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

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

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

1. 方法定義

方法簽名

boolean retainAll(Collection<?> c)

參數(shù)

c：一個(gè)集合，用于指定要保留的元素。

返回值

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

2. 功能描述

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

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，因?yàn)?list1 發(fā)生了改變
        System.out.println(list1); // 輸出：[B, C]
    }
}

4. 常見場(chǎng)景

場(chǎng)景 1：找出兩個(gè)集合的交集

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

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]

場(chǎng)景 2：從集合中刪除不需要的元素

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

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. 注意事項(xiàng)和常見問題

注意事項(xiàng)

不支持 null 集合：
- 如果參數(shù)集合為 null，調(diào)用 retainAll() 會(huì)拋出 NullPointerException。
```
List<Integer> list = new ArrayList<>(Arrays.asList(1, 2, 3));
list.retainAll(null); // 拋出 NullPointerException
```
原集合會(huì)被修改：
- 調(diào)用此方法后，原集合的內(nèi)容會(huì)被更改，僅保留交集元素。
參數(shù)集合不可修改：
- retainAll() 不會(huì)修改參數(shù)集合。

常見問題

空交集：
如果兩個(gè)集合沒有交集，則調(diào)用 retainAll() 后，原集合會(huì)變?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() 保留交集時(shí)，元素的順序按照原集合的順序。

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）。
對(duì)于每個(gè)元素，檢查它是否存在于參數(shù)集合中（如 list2）。
如果不存在，移除該元素。
返回 true，如果至少有一個(gè)元素被移除；否則返回 false。

效率

取決于參數(shù)集合的類型：
- 如果參數(shù)集合是一個(gè) HashSet，retainAll() 的性能較好，因?yàn)?nbsp;HashSet 提供了快速的查找操作（O(1)）。
- 如果參數(shù)集合是一個(gè) List，性能可能會(huì)較低，因?yàn)椴檎也僮餍枰€性時(shí)間（O(n)）。

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

removeAll()

區(qū)別：removeAll() 是刪除當(dāng)前集合中與指定集合交集的元素，而 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é)

方法	描述
作用	保留集合中與指定集合交集的元素，其余元素被刪除
修改原集合	是
參數(shù)不可為空	如果參數(shù)集合為空會(huì)拋出 `NullPointerException`
返回值	如果集合發(fā)生變化返回 `true`，否則返回 `false`
常見用途	找交集、過濾集合中的元素