集合框架 (第 03 篇) 源码分析:ArrayList

一、集合框架源码分析

原文持续更新链接: https://github.com/about-cloud/JavaCore

正文


本文关注点

★★★★★本文重点:ArrayList自动扩容机制(1.5倍或1.5倍-1 扩容)


一、ArrayList

ArrayList是动态数组,其动态性体现在能够动态扩容动态缩容。(其原理是构建一个新Object数组,将原数组复制进去。借助 Arrays.copyOf(T[] original, int newLength))

ArrayList继承关系

重要的属性

// 默认初始容量为 10(当ArrayList的容量低于9时才会用到)
private static final int DEFAULT_CAPACITY = 10;
// 存放数据的数组,数组的每个位置并不一定都填充数据,用transient修饰避免序列化、避免浪费资源
transient Object[] elementData;
// 记录实际存放的元素个数
private int size;
// 记录着ArrayList的修改次数,也就每次add或remove,它的值都会加1
protected transient int modCount = 0;

1.1、一般添加元素的方法 public boolean add(E e)

public boolean add(E e) {
    // modCount++,并且校验容量,不够用就扩容
    ensureCapacityInternal(size + 1);  // 增加 modCount
    // 将新元素添加到新数组size位置,并将size加1(千万不要理解成将新元素添加到size+1的位置)
    elementData[size++] = e;
    return true;
}

// 确保容量够用
private void ensureCapacityInternal(int minCapacity) {
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
    }

    ensureExplicitCapacity(minCapacity);
}

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;
    // 下标溢出表示容量不够用
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

本文重点方法★★★★★ ArrayList 扩容方法 grow(int minCapacity)

// 扩容方法
private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    // ArrayList 的扩容是 1.5 倍 或 1.5 倍 - 1
    // oldCapacity为偶数按1.5倍扩容,oldCapacity为奇数按1.5倍-1扩容
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 该拷贝为深拷贝,将原来的数组复制到新的数组并返回新的数组
    elementData = java.util.Arrays.copyOf(elementData, newCapacity);
}

虽然上面的代码不多,但是添加元素遇到经常扩容的现象要格外留心,因为频繁的扩容势必带来频繁的数组拷贝,这会大大牺牲性能,所以有必要在 ArrayList 初始化时指定容量。初始化的容量也不要太大于实际存储容量,不然会造成空间浪费,所以都要权衡利弊。

1.2、在指定位子添加方法 public void add(int index, E element)

// 注意:在指定 index 位置添加元素,并不会覆盖该处的元素,而是 index位置及其之后的元素后移
public void add(int index, E element) {
    // 只要有index,必定会检查range
    rangeCheckForAdd(index);
    // 确保容量够用(否则就扩容)
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 这里是在指定位置index添加元素的关键:从index处,将数据后移 1 位,空出index处给新元素用
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 上一步已将index处的位置空出来,现在将新元素添加到index处
    elementData[index] = element;
    // 实际存储的元素数加1
    size++;
}

2.1、删除元素 public boolean remove(Object o)

public boolean remove(Object o) {
    // 两种情况,被删除的元素是否为 null
    // for 循环遍历、判断、删除(请注意:千万不要使用 foreach 进行删除!!!)
    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;
            }
    }
    // 如果删除了,返回为true,否则返回false。
    return false;
}

/*
 * Private remove method that skips bounds checking and does not
 * return the value removed.
 * 跳过边界检查的私有移除方法,并且不返回删除的值
 */
private void fastRemove(int index) {
    modCount++;
    int numMoved = size - index - 1;
    if (numMoved > 0)
        // 重点在这里,数据向前移动
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // 清除 size-1 位置上的元素(设置空引用),让GC去收集该元素,同时 size 减 1
    elementData[--size] = null; 
}

注意:

  1. 如果存在多个对象o,仅仅删除距离 index = 0 处最近的一个元素;
  2. 元素被删除后,该位置不会空出来,后面的元素会前移。

所以 ArrayList 适合读多删少场景。

3、重新设置指定index位置的元素值 public E set(int index, E element)

public E set(int index, E element) {
    // 有index,必检查
    rangeCheck(index);
    // 返回旧的(被重置的)元素
    E oldValue = elementData(index);
    // 直接把 index位置的元素覆盖掉行了
    elementData[index] = element;
    return oldValue;
}

4、获取指定index位置的元素 public E get(int index)

public E get(int index) {
   // 还是那句话,凡是遇到index索引,必检查
    rangeCheck(index);
    // 直接返回index的元素,数组查询还不快吗。
    return elementData(index);
}

E elementData(int index) {
    // 因为 ArrayList 本质上是个数组,直接通过index获取元素
    return (E) elementData[index];
}

5、判断元素是否存储 public boolean contains(Object o) 判断是否存在某个元素

public boolean contains(Object o) {
    // 简单粗暴,直接遍历查看index是否大于0
    return indexOf(o) >= 0;
}

// 查找元素是否存在,如果存在返回下标,否则返回 -1
public int indexOf(Object o) {
    // 遍历的时候分两种情况,是否为 null
    if (o == null) {
        for (int i = 0; i < size; i++)
            if (elementData[i]==null)
                return i;
    } else {
        for (int i = 0; i < size; i++)
            // 用 equals 判断值是否相等
            if (o.equals(elementData[i]))
                return i;
    }
    return -1;
}

二、ArrayList的亲兄弟 Vector

Vector 的大部分方法是被 synchronized 修饰的。
线程安全的ArrayList,几乎所有的方法都加 synchronized 修饰;


三、Stack

Stack 继承至 Vector,是一个后进先出LIFO的队列。
它实现了一个标准的 后进先出LIFO 的栈。

原文持续更新链接: https://github.com/about-cloud/JavaCore

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352

推荐阅读更多精彩内容