Java8 ArrayList数据结构以及常用方法源码详解

目录

数据结构

字段说明

构造方法说明

常用方法以及源码解释

add(E e)

add(int index, E element)

addAll(Collection c)

get(int index)

set(int index, E element)

remove(int index)

size()、isEmpty()

contains(Object o)

lastIndexOf(Object o)

clear()

clone()

 toArray()

toArray(T[] a)

iterator()

listIterator()

总结


数据结构

ArrayList的数据结构比较简单,就是数组,其实就是把数组封装了一下。

字段说明

//数组默认容量(也是初始容量,添加第一个元素的时候初始化为该容量)
private static final int DEFAULT_CAPACITY = 10;
//效果和DEFAULTCAPACITY_EMPTY_ELEMENTDATA 是一样的
private static final Object[] EMPTY_ELEMENTDATA = {};
//创建list的时候如果使用的是无参数的构造方法,那么会把该值赋给elementData(添加第一个元素的时候会将容量扩展为10)
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
//list的数据就是存储在该数组里面的
transient Object[] elementData;
//数组中元素的个数(注意不是数组大小)
private int size;
//记录list的修改次数
protected transient int modCount = 0;

构造方法说明

构造方法有三个

//带初始容量的构造方法
public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            //根据传入的值,创建一个Object类型的数组
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            //
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }
public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
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;
        }
    }

常用方法以及源码解释

add(E e)

//入参是要添加的值
//这个方法的执行流程和是否指定初始容量有关
//这儿假设没有指定初始容量,都使用默认值
public boolean add(E e) {
        //容量校验(是否需要扩容),size是数组中元素的个数,一开始肯定是0
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //扩容完成以后,往数组中添加元素,并且数组元素数量(size)加1
        elementData[size++] = e;
        return true;
}

//入参是原来数组元素数量加1,如果添加第一个元素,minCapacity就是1
private void ensureCapacityInternal(int minCapacity) {
        /*判断数组是否为空数组(这儿还要看在创建ArrayList对象的时候是否制定初始容量)
        如果指定了,elementData就不是空数组了,这儿的if也不会执行
        如果没有指定,minCapacity就是默认容量(10)和minCapacity之间较大的一个,假设添加第一个元素,那么minCapacity的最终值就是10
        minCapacity的字面意思就是最小容量
        */
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
}

//入参是数组默认容量和数组最新元素数量(包含将要增加的这个元素)之间的较大值
private void ensureExplicitCapacity(int minCapacity) {
        //记录修改次数
        modCount++;

        //是否需要扩容,如果添加的是第一个元素,则会进入if(添加第一个元素的时候这儿其实也相当于创建一个容量为10的空数组,也就是数组初始化)
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
}

//入参是新数组要达到的最小容量
private void grow(int minCapacity) {
        //旧数组的大小
        int oldCapacity = elementData.length;
        //新数组大小为旧数组大小的1.5倍,添加第一个元素的时候,这儿得到的newCapacity 还是0
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            //添加第一个元素的时候就会执行这一步
            newCapacity = minCapacity;
        //判断是否超过最大值(该条件同样可以不考虑,在达到最大值之前一般都是内存也撑不住)
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity); //hugeCapacity方法逻辑看下面
        //扩容,其实也就是数组复制,复制过程看下面
        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;
}

/*Arrays中的数组复制方法
original 源数组
newLength  要返回的新数组的大小
*/
public static <T> T[] copyOf(T[] original, int newLength) {
        return (T[]) copyOf(original, newLength, original.getClass());
}

/*
original   源数组
newLength  要返回的新数组的大小
newType    源数组的类型
*/
public static <T,U> T[] copyOf(U[] original, int newLength,
                              Class<? extends T[]>  newType) {
        @SuppressWarnings("unchecked")
        //创建一个大小为newLength的新数组
        T[] copy = ((Object)newType == (Object)Object[].class)
            ? (T[]) new Object[newLength]
            : (T[]) Array.newInstance(newType.getComponentType(), newLength);
        //将源数组中的数据复制到新创建的数组中
        System.arraycopy(original, 0, copy, 0, Math.min(original.length, newLength));
        return copy;
}

