java-ArrayList源码简单浅析

作者: AmeeLove | 来源:发表于2019-01-04 21:13 被阅读2次

ArrayList源码简单浅析
ArrayList 应该是开发中用的最多的集合对象了，ArrayList是可以动态增长和缩减的索引序列，它是基于数组实现的List类。

一些定义

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    private static final long serialVersionUID = 8683452581122892189L;

    //默认容量大小
    private static final int DEFAULT_CAPACITY = 10;
    // 默认空的数组
    private static final Object[] EMPTY_ELEMENTDATA = {};

    //默认空容量的数组
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //维护的数组，用来存入元素
    transient Object[] elementData; 

 // 实际元素个数
    private int size;

构造方法

//无参数的构造方法 初始化数组为空
  public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
    //带容量参数的构造方法
    public ArrayList(int initialCapacity) {
    //判断容量是否大于0
        if (initialCapacity > 0) {
        //new 一个initialCapacity 大小的数组
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
        //初始化为空数组
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
        //initialCapacity 小于0 抛出异常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }
    //带集合的构造方法
    public ArrayList(Collection<? extends E> c) {
    //将集合转换为数组 并赋值给当前的容器数组
        elementData = c.toArray();
        //判断长度是不是为空
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            //这里判断返回值是否为Object类不是就赋值复制
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // replace with empty array. 如果是Object就赋值为空数组
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

c.toArray might (incorrectly) not return Object[] (see 6260652)

这里主要是list.toArray()实现方式不一样，导致返回的数组真实类型不一样

//java.util.Arrays$ArrayList
    @Override
    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {
        int size = size();
        if (a.length < size)
            return Arrays.copyOf(this.a, size,
                    (Class<? extends T[]>) a.getClass());
        System.arraycopy(this.a, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }
     //java.util.ArrayList
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

add方法

 public boolean add(E e) {
     //操作次数+1
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

ensureCapacityInternal

 private void ensureCapacityInternal(int minCapacity) {
 //判断当前是不是空
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        //如果是就DEFAULT_CAPACITY =10 ，minCapacity=size+1第一次是1 取大值和所以第一次 minCapacity =10
    
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
    //第二次 elementData 不是空 minCapacity =size+1,
        ensureExplicitCapacity(minCapacity);
    }

ensureExplicitCapacity

 private void ensureExplicitCapacity(int minCapacity) {
 //修改次数+1
        modCount++;
    //第一次10 -10不会执行
        // overflow-conscious code 
        //第二次，elementData不是空的数组了
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

minCapacity如果大于了实际elementData的长度，那么就说明elementData数组的长度不够用，不够用那么就要增加elementData的length。这里有的同学就会模糊minCapacity到底是什么呢，这里给你们分析一下：

第一种情况：由于elementData初始化时是空的数组，那么第一次add的时候，minCapacity=size+1；也就minCapacity=1，在上一个方法(确定内部容量ensureCapacityInternal)就会判断出是空的数组，就会给
将minCapacity=10，到这一步为止，还没有改变elementData的大小，
第二种情况：elementData不是空的数组了，那么在add的时候，minCapacity=size+1；也就是minCapacity代表着elementData中增加之后的实际数据个数，拿着它判断elementData的length是否够用，如果length
不够用，那么肯定要扩大容量，不然增加的这个元素就会溢出。
grow 扩容量 1.5倍

 private void grow(int minCapacity) {
        // 获取数组的长度
        int oldCapacity = elementData.length;
        //新长度=旧长度+旧长度/2
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //判断新长茺-最小的是否小于0 
        if (newCapacity - minCapacity < 0)
        //小于0，说明新长度还是不够，直接赋值minCapacity
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
        //大于0
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        //复制整个数组的元素到新数组，并赋值加原数组
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

hugeCapacity

   private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
private static int hugeCapacity(int minCapacity) {
//判断是容量是否正常量
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
            //如果比最大允许的容量还大就取Integer最大值，否则就使用MAX_ARRAY_SIZE
        return (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE;
    }

添加元素完成

public void add(int index, E element) 添加到指定位置

 public void add(int index, E element) {
 //较验下标是允许的范围内
        rangeCheckForAdd(index);
        //判断是否要扩容 上面的步骤
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //从下标index+1的开始的元素向后移到一位
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
                         //赋值
        elementData[index] = element;
        //元素大小+1
        size++;
    }

rangeCheckForAdd

 private void rangeCheckForAdd(int index) {
 //下标是否小于0 或者比元素个数还大 抛出下标越界异常 IndexOutOfBoundsException
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }


    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

set方法

 public E set(int index, E element) {
 // 较验下标是允许的范围内
        rangeCheck(index);
    //找到下标的元素
        E oldValue = elementData(index);
        //赋值为新值
        elementData[index] = element;
        //返回旧值
        return oldValue;
    }

elementData
这个就是数组[index]

    @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }

包含 contains

 public boolean contains(Object o) {
 //大于0就说明找到
        return indexOf(o) >= 0;
    }

indexOf

//循环查找找到就返回索引，找不到返回-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;
    }

size

public int size() {
//返回元素的个数
        return size;
    }


    public boolean isEmpty() {
    //元素个数是否为空
        return size == 0;
    }

remove(int index)

下标较验

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

remove

public E remove(int index) {
//判断索引下标是否正常
        rangeCheck(index);
    //修改次数+1 
        modCount++;
        //获取这个下标上的元素
        E oldValue = elementData(index);
        //要移动的长度 元素个数-下标索引-1     
        // 比如：1,2,3,4,5 ,6  index是3 (值是4) size 6, 6 -3 -1 移动2位
        int numMoved = size - index - 1;
        //判断是否大于0，如果是最后一位就不用
        if (numMoved > 0)
        //从下标+1位，向前移动1位，移动的长度是numMoved 
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
                             //元素最后一位赋值为空，并且数量-1
        elementData[--size] = null; // clear to let GC do its work
        //返回旧值
        return oldValue;
    }

remove(Object obj)

和上面的原理基本相同，但是要先找到这个元素的下标索引

 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;
    }

fastRemove

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
    }

clear 方法清空数组

 public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
        //每个值都设置为空
            elementData[i] = null;
        
        //最后元素个数设置为0
        size = 0;
    }

transient Object[] elementData;

transient 标记的字段表示序列化是不参与序列化，但ArrayList又实现的Serializable接口

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

实际上ArrayList重写了序列化、反序列化方法
因为elementData会扩容量,如果直接序列化会写入很多NULL值，这时只序列化，实际的元素个数，反序列化也一样
先把元素个数写入，再循环写入每个元素
反序列化，先读取元素个数，再循环读出每个元素

   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) {
            // be like clone(), allocate array based upon size not capacity
            ensureCapacityInternal(size);

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

java-ArrayList源码简单浅析

一些定义

构造方法

c.toArray might (incorrectly) not return Object[] (see 6260652)

add方法

public void add(int index, E element) 添加到指定位置

set方法

包含 contains

indexOf

size

remove(int index)

remove(Object obj)

clear 方法清空数组

transient Object[] elementData;

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Java 杂谈