ArrayList源码分析

1.概述

ArrayList实现了List接口,元素存放的数据与放进去的顺序相同,允许放入null元素,底层通过数组实现,支持自动扩容。

2.类图

List类图

由类图可知ArrayList实现了4个接口,分别是:

  • List接口,提供数组的添加、删除、修改、迭代遍历等操作
  • RandomAccess 接口,表示 ArrayList 支持快速的随机访问
  • Serializabel接口,支持序列化功能
  • Cloneable接口,支持克隆

3.属性

//无参构造添加第一个元素时会默认初始化容量
private static final int DEFAULT_CAPACITY = 10;
//空的数组
private static final Object[] EMPTY_ELEMENTDATA = {};
//无参构造默认的数组地址
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
//元素数组,当初始化无参构造数组时,会默认this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA,目的是节省空间,因为不确定是否使用该集合,当第一次添加元素后,会将容量大小设置为10
//当添加第一个元素时,会将数组扩大至DEFAULT_CAPACITY容量
transient Object[] elementData; 
//数组时机大小
private int size;

ArrayList

  • elementData属性

    元素数组,构造一个空ArrayList时,该属性被初始化DEFAULTCAPACITY_EMPTY_ELEMENTDATA;图中红色空格代表我们已经添加元素,白色空格代表我们并未使用。

  • size属性

    数组大小。注意,size 代表的是 ArrayList 已使用 elementData 的元素的数量,对于开发者看到的 #size() 也是该大小。并且,当我们添加新的元素时,恰好其就是元素添加到 elementData 的位置(下标)。当然,我们知道 ArrayList真正的大小是 elementData 的大小。

4.构造方法

4.1无参构造
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
public ArrayList() {
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
4.2有参构造-初始化数组大小
private static final Object[] EMPTY_ELEMENTDATA = {};
public ArrayList(int initialCapacity) {
    if (initialCapacity > 0) {
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    }
}
4.3有参构造-传入集合
public ArrayList(Collection<? extends E> c) {
    elementData = c.toArray();
    if ((size = elementData.length) != 0) {
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    } else {
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

5.添加元素

5.1添加单个元素
/**
 * 添加单个元素
 */
public boolean add(E e) {
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;
    return true;
}
private void ensureCapacityInternal(int minCapacity) {
    //当无参构造初始化集合时,第一次添加元素初始化数组容量为10
    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);
}

5.2指定位置添加一个元素
public void add(int index, E element) {
    //校验索引是否非法
    rangeCheckForAdd(index);
	//修改modcount次数,增加容量
    ensureCapacityInternal(size + 1); 
    //从index+1位置复制数组
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    elementData[index] = element;
    size++;
}

ArrayList_add

6.数组容量

6.1数组扩容
private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        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;
    }

ArrayList_grow

6.2数组缩容
public void trimToSize() {
    modCount++;
    if (size < elementData.length) {
        elementData = (size == 0)
            ? EMPTY_ELEMENTDATA
            : Arrays.copyOf(elementData, size);
    }
}

7.移除元素

7.1移除元素
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
}

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
}
7.2移除多个元素
public boolean removeAll(Collection<?> c) {
    Objects.requireNonNull(c);
    return batchRemove(c, false);
}
private boolean batchRemove(Collection<?> c, boolean complement) {
    final Object[] elementData = this.elementData;
    int r = 0, w = 0;
    boolean modified = false;
    try {
        for (; r < size; r++)
            if (c.contains(elementData[r]) == complement)
                elementData[w++] = elementData[r];
    } finally {
        // Preserve behavioral compatibility with AbstractCollection,
        // even if c.contains() throws.
        //如果 contains 方法发生异常执行该方法
        if (r != size) {
            //elementData就是数组前r+1个元素不变,后面的元素从第w个元素开始替换到size-r长度结束,其中[w-size-r]元素的值分别对应着[elementData[r+1]-elementData[size-r]]的值
            System.arraycopy(elementData, r,
                             elementData, w,
                             size - r);
            w += size - r;
        }
        if (w != size) {
            // clear to let GC do its work
            for (int i = w; i < size; i++)
                elementData[i] = null;
            modCount += size - w;
            size = w;
            modified = true;
        }
    }
    return modified;
}

8.查找元素

8.1查找单个元素
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;
}
8.2获取指定位置的元素
public E get(int index) {
    rangeCheck(index);

    return elementData(index);
}

9.序列化

为什么ArrayList会自定义序列化方法?因为ArrayList数组elementData中有未使用的空间,如果没有使用的空间也序列化,势必会影响性能。

序列化集合
//transient阻止序列化
transient Object[] elementData; 

