retainAll详解

retainAll是一个常用的Java集合操作方法，用来取两个集合的交集。比较常见的使用场景是在两个List中，找出在其中一个List中同时也存在于另一个List中的元素。

一、retainAll基本用法

List<String> list1 = new ArrayList<>(Arrays.asList("a", "b", "c", "d"));
List<String> list2 = new ArrayList<>(Arrays.asList("b", "d", "e", "f"));
list1.retainAll(list2);
System.out.println(list1); //输出：[b, d]

在上面的示例中，我们创建了两个List，分别包含了一些字符串。我们调用了list1的retainAll方法，这个方法会保留list1中同时也存在于list2中的元素，也就是"b"和"d"，其他元素都被删除了。

二、retainAll效率问题

在实际开发中，我们一般会在较大的集合中使用retainAll方法。那么，retainAll的效率问题就需要引起我们的注意。

retainAll方法的本质就是使用循环遍历去一个一个判断元素是否在另一个集合中出现，因此，retainAll的效率取决于集合的大小。

下面我们通过一个比较来看一下retainAll方法的效率：

List<String> list1 = new ArrayList<>();
List<String> list2 = new ArrayList<>();
for (int i = 0; i < 10000000; i++) {
    list1.add(String.valueOf(i));
    if (i % 100 == 0) {
        list2.add(String.valueOf(i));
    }
}
long start = System.currentTimeMillis();
list1.retainAll(list2);
long end = System.currentTimeMillis();
System.out.println("retainAll time: " + (end - start) + "ms");

在上面的示例中，我们创建了一个大小为10000000的List，其中每100个元素我们取一个并放到list2中，再执行retainAll方法。我们可以看到，执行完retainAll方法后输出的时间是：

retainAll time: 144ms

这个时间可能并不是特别长，但是如果我们要在生产环境中处理更大的集合，retainAll的效率问题就有可能成为瓶颈了。

三、retainAll过程中的异常情况

在使用retainAll方法的时候，我们也需要注意一些异常情况。下面我们列举一下可能会发生的情况：

1. retainAll(null)

如果我们调用retainAll方法的参数为null，就会抛出NullPointerException异常：

List<String> list = new ArrayList<>(Arrays.asList("a", "b", "c"));
list.retainAll(null); //抛出NullPointerException异常

2. retainAll与底层集合类型不一致

如果我们使用retainAll方法的集合类型与底层集合类型不一致，就会抛出ClassCastException异常：

List<String> list1 = new ArrayList<>(Arrays.asList("a", "b", "c"));
Set<String> set = new HashSet<>(Arrays.asList("b", "c"));
list1.retainAll(set); //抛出ClassCastException异常

在上面的示例中，我们创建了一个List和一个Set，然后将Set传递给List的retainAll方法，这时就会抛出ClassCastException异常，因为底层集合类型不一致。

3. retainAll与不可修改的集合

如果我们使用retainAll方法的集合是一个不可修改的集合，就会抛出UnsupportedOperationException异常：

List<String> list1 = new ArrayList<>(Arrays.asList("a", "b", "c"));
List<String> list2 = Arrays.asList("b", "c");
list2.retainAll(list1); //抛出UnsupportedOperationException异常

在上面的示例中，我们将一个可修改的List和一个不可修改的List传递给retainAll方法进行操作，这时就会抛出UnsupportedOperationException异常。

四、参考资料

1. Java文档：https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html#retainAll-java.util.Collection-

2. Java线上编程：https://www.javacreed.com/when-to-use-retail-all-with-sample-implementation/