源碼閱讀之ArrayList

源碼閱讀是基于JDK7肾筐,本篇主要涉及ArrayList常用方法源碼分析哆料。

1.概述
ArrayList是List接口的可調(diào)整大小的數(shù)組實(shí)現(xiàn),可以包含任何類型的元素吗铐,包括null东亦。除了實(shí)現(xiàn)List接口中的方法,它還提供了調(diào)整元素?cái)?shù)組大小的方法抓歼。這個類除了非同步的特性讥此,大體上和Vector是相同的。它的size谣妻、isEmpty、get卒稳、set方法運(yùn)行時間為常數(shù)蹋半,而add方法運(yùn)行開銷為分?jǐn)偟某?shù),添加n個元素的時間復(fù)雜度是O(n)充坑。每個ArrayList的實(shí)例都有自己的容量减江,這個容量即用于存儲List元素的數(shù)組大小,它的大小要大于等于數(shù)組實(shí)際存儲的元素?cái)?shù)捻爷,當(dāng)元素被添加到ArrayList時辈灼,它的容量會自動擴(kuò)容。當(dāng)需要添加大量的元素到ArrayList中也榄,最好提前給ArrayList設(shè)置合適的初始容量巡莹,這樣可以減少增量式的內(nèi)存再分配次數(shù)司志。ArrayList的實(shí)現(xiàn)方式是非同步的(非線程安全的),所以當(dāng)多線程同時訪問的時候降宅,如果有線程從結(jié)構(gòu)上做了修改(指任何添加或刪除一個或多個元素的操作骂远,或者顯式調(diào)整底層數(shù)組的大小,僅僅設(shè)置元素的值不是結(jié)構(gòu)上的修改)腰根,需要在使用它的地方做同步控制激才,源碼里提供了使用List list = Collections.synchronizedList(new ArrayList(...))方式做同步,這個不推薦额嘿,這種方式只是在原有方法上加了同步控制瘸恼,對于有些使用場景沒有針對性,如果真的需要線程安全的操作册养,推薦使用Vector或concurrent并發(fā)包下的CopyOnWriteArrayList东帅。

2.數(shù)據(jù)結(jié)構(gòu)
ArrayList類的聲明代碼如下,

    public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable

由上面的代碼段可以得出如下所示的類圖捕儒,

Paste_Image.png

ArrayList中聲明了如下一些屬性冰啃,

private static final int DEFAULT_CAPACITY = 10;
private transient Object[] elementData;
private int size;
protected transient int modCount = 0;
private static final Object[] EMPTY_ELEMENTDATA = {};

(1)DEFAULT_CAPACITY為默認(rèn)的初始容量,即數(shù)組的默認(rèn)大辛跤ā阎毅;
(2)elementData數(shù)組用于存儲元素;
(3)size為ArrayList中實(shí)際元素個數(shù)点弯;
(4)modCount從AbstractList繼承而來扇调,用于記錄從結(jié)構(gòu)上修改此ArrayList的次數(shù)。
(5)EMPTY_ELEMENTDATA空數(shù)組抢肛;

3.構(gòu)造方法
提供了三個構(gòu)造函數(shù)可供使用狼钮。

    //initialCapacity指定初始容量大小
    public ArrayList(int initialCapacity) {
        super();
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity];
    }

    //無參構(gòu)造方法,elementData指向EMPTY_ELEMENTDATA
    public ArrayList() {
        super();
        this.elementData = EMPTY_ELEMENTDATA;
    }

    //構(gòu)造一個包含指定元素的list捡絮,這些元素的是按照Collection的迭代器返回的順序排列的
    public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        size = elementData.length;
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    }

4.擴(kuò)容
當(dāng)添加元素的時候熬芜,檢查數(shù)組容量是否需要擴(kuò)容。

    private void ensureCapacityInternal(int minCapacity) {
        if (elementData == EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }

    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    //可分配的最大數(shù)組大小(一些虛擬機(jī)保留一些字節(jié)頭福稳,所以減8)
    //試圖分配較大容量的數(shù)組可能會導(dǎo)致OutOfMemoryError
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    //擴(kuò)展容量的時候要確保能容納minCapacity參數(shù)指定的元素的數(shù)量
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        //準(zhǔn)備新擴(kuò)容的數(shù)組長度為舊容量的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        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);
    }

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

5.size方法

    public int size() {
        return size;
    }

返回ArrayList中元素的個數(shù)涎拉。

6.isEmpty方法

     public boolean isEmpty() {
        return size == 0;
    }

判斷ArrayList中元素的個數(shù)是否為0。