/**
 * writeObject方法将其示例序列化
 */
private void writeObject(java.io.ObjectOutputStream s)
    throws java.io.IOException{
    // Write out element count, and any hidden stuff
    int expectedModCount = modCount;
    s.defaultWriteObject();

    // Write out size as capacity for behavioural compatibility with clone()
    s.writeInt(size);

    // Write out all elements in the proper order.
    for (int i=0; i<size; i++) {
        s.writeObject(elementData[i]);
    }

    if (modCount != expectedModCount) {
        throw new ConcurrentModificationException();
    }
}
反序列化
private void readObject(java.io.ObjectInputStream s)
    throws java.io.IOException, ClassNotFoundException {
    elementData = EMPTY_ELEMENTDATA;

    // Read in size, and any hidden stuff
    s.defaultReadObject();

    // Read in capacity
    s.readInt(); // ignored

    if (size > 0) {
        ensureCapacityInternal(size);

        Object[] a = elementData;
        // Read in all elements in the proper order.
        for (int i=0; i<size; i++) {
            a[i] = s.readObject();
        }
    }
}

10.创建 Iterator 迭代器

public Iterator<E> iterator() {
    return new Itr();
}
/**
 * 迭代器代码
 */
private class Itr implements Iterator<E> {
    //游标
    int cursor;       // index of next element to return
    int lastRet = -1; // index of last element returned; -1 if no such
    //每修改一次list集合,modCount+1
    int expectedModCount = modCount;

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

    @SuppressWarnings("unchecked")
    public E next() {
        //<1> 校验expectedModCount = modCount是否相等
        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();
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer<? super E> consumer) {
        Objects.requireNonNull(consumer);
        final int size = ArrayList.this.size;
        int i = cursor;
        if (i >= size) {
            return;
        }
        final Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length) {
            throw new ConcurrentModificationException();
        }
        while (i != size && modCount == expectedModCount) {
            consumer.accept((E) elementData[i++]);
        }
        // update once at end of iteration to reduce heap write traffic
        cursor = i;
        lastRet = i - 1;
        checkForComodification();
    }
    
    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}
  • checkForComodification比较modCount != expectedModCount值不相等抛出ConcurrentModificationException异常
  • #hasNext方法判断游标有没有达到最后位置
  • #next方法,每次移动一次,游标cursor+1
  • #remove方法,会重新调用集合的remove方法,并且重新初始化expectedModCount = modCount,所以用迭代器遍历删除元素不会抛出ConcurrentModificationException异常

11.三种for循环移除元素结果对比

  • fori

    //结果输出 1和3
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("1");
        list.add("2");
        list.add("3");
    
        for (int i = 0; i < list.size(); i++) {
            if (list.get(i).equals("2")) {
                list.remove("2");
            }
            System.out.println(list.get(i));
        }
    }
    
  • 增强for组合remove

    增强for本质上是利用迭代器遍历,内部通过判断modCount != expectedModCount是否相等来决定是否抛出异常,当调用list本身的remove方法后,会更新modCount值,但是迭代器中的expectedModCount值未更新,导致抛出异常。

    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("1");
        list.add("2");
        list.add("3");
    
        System.out.println(list.size());
        for (String s : list) {
            if ("1".equals(s)) {
                list.remove(s);
            }
        }
    
    }
    
  • 迭代器组合迭代器的remove

    迭代器的remove与list的remove区别就是,当调用迭代器的方法后,会在最后将modCount的值同步给expectedModCount,所以不会报错。迭代器remove方法如下:

    ArrayList.this.remove(lastRet);
    cursor = lastRet;
    lastRet = -1;
    expectedModCount = modCount;
    
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("1");
        list.add("2");
        list.add("3");
        Iterator<String> iterator = list.iterator();
        while (iterator.hasNext()) {
            if ("1".equals(iterator.next())) {
                iterator.remove();
            }
        }
    }
    

小结

  • ArrayList 是基于 [] 数组实现的 List 实现类,支持在数组容量不够时,一般按照 1.5自动扩容。同时,它支持手动扩容、手动缩容。
  • ArrayList 随机访问时间复杂度是 O(1) ,查找指定元素的平均时间复杂度是 O(n) 。
  • ArrayList 移除指定位置的元素的最好时间复杂度是 O(1) ,最坏时间复杂度是 O(n) ,平均时间复杂度是 O(n)
  • ArrayList 移除指定元素的时间复杂度是 O(n) 。
  • ArrayList添加元素的最好时间复杂度是 O(1) ,最坏时间复杂度是 O(n) ,平均时间复杂度是 O(n) 。
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值