通過原始碼一步一步分析 ArrayList 擴容機制

什麼你竟然不會敲程式碼發表於2020-10-07

本文轉載自https://github.com/Snailclimb/JavaGuide/blob/master/docs/java/collection/ArrayList-Grow.md

一 先從 ArrayList 的建構函式說起

ArrayList有三種方式來初始化,構造方法原始碼如下:

   /**
     * 預設初始容量大小
     */
    private static final int DEFAULT_CAPACITY = 10;
    

    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /**
     *預設建構函式,使用初始容量10構造一個空列表(無引數構造)
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
    
    /**
     * 帶初始容量引數的建構函式。(使用者自己指定容量)
     */
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {//初始容量大於0
            //建立initialCapacity大小的陣列
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {//初始容量等於0
            //建立空陣列
            this.elementData = EMPTY_ELEMENTDATA;
        } else {//初始容量小於0,丟擲異常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }


   /**
    *構造包含指定collection元素的列表,這些元素利用該集合的迭代器按順序返回
    *如果指定的集合為null,throws NullPointerException。 
    */
     public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

細心的同學一定會發現 :以無引數構造方法建立 ArrayList 時,實際上初始化賦值的是一個空陣列。當真正對陣列進行新增元素操作時,才真正分配容量。即向陣列中新增第一個元素時,陣列容量擴為10。 下面在我們分析 ArrayList 擴容時會講到這一點內容!

二 一步一步分析 ArrayList 擴容機制

這裡以無參建構函式建立的 ArrayList 為例分析

1. 先來看 add 方法

    /**
     * 將指定的元素追加到此列表的末尾。 
     */
    public boolean add(E e) {
   //新增元素之前,先呼叫ensureCapacityInternal方法
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //這裡看到ArrayList新增元素的實質就相當於為陣列賦值
        elementData[size++] = e;
        return true;
    }

注意 :JDK11 移除了 ensureCapacityInternal()ensureExplicitCapacity() 方法

2. 再來看看 ensureCapacityInternal() 方法

可以看到 add 方法 首先呼叫了ensureCapacityInternal(size + 1)

   //得到最小擴容量
    private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
              // 獲取預設的容量和傳入引數的較大值
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }

當 要 add 進第1個元素時,minCapacity為1,在Math.max()方法比較後,minCapacity 為10。

3. ensureExplicitCapacity() 方法

如果呼叫 ensureCapacityInternal() 方法就一定會進過(執行)這個方法,下面我們來研究一下這個方法的原始碼!

  //判斷是否需要擴容
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            //呼叫grow方法進行擴容,呼叫此方法代表已經開始擴容了
            grow(minCapacity);
    }

我們來仔細分析一下:

  • 當我們要 add 進第1個元素到 ArrayList 時,elementData.length 為0 (因為還是一個空的 list),因為執行了 ensureCapacityInternal() 方法 ,所以 minCapacity 此時為10。此時,minCapacity - elementData.length > 0成立,所以會進入 grow(minCapacity) 方法。
  • 當add第2個元素時,minCapacity 為2,此時e lementData.length(容量)在新增第一個元素後擴容成 10 了。此時,minCapacity - elementData.length > 0 不成立,所以不會進入 (執行)grow(minCapacity) 方法。
  • 新增第3、4···到第10個元素時,依然不會執行grow方法,陣列容量都為10。

直到新增第11個元素,minCapacity(為11)比elementData.length(為10)要大。進入grow方法進行擴容。

