Java中List的retainAll方法使用方法

一、背景介绍

在Java中，List是一种经常使用的集合类型，它提供了一系列常用的操作方法。其中retainAll方法可以用来求两个集合（可以是List、Set、Collection等）的交集。

retainAll方法的定义为：

boolean retainAll(Collection c);

其中c表示要求交集的集合，方法返回一个boolean值，表示是否修改了当前集合（即是否有元素被删除了）。

二、retainAll方法的使用

下面我们以两个List集合为例，来介绍retainAll方法的使用方法。

1. 求两个List集合的交集

首先，我们需要创建两个List集合，分别为list1和list2。它们的元素类型可以是任意类型，比如String、Integer等。

List<String> list1 = new ArrayList<>();
list1.add("apple");
list1.add("banana");
list1.add("cherry");
list1.add("date");

List<String> list2 = new ArrayList<>();
list2.add("banana");
list2.add("date");
list2.add("elderberry");
list2.add("fig");

现在，我们想要求list1和list2的交集，可以使用retainAll方法，代码如下：

boolean isModified = list1.retainAll(list2);

执行完上面的代码后，list1中的元素将只剩下"banana"和"date"，而isModified的值为true，表示list1被修改了，即有元素被删除了。

2.使用retainAll方法去重

除了求交集之外，retainAll方法还可以用来去重。我们可以将一个List集合看做一个集合，然后将另一个List集合作为候选元素集合，使用retainAll方法求出它们的交集，再将交集添加到原List集合中，从而实现去重。

示例代码如下：

List<String> list1 = new ArrayList<>();
list1.add("apple");
list1.add("banana");
list1.add("cherry");

List<String> list2 = new ArrayList<>();
list2.add("banana");
list2.add("cherry");
list2.add("date");

boolean isModified = list1.retainAll(list2);
if (isModified) {
    list1.addAll(list2);
}

System.out.println(list1);

执行完上面的代码后，list1中的元素将为"apple"、"banana"、"cherry"和"date"，即去掉了重复的元素"banana"和"cherry"。

3. 针对自定义类型的使用方法

retainAll方法不仅可以用来处理字符串、整数等基本类型的List集合，还可以处理自定义类型的List集合。我们只需要在自定义类型中实现equals方法，即可确保retainAll方法可以正确比较元素的相等性。

示例代码如下：

class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        if (obj instanceof Person) {
            Person person = (Person) obj;
            return Objects.equals(this.name, person.name) && this.age == person.age;
        }
        return false;
    }
}

public class Main {

    public static void main(String[] args) {
        List<Person> list1 = new ArrayList<>();
        list1.add(new Person("Alice", 18));
        list1.add(new Person("Bob", 20));
        list1.add(new Person("Charlie", 22));

        List<Person> list2 = new ArrayList<>();
        list2.add(new Person("Bob", 20));
        list2.add(new Person("Charlie", 22));
        list2.add(new Person("David", 24));

        boolean isModified = list1.retainAll(list2);
        if (isModified) {
            list1.addAll(list2);
        }

        list1.forEach(person -> System.out.println(person.getName() + " " + person.getAge()));
    }

}

执行完上面的代码后，输出结果为：

Bob 20
Charlie 22
David 24

可以看到，我们成功地对自定义类型的List集合求了交集，它们的equals方法正确比较了两个元素的相等性。