clear() API 的作用

clear() 方法是 Java 集合框架中 Collection 接口的一部分，由實現(xiàn)該接口的所有具體類（如 ArrayList、TreeSet 和 Stack）實現(xiàn)。當(dāng)調(diào)用此方法時，它會清空集合中所有的元素。

ArrayList 的 clear() 方法在 Java 中的工作原理

本文將重點分析 ArrayList 的 clear() 方法實現(xiàn)，其它集合的實現(xiàn)方式與之類似。在 ArrayList 的底層，數(shù)據(jù)存儲在一個 Object[] 數(shù)組中。當(dāng)向 ArrayList 添加元素時，這些元素會存儲在該數(shù)組中。

當(dāng)調(diào)用 clear() 方法時，Object[] 數(shù)組中的所有元素都會被清除。例如，假設(shè)我們創(chuàng)建了一個包含 100 萬個整數(shù)的 ArrayList，調(diào)用 clear() 方法后，數(shù)組中的所有元素都會被刪除。然而，底層的 Object[] 數(shù)組仍然存在，占用內(nèi)存空間。

創(chuàng)建 ArrayList 示例

通過以下示例代碼，我們可以更直觀地了解 clear() 方法的功能：

public class ClearNoDemo {
    private static ArrayList myList = new ArrayList();

    public static void main(String[] args) throws Exception {
        for (int counter = 0; counter < 1_000_000; ++counter) {
            myList.add(Long.valueOf(counter));
        }
        System.out.println("所有記錄都已添加！");
        Thread.sleep(10000); // 休眠10秒
    }
}

在上述代碼中：

1. 第 3 行創(chuàng)建了一個 ArrayList 類型的 myList 對象。
2. 第 7 至 10 行向 myList 添加了 100 萬個 Long 類型的對象。
3. 第 14 行讓線程休眠 10 秒，以便捕獲堆轉(zhuǎn)儲并分析內(nèi)存使用情況。

運行程序后，通過堆轉(zhuǎn)儲分析工具可以發(fā)現(xiàn)，myList 是內(nèi)存中最大的對象，其底層的 Object[] 數(shù)組占用了 27.5 MB 的內(nèi)存。這表明，添加的對象存儲在內(nèi)部的 Object[] 數(shù)組中。

調(diào)用 clear() 方法的示例

以下是一個修改后的示例代碼，在其中調(diào)用了 clear() 方法：

public class ClearDemo {
    private static ArrayList myList = new ArrayList();

    public static void main(String[] args) throws Exception {
        for (int counter = 0; counter < 1_000_000; ++counter) {
            myList.add(Long.valueOf(counter));
        }
        long startTime = System.currentTimeMillis();
        myList.clear();
        System.out.println("執(zhí)行時間：" + (System.currentTimeMillis() - startTime));
        Thread.sleep(10000); // 休眠10秒
    }
}

在上述代碼中：

1. 第 3 行創(chuàng)建了一個 ArrayList 類型的 myList 對象。
2. 第 7 至 10 行向 myList 添加了 100 萬個 Long 類型的對象。
3. 第 13 行調(diào)用了 clear() 方法清空集合。
4. 第 16 行讓線程休眠 10 秒，以便捕獲堆轉(zhuǎn)儲并分析內(nèi)存使用情況。

調(diào)用 clear() 方法后，底層的 Object[] 數(shù)組雖然清空了所有元素，但數(shù)組本身仍然存在，占用了 4.64 MB 的內(nèi)存。這表明，即使通過 clear() 方法清除了對象，底層數(shù)組仍然會占用內(nèi)存。

將列表賦值為 null 的示例

以下是將列表賦值為 null 的示例代碼：

public class ClearNullDemo {
    private static ArrayList myList = new ArrayList();

    public static void main(String[] args) throws Exception {
        for (int counter = 0; counter < 1_000_000; ++counter) {
            myList.add(Long.valueOf(counter));
        }
        long startTime = System.currentTimeMillis();
        myList = null;
        System.out.println("執(zhí)行時間：" + (System.currentTimeMillis() - startTime));
        Thread.sleep(10000); // 休眠10秒
    }
}

在上述代碼中：

1. 第 3 行創(chuàng)建了一個 ArrayList 類型的 myList 對象。
2. 第 7 至 10 行向 myList 添加了 100 萬個 Long 類型的對象。
3. 第 13 行將 myList 賦值為 null。

將列表賦值為 null 后，ArrayList 和底層的 Object[] 數(shù)組都可以被垃圾回收，從而釋放內(nèi)存。通過堆轉(zhuǎn)儲分析工具可以發(fā)現(xiàn)，myList 對象已經(jīng)從內(nèi)存中移除。

內(nèi)存影響

下圖展示了 ArrayList 在不同情況下的內(nèi)存占用情況：

處理時間影響

以下是 ArrayList#clear() 方法的源碼實現(xiàn)：

public void clear() {
    modCount++;
    final Object[] es = elementData;
    for (int to = size, i = size = 0; i < to; i++) {
        es[i] = null;
    }
}

從源碼可以看出，clear() 方法會遍歷底層的 Object[] 數(shù)組，將每個元素設(shè)置為 null，這會消耗一定的處理時間。

何時使用 Collection#clear() API？

盡管 clear() 方法可能會影響內(nèi)存和性能，但在以下情況下使用它是合理的：

1. 通過引用傳遞集合對象：如果集合對象被作為引用傳遞給代碼的其他部分，直接賦值為 null 會導(dǎo)致 NullPointerException，此時可以使用 clear() 方法。
2. 集合大小較小：當(dāng)集合實例較少且每個集合的大小較小時，調(diào)用 clear() 方法或賦值為 null 的性能差異可以忽略不計。

結(jié)論

通過本文的分析，我們詳細(xì)了解了 clear() API 的功能及其對性能的影響。在實際開發(fā)中，應(yīng)根據(jù)具體場景選擇合適的方法來清理集合，以平衡性能和內(nèi)存使用。

原文鏈接: https://blog.ycrash.io/clear-details-on-java-collection-clear-api/