4. grow() 方法

    /**
     * 要分配的最大陣列大小
     */
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    /**
     * ArrayList擴容的核心方法。
     */
    private void grow(int minCapacity) {
        // oldCapacity為舊容量,newCapacity為新容量
        int oldCapacity = elementData.length;
        //將oldCapacity 右移一位,其效果相當於oldCapacity /2,
        //我們知道位運算的速度遠遠快於整除運算,整句運算式的結果就是將新容量更新為舊容量的1.5倍,
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //然後檢查新容量是否大於最小需要容量,若還是小於最小需要容量,那麼就把最小需要容量當作陣列的新容量,
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
       // 如果新容量大於 MAX_ARRAY_SIZE,進入(執行) `hugeCapacity()` 方法來比較 minCapacity 和 MAX_ARRAY_SIZE,
       //如果minCapacity大於最大容量,則新容量則為`Integer.MAX_VALUE`,否則,新容量大小則為 MAX_ARRAY_SIZE 即為 `Integer.MAX_VALUE - 8`。
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

int newCapacity = oldCapacity + (oldCapacity >> 1),所以 ArrayList 每次擴容之後容量都會變為原來的 1.5 倍左右(oldCapacity為偶數就是1.5倍,否則是1.5倍左右)! 奇偶不同,比如 :10+10/2 = 15, 33+33/2=49。如果是奇數的話會丟掉小數.

“>>”(移位運算子):>>1 右移一位相當於除2,右移n位相當於除以 2 的 n 次方。這裡 oldCapacity 明顯右移了1位所以相當於oldCapacity /2。對於大資料的2進位制運算,位移運算子比那些普通運算子的運算要快很多,因為程式僅僅移動一下而已,不去計算,這樣提高了效率,節省了資源

我們再來通過例子探究一下grow() 方法 :

  • 當add第1個元素時,oldCapacity 為0,經比較後第一個if判斷成立,newCapacity = minCapacity(為10)。但是第二個if判斷不會成立,即newCapacity 不比 MAX_ARRAY_SIZE大,則不會進入 hugeCapacity 方法。陣列容量為10,add方法中 return true,size增為1。
  • 當add第11個元素進入grow方法時,newCapacity為15,比minCapacity(為11)大,第一個if判斷不成立。新容量沒有大於陣列最大size,不會進入hugeCapacity方法。陣列容量擴為15,add方法中return true,size增為11。
  • 以此類推······

這裡補充一點比較重要,但是容易被忽視掉的知識點:

  • java 中的 length屬性是針對陣列說的,比如說你宣告瞭一個陣列,想知道這個陣列的長度則用到了 length 這個屬性.
  • java 中的 length() 方法是針對字串說的,如果想看這個字串的長度則用到 length() 這個方法.
  • java 中的 size() 方法是針對泛型集合說的,如果想看這個泛型有多少個元素,就呼叫此方法來檢視!

5. hugeCapacity() 方法。

從上面 grow() 方法原始碼我們知道: 如果新容量大於 MAX_ARRAY_SIZE,進入(執行) hugeCapacity() 方法來比較 minCapacity 和 MAX_ARRAY_SIZE,如果minCapacity大於最大容量,則新容量則為Integer.MAX_VALUE,否則,新容量大小則為 MAX_ARRAY_SIZE 即為 Integer.MAX_VALUE - 8

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        //對minCapacity和MAX_ARRAY_SIZE進行比較
        //若minCapacity大,將Integer.MAX_VALUE作為新陣列的大小
        //若MAX_ARRAY_SIZE大,將MAX_ARRAY_SIZE作為新陣列的大小
        //MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

System.arraycopy()Arrays.copyOf()方法

閱讀原始碼的話,我們就會發現 ArrayList 中大量呼叫了這兩個方法。比如:我們上面講的擴容操作以及add(int index, E element)toArray() 等方法中都用到了該方法!

3.1 System.arraycopy() 方法

    /**
     * 在此列表中的指定位置插入指定的元素。 
     *先呼叫 rangeCheckForAdd 對index進行界限檢查;然後呼叫 ensureCapacityInternal 方法保證capacity足夠大;
     *再將從index開始之後的所有成員後移一個位置;將element插入index位置;最後size加1。
     */
    public void add(int index, E element) {
        rangeCheckForAdd(index);

        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //arraycopy()方法實現陣列自己複製自己
        //elementData:源陣列;index:源陣列中的起始位置;elementData:目標陣列;index + 1:目標陣列中的起始位置; size - index:要複製的陣列元素的數量;
        System.arraycopy(elementData, index, elementData, index + 1, size - index);
        elementData[index] = element;
        size++;
    }

我們寫一個簡單的方法測試以下:

public class ArraycopyTest {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		int[] a = new int[10];
		a[0] = 0;
		a[1] = 1;
		a[2] = 2;
		a[3] = 3;
		System.arraycopy(a, 2, a, 3, 3);
		a[2]=99;
		for (int i = 0; i < a.length; i++) {
			System.out.print(a[i] + " ");
		}
	}

}