7.contains方法

     public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

    public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

從前向后遍歷elementData數(shù)組的圆,匹配第一個和o相等的元素鼓拧,如果存在返回對應(yīng)元素的下標(biāo)序號,否則返回-1越妈。這里需要注意的是o.equals(elementData[i])季俩,這里是Objetc的equals方法,比較的是引用梅掠。

8.toArray方法

    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

該方法返回一個新的數(shù)組酌住,數(shù)組中的元素按照ArrayList中的第一個到最后一個順序排列店归,修改返回的數(shù)組不會影響原ArrayList中的數(shù)據(jù)。

9.get方法

    public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }
    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    E elementData(int index) {
        return (E) elementData[index];
    }

10.set方法

    public E set(int index, E element) {
        rangeCheck(index);

        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }

set方法就是給數(shù)組的指定下標(biāo)成員重新賦值赂韵。

11.add方法

    //首先進(jìn)行擴(kuò)容(是否擴(kuò)容由ensureCapacityInternal方法決定)
    //給數(shù)組的size++位置賦值為e
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

    //檢查給定的index是否正確
    //進(jìn)行擴(kuò)容(是否擴(kuò)容由ensureCapacityInternal方法決定)
    //index位置后面的元素向后移動(數(shù)組復(fù)制實(shí)現(xiàn))
    //給index下標(biāo)成員重新賦值
    public void add(int index, E element) {
        rangeCheckForAdd(index);

        ensureCapacityInternal(size + 1);  // Increments modCount!!
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        elementData[index] = element;
        size++;
    }