/*
最底层的数组复制是一个native方法,也就是说不是通过java语言实现的(主要是C或者C++,java可以通过JNI调用)
src      源数组(the source array)
srcPos   源数组起始位置(the source array)
dest     目标数组(the destination array)
destPos  目标数组中的起始位置(starting position in the destination data)
length   要复制的数据数量(the number of array elements to be copied)
*/
public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos,
                                        int length);

大体的扩容逻辑其实就是:假如当前数组的容量是10,添加前10个元素的时候不会触发扩容(添加第一个元素的扩容不算在内),添加第11个元素的时候,发现11已经大于数组容量,就会创建一个新数组(容量为源数组的1.5倍,也就是15),然后数组复制。

add(int index, E element)

/*在指定位置插入,还是先进行一个数组复制,也就是从指定位置开始,把元素都往后移一个,然后将指定位置的元素用新值覆盖
*/
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++;
    }

addAll(Collection<? extends E> c)

/*
数组复制啊啊啊
*/
public boolean addAll(Collection<? extends E> c) {
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }

get(int index)

public E get(int index) {
        //校验下标是否越界
        rangeCheck(index);
        return elementData(index);
    }


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

set(int index, E element)

//将idex位置的值替换成传入的值,并将旧值返回
public E set(int index, E element) {
        //校验下标是否越界
        rangeCheck(index);
        //先取出旧值
        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }

remove(int index)

/*
同样的数组复制,就是往前挪一个位置,然后将最后一个有效元素置为null
*/
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;
    }

size()、isEmpty()

都很简单

 public int size() {
        return size;
    }

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

contains(Object o)

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

//循环数组中每个元素,然后通过equals方法比较是否相等,如果相等则返回下标,如果不存在则返回-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;
    }

lastIndexOf(Object o)

//从数组的尾部开始查找,如果找到返回下标,返回的是数组中最后一次出现的下标
public int lastIndexOf(Object o) {
        if (o == null) {
            for (int i = size-1; i >= 0; i--)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = size-1; i >= 0; i--)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

clear()

public void clear() {
        modCount++;

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

        size = 0;
    }

clone()

/**
     * Returns a shallow copy of this <tt>ArrayList</tt> instance.  (The
     * elements themselves are not copied.)
     *
     * @return a clone of this <tt>ArrayList</tt> instance
可以看出克隆方法也是通过数组复制完成的
     */
public Object clone() {
        try {
            ArrayList<?> v = (ArrayList<?>) super.clone();
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError(e);
        }
    }

 toArray()

//数组复制
public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

toArray(T[] a)

//还是数组复制(一招数组复制走天下)
public <T> T[] toArray(T[] a) {
        if (a.length < size)
            // Make a new array of a's runtime type, but my contents:
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }

iterator()

普通的迭代器

//返回对象是ArrayList的一个内部类对象
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
        int expectedModCount = modCount;

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

        ...
    }

listIterator()

优化的迭代器,在普通迭代器的基础上增加了set、add,还可以向前遍历(从指定的位置开始向前/向后遍历)

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


    /*
    既可以后遍历,也可以向前遍历,还可以执行set和add
    继承了内部类Itr
    */
    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();
            }
        }
    }

总结

ArrayList就是封装了数组的类,只不过在用的过程中我们不用像用普通数组一样小心翼翼的,越界什么的都是ArrayList帮我们处理了,所以我们不用去关心,而且里面好多的功能都是通过数组复制完成,数组复制涉及到以下三个方法,把这三个方法的参数意思都掌握了有助于理解Array的很多逻辑:

Arrays类:

public static <T> T[] copyOf(T[] original, int newLength)

public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType)

System类:

public static native void arraycopy(Object src,  int  srcPos, Object dest, int destPos, int length);

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值