結果:

0 1 99 2 3 0 0 0 0 0 

3.2 Arrays.copyOf()方法

   /**
     以正確的順序返回一個包含此列表中所有元素的陣列(從第一個到最後一個元素); 返回的陣列的執行時型別是指定陣列的執行時型別。 
     */
    public Object[] toArray() {
    //elementData:要複製的陣列;size:要複製的長度
        return Arrays.copyOf(elementData, size);
    }

個人覺得使用 Arrays.copyOf()方法主要是為了給原有陣列擴容,測試程式碼如下:

public class ArrayscopyOfTest {

	public static void main(String[] args) {
		int[] a = new int[3];
		a[0] = 0;
		a[1] = 1;
		a[2] = 2;
		int[] b = Arrays.copyOf(a, 10);
		System.out.println("b.length"+b.length);
	}
}

結果:

10

3.3 兩者聯絡和區別

聯絡:

看兩者原始碼可以發現 copyOf() 內部實際呼叫了 System.arraycopy() 方法

區別:

arraycopy() 需要目標陣列,將原陣列拷貝到你自己定義的陣列裡或者原陣列,而且可以選擇拷貝的起點和長度以及放入新陣列中的位置 copyOf() 是系統自動在內部新建一個陣列,並返回該陣列。

ensureCapacity方法

ArrayList 原始碼中有一個 ensureCapacity 方法不知道大家注意到沒有,這個方法 ArrayList 內部沒有被呼叫過,所以很顯然是提供給使用者呼叫的,那麼這個方法有什麼作用呢?

    /**
    如有必要,增加此 ArrayList 例項的容量,以確保它至少可以容納由minimum capacity引數指定的元素數。
     *
     * @param   minCapacity   所需的最小容量
     */
    public void ensureCapacity(int minCapacity) {
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
            // any size if not default element table
            ? 0
            // larger than default for default empty table. It's already
            // supposed to be at default size.
            : DEFAULT_CAPACITY;

        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
    }

最好在 add 大量元素之前用 ensureCapacity 方法,以減少增量重新分配的次數

我們通過下面的程式碼實際測試以下這個方法的效果:

public class EnsureCapacityTest {
	public static void main(String[] args) {
		ArrayList<Object> list = new ArrayList<Object>();
		final int N = 10000000;
		long startTime = System.currentTimeMillis();
		for (int i = 0; i < N; i++) {
			list.add(i);
		}
		long endTime = System.currentTimeMillis();
		System.out.println("使用ensureCapacity方法前:"+(endTime - startTime));

	}
}

執行結果:

使用ensureCapacity方法前:2158
public class EnsureCapacityTest {
    public static void main(String[] args) {
        ArrayList<Object> list = new ArrayList<Object>();
        final int N = 10000000;
        list = new ArrayList<Object>();
        long startTime1 = System.currentTimeMillis();
        list.ensureCapacity(N);
        for (int i = 0; i < N; i++) {
            list.add(i);
        }
        long endTime1 = System.currentTimeMillis();
        System.out.println("使用ensureCapacity方法後:"+(endTime1 - startTime1));
    }
}

執行結果:


使用ensureCapacity方法前:1773

通過執行結果,我們可以看出向 ArrayList 新增大量元素之前最好先使用ensureCapacity 方法,以減少增量重新分配的次數。

相關文章