12.remove方法

    //刪除指定位置的元素
    //原理:將index+1位置開始到末尾的元素向前移動一位娱节,最后一位賦值為null,GC進(jìn)行回收
    public E remove(int index) {
        rangeCheck(index);

        modCount++;
        E oldValue = elementData(index);

        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

    //刪除指定內(nèi)容的元素祭示,刪除匹配的第一個元素
    //原理:將匹配的第一個元素的位置下標(biāo)加1開始到末尾的元素向前移動一位肄满,最后一位賦值為null,GC進(jìn)行回收
    public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

    //將index+1位置開始到末尾的元素向前移動一位质涛,最后一位賦值為null稠歉,GC進(jìn)行回收
    private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

13.clear方法

    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

將數(shù)組所有元素引用設(shè)置了null,ArrayList的元素個數(shù)置為0汇陆;

14.iterator方法和listIterator方法

    //返回Iterator用于遍歷ArrayList
    public Iterator<E> iterator() {
        return new Itr();
    }

    private class Itr implements Iterator<E> {
        int cursor;       // 下一個元素的索引下標(biāo)
        int lastRet = -1; // 最后一個元素的下標(biāo)怒炸,如果不存在則返回-1
        int expectedModCount = modCount;

        public boolean hasNext() {
            return cursor != size;
        }

        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }

        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.remove(lastRet);
                cursor = lastRet;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

    //從index下標(biāo)開始返回一個ListIterator
    public ListIterator<E> listIterator(int index) {
        if (index < 0 || index > size)
            throw new IndexOutOfBoundsException("Index: "+index);
        return new ListItr(index);
    }

    public ListIterator<E> listIterator() {
        return new ListItr(0);
    }

    private class ListItr extends Itr implements ListIterator<E> {
        ListItr(int index) {
            super();
            cursor = index;
        }

        public boolean hasPrevious() {
            return cursor != 0;
        }

        public int nextIndex() {
            return cursor;
        }

        public int previousIndex() {
            return cursor - 1;
        }

        @SuppressWarnings("unchecked")
        public E previous() {
            checkForComodification();
            int i = cursor - 1;
            if (i < 0)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i;
            return (E) elementData[lastRet = i];
        }

        public void set(E e) {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.set(lastRet, e);
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        public void add(E e) {
            checkForComodification();

            try {
                int i = cursor;
                ArrayList.this.add(i, e);
                cursor = i + 1;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
    }

在執(zhí)行iterator或listIterator方法時,如果有線程從結(jié)構(gòu)上做了修改(指任何添加或刪除一個或多個元素的操作毡代,或者顯式調(diào)整底層數(shù)組的大小阅羹,僅僅設(shè)置元素的值不是結(jié)構(gòu)上的修改),這兩個方法會fail-fast教寂,將會拋出ConcurrentModificationException捏鱼。迭代器的快速失敗行為無法得到保證,因?yàn)橐话銇碚f酪耕,不可能對是否出現(xiàn)不同步并發(fā)修改做出任何硬性保證导梆。快速失敗操作會盡最大努力拋出ConcurrentModificationException迂烁。因此看尼,為提高此類操作的正確性而編寫一個依賴于此異常的程序是錯誤的做法,正確做法是:ConcurrentModificationException應(yīng)該僅用于檢測bug盟步。拋異常就是為了避免數(shù)據(jù)問題而存在的藏斩,其實(shí)就是檢查modCount是否是期望值,如果不是却盘,則說明ArrayList數(shù)組被從結(jié)構(gòu)上修改了灾茁。這里是經(jīng)常會遇到的問題,使用Java的For Each方式遍歷元素時刪除匹配的元素谷炸,會拋出ConcurrentModificationException。Java中的For Each實(shí)際上使用的是iterator進(jìn)行處理的禀挫,而iterator是不允許集合在iterator使用期間刪除的旬陡。

小結(jié):
1.ArrayList是實(shí)現(xiàn)了基于動態(tài)數(shù)組的數(shù)據(jù)結(jié)構(gòu)。
2.ArrayList在每次增加元素時语婴,都要進(jìn)行擴(kuò)容判斷描孟,擴(kuò)容時都要確保足夠的容量驶睦。當(dāng)容量不足以容納當(dāng)前的元素個數(shù)時,就設(shè)置新的容量為舊的容量的1.5倍匿醒,如果新容量還不夠场航,則新容量設(shè)置為傳入的參數(shù),如果新容量還不夠廉羔,則新容量為最大容量溉痢。從中可以看出,當(dāng)容量不夠時憋他,都要將原來的元素拷貝到一個新的數(shù)組中孩饼,耗時而且還需要重新分配內(nèi)存,因此建議在事先能確定元素?cái)?shù)量的情況下竹挡,明確指明容量大小镀娶。
3.ArrayList基于數(shù)組實(shí)現(xiàn),可以通過下標(biāo)索引直接查找到指定位置的元素揪罕,因此查找效率高梯码,但每次插入或刪除元素,就要大量地移動元素好啰,效率低轩娶。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市坎怪,隨后出現(xiàn)的幾起案子罢坝,更是在濱河造成了極大的恐慌,老刑警劉巖搅窿,帶你破解...
    沈念sama閱讀 219,490評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件嘁酿,死亡現(xiàn)場離奇詭異,居然都是意外死亡男应,警方通過查閱死者的電腦和手機(jī)闹司,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來沐飘,“玉大人游桩,你說我怎么就攤上這事∧推樱” “怎么了借卧?”我有些...
    開封第一講書人閱讀 165,830評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長筛峭。 經(jīng)常有香客問我铐刘,道長,這世上最難降的妖魔是什么影晓? 我笑而不...
    開封第一講書人閱讀 58,957評論 1 295
  • 正文 為了忘掉前任镰吵,我火速辦了婚禮檩禾,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘疤祭。我一直安慰自己盼产,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,974評論 6 393
  • 文/花漫 我一把揭開白布勺馆。 她就那樣靜靜地躺著戏售,像睡著了一般。 火紅的嫁衣襯著肌膚如雪谓传。 梳的紋絲不亂的頭發(fā)上蜈项,一...
    開封第一講書人閱讀 51,754評論 1 307
  • 那天,我揣著相機(jī)與錄音续挟,去河邊找鬼紧卒。 笑死,一個胖子當(dāng)著我的面吹牛诗祸,可吹牛的內(nèi)容都是我干的跑芳。 我是一名探鬼主播,決...
    沈念sama閱讀 40,464評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼直颅,長吁一口氣:“原來是場噩夢啊……” “哼博个!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起功偿,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤盆佣,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后械荷,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體共耍,經(jīng)...
    沈念sama閱讀 45,847評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,995評論 3 338
  • 正文 我和宋清朗相戀三年吨瞎,在試婚紗的時候發(fā)現(xiàn)自己被綠了痹兜。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,137評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡颤诀,死狀恐怖字旭,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情崖叫,我是刑警寧澤遗淳,帶...
    沈念sama閱讀 35,819評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站心傀,受9級特大地震影響洲脂,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,482評論 3 331
  • 文/蒙蒙 一恐锦、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧疆液,春花似錦一铅、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至掉缺,卻和暖如春卜录,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背眶明。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評論 1 272
  • 我被黑心中介騙來泰國打工艰毒, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人搜囱。 一個月前我還...
    沈念sama閱讀 48,409評論 3 373
  • 正文 我出身青樓丑瞧,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蜀肘。 傳聞我的和親對象是個殘疾皇子绊汹,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,086評論 2 355

推薦閱讀更多精彩內(nèi)容