探索Vector的底层实现

背景

上周发布了探索ArrayList的底层实现,趁热打铁!实际上ArrayListVector的实现上非常相似,代码基本上都是一样的,还是老样子,先看注释,我能说注释都差不多一样吗。探索Vector源代码是基于JDK1.8的。

阅读注释

Vector注释-1

Vector内部是通过动态数组实现的。

Vector注释-2

Vector可自定义扩容的大小,若没有指定则默认翻倍,即2倍关系(100%),ArrayList默认是1.5倍关系(50%)

Vector注释-3

截图中应该讲的挺明白了!

Vector注释-4

又是快速失败!

Vector注释-5

需要线程安全的情况下使用Vector,不需要则推荐使用ArrayList。

数据结构


    //支持序列化、可克隆、随机访问
    public class Vector<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {

        //存储元素的数组缓冲区
        //Vector的容量大小就是数组缓冲区的长度大小
        //Vector中排在最后一个元素后面的元素内容都是null,实际上指的是数组长度过大,未存满内容
        protected Object[] elementData;

        //数组中实际元素的个数,指的是包含多少元素,称作有效元素
        protected int elementCount;

        //当容量不足时,指定容量需要扩充的大小
        //若该值小于或等于0,则当容量不足时采用翻倍的方式扩充大小
        protected int capacityIncrement;

        //我们都知道定义一个数组的大小是 int 类型,那么也就意味着最大的数组大小应该是Integer.MAX_VALUE,但是这里为啥要减去8呢?
        //查阅资源发现大部分的人都在说8个字节是用来存储数组的大小,半信半疑
        //分配最大数组,某些VM会在数组中存储header word,按照上面的说法指的应该是数组的大小
        //若尝试去分配更大的数组可能会造成 OutOfMemoryError: 定义的数组大小超过VM上限
        //不同的操作系统对于不同的JDK可能分配的内存会有所差异,所以8这个数字可能是为了保险起见
        private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

        //Vector结构被修改的次数
        //该字段主要针对迭代器与子集使用,若该属性被出乎意料的改变了,调用迭代器的相关方法,如 next、 remove、previous、set、add
        //则会抛出 ConcurrentModificationException常,该情况其实就是上面提到的fail-fast
        //严格上来说,该字段并不算是结构被修改的次数,在判断是否需要扩容时,它是首先进行增加在判断,不过这不影响,该字段仅用来判断是否与其他字段相等
        protected transient int modCount = 0;
    }

构造函数


    /**
     * 构造一个指定初始容量大小与指定容量增长速率的空数组
     * 若initialCapacity小于0,则抛出参数异常
     * @param initialCapacity 初始容量大小
     * @param capacityIncrement 当容量不足时,容量扩充的大小
     */
    public Vector(int initialCapacity, int capacityIncrement) {
        super();
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity];
        this.capacityIncrement = capacityIncrement;
    }

    /**
     * 构造一个指定初始容量大小的空数组
     * 由于未指定容量增长速率,故而采用翻倍的机制
     * @param initialCapacity 初始容量大小
     */
    public Vector(int initialCapacity) {
        this(initialCapacity, 0);
    }

    /**
     * 构造一个初始容量为10的空数组
     */
    public Vector() {
        this(10);
    }

    /**
     * 构建一个包含指定collection集合的数组,这些元素按照迭代器的顺序排列
     * collection集合类型有Map、set、List等子类,所以入参可以是多种类型
     * collection集合转换成数组,elementData指向该数组,elementCount成员属性被赋值为collection集合长度
     * 判断数组类型是否是Ojbect[],若不是则创建一个新的数组,并拷贝elementData数组中的内容
     * @param c 指定集合
     */
    public Vector(Collection<? extends E> c) {
        elementData = c.toArray();
        elementCount = elementData.length;
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, elementCount, Object[].class);
    }

  • 若已经提前知道数组容量,则建议使用new Vector(initialCapacity)

  • 若不知道数组容量的话,那就没办法了

  • Vector(Collection c)一般是在包含关系的情况下使用

方法说明

接下来按照类的声明顺序介绍方法,有必要的情况下结合例子进行说明。

简单方法

    /**
     * 拷贝数组中的有效元素到指定数组中
     * 指定数组不能为null
     * 指定数组的容量大小不能小于Vector中数组的容量大小
     * 指定数组的类型必须能够存储Vector中数组的元素类型
     * @param anArray 指定数组
     */
    public synchronized void copyInto(Object[] anArray) {
        System.arraycopy(elementData, 0, anArray, 0, elementCount);
    }

    /**
     * 缩小Vector的容量到当前数组的大小,应用可以调用该方法来最小化Vector的存储空间,简单来说就是节约空间,去掉没有用到的剩余数组空间
     * elementCount 是指数组的有效元素,实实在在的大小,而 elementData.length 是数组的总容量大小,也就是说只有当填充/删除元素时elementCount的大小才会变化
     * 而当进行扩容时 elementData.length 才会变化,毕竟数组的长度变大了
     */
    public synchronized void trimToSize() {
        modCount++;
        int oldCapacity = elementData.length;
        if (elementCount < oldCapacity) {
            elementData = Arrays.copyOf(elementData, elementCount);
        }
    }

    /**
     * 根据指定的容量增大或缩小Vector的容量大小
     * 若newSize大于有效元素个数,增大的容量会使用null填充
     * 若newSize小于有效元素个数,以newSize为起始索引到结尾的元素都被置为null导致元素丢失,容量保持不变
     * 最后将 elementCount = newSize,导致在增大容量的情况下会出现null
     * 
     * 若 elementData.length > newSize > elementCount,
     * 若 newSize > elementData.length,Vector容量扩大,多余空间置null
     * 若 elementData.length > elementCount > newSize,则缩小Vector容量,导致元素丢失,容量保持不变
     * 不管大小如何,Vector的有效元素个数都变成 newSize,可能出现null
     * @param newSize 指定容量大小
     */
    public synchronized void setSize(int newSize) {
        modCount++;
        if (newSize > elementCount) {
            ensureCapacityHelper(newSize);
        } else {
            for (int i = newSize ; i < elementCount ; i++) {
                elementData[i] = null;
            }
        }
        elementCount = newSize;
    }

    /**
     * 获取数组的容量大小
     * @return 容量大小
     */
    public synchronized int capacity() {
        return elementData.length;
    }

    /**
     * 获取数组的有效元素个数
     * @return 数组有效元素个数
     */
    public synchronized int size() {
        return elementCount;
    }

    /**
     * 判断数组是否为空
     * @return 数组是否为空
     */
    public synchronized boolean isEmpty() {
        return elementCount == 0;
    }

    /**
     * 判断数组是否包含指定元素
     * @return 是否包含指定元素
     */
    public boolean contains(Object o) {
        return indexOf(o, 0) >= 0;
    }

    /**
     * 采用正向遍历的方式,获取与指定元素相等的元素的索引
     * 若存在多个元素,取第一次与指定元素相等的元素的索引
     * 若返回-1则说明不存在指定元素
     * @param o 指定元素
     * @return 与指定元素的索引
     */
    public int indexOf(Object o) {
        return indexOf(o, 0);
    }

    /**
     * 采用正向遍历的方式,根据指定起始索引开始,获取与指定元素相等的元素的索引
     * 若存在多个元素,取第一次与指定元素相等的元素的索引
     * 若不存在则返回-1
     * @param o 指定元素
     * @param index 指定起始索引
     * @return 与指定元素相等的元素的索引
     */
    public synchronized int indexOf(Object o, int index) {
        if (o == null) {
            for (int i = index ; i < elementCount ; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = index ; i < elementCount ; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

    /**
     * 采用反向遍历的方式,获取与指定元素相等的元素的索引
     * 若存在多个元素,取第一次与指定元素相等的元素的索引
     * 若不存在则返回-1
     * @param o 指定元素
     * @return 与指定元素相等的元素的索引
     */
    public synchronized int lastIndexOf(Object o) {
        return lastIndexOf(o, elementCount-1);
    }

    /**
     * 采用反向遍历的方式,根据指定起始索引开始,获取与指定元素相等的元素的索引
     * 若存在多个元素,取第一次与指定元素相等的元素的索引
     * 若不存在则返回-1
     * @param o 指定元素
     * @param index 指定起始索引
     * @return 与指定元素相等的元素的索引
     */
    public synchronized int lastIndexOf(Object o, int index) {
        if (index >= elementCount)
            throw new IndexOutOfBoundsException(index + " >= "+ elementCount);

        if (o == null) {
            for (int i = index; i >= 0; i--)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = index; i >= 0; i--)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

    /**
     * 调用该clone之前,该类要实现Cloneable,不然会抛出异常
     * 数组默认已经实现了Cloneable接口,直接调用方法即可,而且直接返回对应的类型,不需要向下转型,同时包含数组元素
     * 浅拷贝与深拷贝,举个例子吧
     * 比如A类中包含基本类型与B类,当调用A类clone方法后,两个A对象肯定是不一致,不然就不叫做拷贝了,不过这不是关键
     * 若A1对象中的B对象与A2对象中的B对象指向同一个对象,则认为它是浅拷贝,认为B没有被拷贝新的一份
     * 若两者指向不相等的话,则认为深拷贝,认为B重新拷贝了一份,不过这通常需要我们自定义代码,就像下面的方法一样
     */
    public synchronized Object clone() {
        try {
            Vector<E> v = (Vector<E>) super.clone();
            v.elementData = Arrays.copyOf(elementData, elementCount);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError(e);
        }
    }

    /**
     * 返回一个包含所有列表元素的有序(按照添加顺序)数组
     * 此方法是创建一个新数组,方便使用者能够随便操作新数组
     * @return 新数组
     */
    public synchronized Object[] toArray() {
        return Arrays.copyOf(elementData, elementCount);
    }

    /**
     * 将列表的所有元素放入到指定数组中并返回
     *
     * 注意:T类型要么是数组中数据的相同类型,要么是数组中数据的父类型,运用多态性质
     * 若传入的新数组容量 < 列表容量,则取它的类类型来创建一个包含列表元素的新数组,并返回
     * 若传入的新数组容量 > 列表容量,则将列表中的元素按照顺序拷贝到新数组中,同时将新数组中索引为size的值设置成null
     * 
     * 一开始我也好奇为啥要在索引为size上设置个null呢?
     * 看了注释加上自我的理解,若传入的新数组是个空数组的话,那么除了拷贝列表元素后剩余的所有空间的值都为null,此时在给索引为size的值设置成null似乎没有多大
     * 意思;另外一种情况是若传入的新数组不是个空数组,那这个设置就有意义了,传入的新数组的某些元素会被列表元素覆盖,同时有个null,剩下的才是自己本身的数据,呈现这样子一种效果
     *
     * List<Integer> list = new ArrayList<>();
     * list.add(11);
     *
     * Integer[] str = new Integer[]{1,2,3,4,5,6,7,8,9,10};
     * Integer[] s1 = list.toArray(str);
     *
     * for (Integer s : s1) {
     *     System.out.println(s + ",");
     * }
     *
     * 输出结果:11,null,3,4,5,6,7,8,9,10,
     * 那么设置这个null的意义就在于能够确定列表中元素个数(长度),目前我只有想到这一种情况下有用!
     *
     * @param a 指定数组
     * @return 填充完列表元素的指定数组
     */
    public synchronized <T> T[] toArray(T[] a) {
        if (a.length < elementCount)
            return (T[]) Arrays.copyOf(elementData, elementCount, a.getClass());

        System.arraycopy(elementData, 0, a, 0, elementCount);

        if (a.length > elementCount)
            a[elementCount] = null;

        return a;
    }

    /**
     * 获取数组中指定索引中的元素
     * @param index 指定索引
     * @return 指定索引的元素
     */
    E elementData(int index) {
        return (E) elementData[index];
    }

     /**
     * 清空元素
     */
    public void clear() {
        removeAllElements();
    }

    /**
     * 判断数组中是否包含指定集合中的所有元素
     * 但凡集合中有一个元素不存在数组中则返回false
     * @param c 指定集合
     * @return 数组中是否包含指定集合中的所有元素
     */
    public synchronized boolean containsAll(Collection<?> c) {
        return super.containsAll(c);
    }

    /**
     * 集合与数组取交集
     * 最终数组中只包含与集合共有的元素,相当于在修改数组
     * @param c 指定集合
     * @return 数组元素是否被修改成功
     */
    public synchronized boolean retainAll(Collection<?> c) {
        return super.retainAll(c);
    }

    /**
     * 先判断当前对象与指定对象是否指向同一个对象,就是在判断地址
     * 紧接着判断指定对象属于List的子类
     * 紧接着获取两个对象的迭代器
     * 若两个迭代器的元素个数不相等,则返回false
     * 若两个迭代器的元素个数相等,则将两个迭代器的元素进行对应的比较,但凡出现对应的元素不相等则返回false
     * @param o 指定对象
     * @return 当前对象与指定对象是否相等
     */
    public boolean equals(Object o) {
        if (o == this)
            return true;
        if (!(o instanceof List))
            return false;

        ListIterator<E> e1 = listIterator();
        ListIterator<?> e2 = ((List<?>) o).listIterator();
        while (e1.hasNext() && e2.hasNext()) {
            E o1 = e1.next();
            Object o2 = e2.next();
            if (!(o1==null ? o2==null : o1.equals(o2)))
                return false;
        }
        return !(e1.hasNext() || e2.hasNext());
    }

    /**
     * 获取哈希值
     * @return 哈希值
     */
    public synchronized int hashCode() {
        return super.hashCode();
    }

    /**
     * 获取数组元素的字符串
     * @return 数组元素的字符串
     */
    public synchronized String toString() {
        return super.toString();
    }

    /**
     * 获取指定起始索引到指定结束索引之间的元素,简称获取指定子集
     * 指定区间中的元素包括起始索引,不包括结束索引
     * 若起始索引与结束索引相等,则返回空元素
     * 对子集的操作,即调用set、add、remove等方法将会影响到整个数组
     * 但在先获取子集后,又对整个数组的结构进行修改,这时在遍历子集则会导致报错,而对于整体的非结构性修改则不会报错,不过依然会影响到子集
     * 所以在获取子集后最好不要修改数组的结构
     *
     * 所有跟子集有关的方法和说明,可以参考ArrayList,基本上相似,除了在方法上加上Synchronized(this)
     * @param fromIndex 起始索引
     * @param toIndex 结束索引
     * @return 指定区间中的所有元素,称为子集
     */
    public synchronized List<E> subList(int fromIndex, int toIndex) {
        return Collections.synchronizedList(super.subList(fromIndex, toIndex), this);
    }

    /**
     * 遍历数组,并对数组中的元素进行指定处理
     * 在遍历过程中不允许修改结构,否则会抛出错误
     * @param action 函数式接口,对数组中的元素指定处理
     */
    public synchronized void forEach(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        final int expectedModCount = modCount;
        @SuppressWarnings("unchecked")
        final E[] elementData = (E[]) this.elementData;
        final int elementCount = this.elementCount;
        for (int i=0; modCount == expectedModCount && i < elementCount; i++) {
            action.accept(elementData[i]);
        }
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

     /**
     * 根据指定条件移除元素
     * 笔者对BitSet也是第一次接触,针对本文章它显的不是很重要,故而大概了解了一下
     * 
     * 该方法中将满足条件的元素索引存放到BitSet中,同时记录移除元素的个数removeCount
     * 紧接着BitSet调用 nextClearBit方法,该方法根据指定的索引获取没有在BitSet中存放的下一个索引,直接上个例子吧
     * BitSet removeSet = new BitSet();
     * removeSet.set(1)
     * removeSet.set(2)
     * System.out.println(removeSet.nextClearBit(1))  --> 3
     *
     * 一开始已经在BitSet中存放了要移除的元素的索引,当调用nextClearBit方法循环遍历获取到的索引就是要保留的元素的索引
     * 故而直接获取元素的值将其存放到数组中,最后的数组是按照保留元素的顺序进行存放的
     * 
     * 函数式接口中不能调用修改结构的方法
     * @param filter 使用指定条件来过滤元素
     * @return 是否移除成功
     */
    public synchronized boolean removeIf(Predicate<? super E> filter) {
        Objects.requireNonNull(filter);
        int removeCount = 0;
        final int size = elementCount;
        final BitSet removeSet = new BitSet(size);
        final int expectedModCount = modCount;
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            @SuppressWarnings("unchecked")
            final E element = (E) elementData[i];
            if (filter.test(element)) {
                removeSet.set(i);
                removeCount++;
            }
        }
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }

        final boolean anyToRemove = removeCount > 0;
        if (anyToRemove) {
            final int newSize = size - removeCount;
            for (int i=0, j=0; (i < size) && (j < newSize); i++, j++) {
                i = removeSet.nextClearBit(i);
                elementData[j] = elementData[i];
            }
            for (int k=newSize; k < size; k++) {
                elementData[k] = null;  // Let gc do its work
            }
            elementCount = newSize;
            if (modCount != expectedModCount) {
                throw new ConcurrentModificationException();
            }
            modCount++;
        }

        return anyToRemove;
    }

     /**
     * 根据指定规则替换所有旧元素
     * operator.apply方法:旧元素作为入参传入,根据规则返回新元素,然后进行替换
     * operator.apply方法中不能调用修改结构的方法
     * @param operator 指定规则,函数式接口
     */
    public synchronized void replaceAll(UnaryOperator<E> operator) {
        Objects.requireNonNull(operator);
        final int expectedModCount = modCount;
        final int size = elementCount;
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            elementData[i] = operator.apply((E) elementData[i]);
        }
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
        modCount++;
    }

    /**
     * 根据指定规则对数组中的元素进行排序
     * 若没有指定规则则使用默认的升序进行排序
     * 指定规则后会调用自定义比较器中的compare方法进行比较排序
     * @param c 自定义比较器,覆写compare方法
     */
    public synchronized void sort(Comparator<? super E> c) {
        final int expectedModCount = modCount;
        Arrays.sort((E[]) elementData, 0, elementCount, c);
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
        modCount++;
    }

    /**
     * 获取分割迭代器
     * 由于该方法涉及到另外一个接口,会另外新起一篇文章来讲解该内容,这里就不做阐述
     * 附上文章地址:http://zlia.tech/2019/08/28/explain-arraylist-spliterator-sourcecode
     * @return 
     */
    public Spliterator<E> spliterator() {
        return new VectorSpliterator<>(this, null, 0, -1, 0);
    }

自定义容量 + 扩容机制

    /**
     * 增加Vector的容量大小,在必要情况下,入参minCapacity至少要确保能容纳元素的数量
     * 若当前Vector的容量小于minCapacity,会通过替换内部数组来增加容量大小,换句话就是创建更大长度的数组,然后将elementData指向它
     * 若capacityIncrement大于0,则新数组的长度大小等于旧数组长度大小 + capacityIncrement
     * 若capacityIncrement小于或等于0,则新新数组的长度大小等于旧数组长度大小 * 2,也就是翻倍
     * 但若新数组的长度大小仍然小于minCapacity,则最终的数组大小会是minCapacity
     *
     * 综上所述:
     * 扩容时,先计算自动扩充的容量大小
     * 若capacityIncrement大于0,则自动扩容的容量大小是 旧数组长度 + capacityIncrement
     * 若capacityIncrement小于或等于0,则自动扩容的容量大小是 旧数组长度 * 2
     * 得到自动扩容的容量大小后,与minCapacity进行比较,取最大值作为新数组的最终长度大小
     * 最终将elementData指向新数组即可
     * @param minCapacity 手动扩充的容量大小
     */
    public synchronized void ensureCapacity(int minCapacity) {
        if (minCapacity > 0) {
            modCount++;
            ensureCapacityHelper(minCapacity);
        }
    }

    /**
     * 判断是否需要扩容
     * 注意该方法是没有加synchronized关键字
     * @param minCapacity 手动扩充的容量大小
     */
    private void ensureCapacityHelper(int minCapacity) {
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    /**
     * 首先获取自动扩充的容量大小
     * 若capacityIncrement大于0,则自动扩充的容量大小:旧数组容量大小 + capacityIncrement
     * 若capacityIncrement小于0,则自动扩充的容量大小:旧数组容量大小 * 2
     * 在不考虑capacityIncrement的前提下,两次自动扩容的关系是翻倍,即2倍
     * 
     * 判断手动扩充的容量是否大于自动扩充的容量
     * 若大于,则自动扩容的容量修改为手动扩充的容量,即 newCapacity = minCapacity,否则newCapacity不变,即采用自动扩充的容量
     * 为了防止内存溢出,扩容并不是无止境的扩充,当大于一个临界点MAX_ARRAY_SIZE时,就不允许在采用自动扩容的容量大小,而是取最大值或临界点
     * 
     * 参考hugeCapacity方法:
     * 当程序执行到①时,我们可以知道 newCapacity >= minCapacity(指的是赋值之后的关系)
     * 若MAX_ARRAY_SIZE大于newCapacity,则就开始创建长度为newCapacity的新数组,三者的关系为 MAX_ARRAY_SIZE > newCapacity >= minCapacity
     * 若MAX_ARRAY_SIZE小于newCapacity,则进入到hugeCapacity方法,但此时我们不知道minCapacity 与 MAX_ARRAY_SIZE的大小关系
     * 若minCapacity大于MAX_ARRAY_SIZE,则采用最大值,不允许无限制的手动设置扩充容量,不过最大值有可能会出现内存溢出
     * 三者关系为:newCapacity >= minCapacity > MAX_ARRAY_SIZE
     * 若minCapacity小于MAX_ARRAY_SIZE,则采用临界值,该临界值是保证在不同的操作系统下不会发生内存溢出, 三者关系为:newCapacity > MAX_ARRAY_SIZE > minCapacity

     * 得出结论:
     * 添加元素时会先到底临界值,此时不会发生内存溢出,若在往上增长则达到最大值,最大值有可能发生内存溢出
     * 
     * @param  minCapacity 手动扩充的容量大小
     */
    private void grow(int minCapacity) {
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + ((capacityIncrement > 0) ?
                                         capacityIncrement : oldCapacity);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;    --------------------> ① 手动添加
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

    /**
     * 判断入参minCapacity 是否大于 MAX_ARRAY_SIZE
     * 若 minCapacity > MAX_ARRAY_SIZE,则返回值是最大值
     * 若 minCapacity <= MAX_ARRAY_SIZE,则返回值是临界值
     *
     * @param  minCapacity 手动扩充的容量大小
     * @return 容量大小结果值
     */
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

自动扩容机制

  • 先判断capacityIncrement属性,该属性可以在创建Vector时设置,也可以使用默认值0
  • 若capacityIncrement大于0,则每次自动扩容都以capacityIncrement大小进行增长
  • 若capacityIncrement小于0,则每次自动扩容都以2倍的关系进行增长
  • 如果期间手动扩充容量,则会比较手动扩充的容量大小与自动扩充的容量大小,取较大值进行扩容。
  • 扩容是比较耗时的,应该尽力去避免,所以在初始化时就应该提供一个容量参数。

容量最大值

  • 最大值是Interger.MAX_VALUE,但容易造成内存溢出,保险起见在容量等于Integer.MAX_VALUE - 8 的时候就应该停止扩充容量。
迭代器

将枚举类也归到迭代器中。


    /**
     * 获取包含所有有效元素的枚举类
     * @return 枚举类
     */
    public Enumeration<E> elements() {
        return new Enumeration<E>() {

            //下一个元素的索引
            int count = 0;

            /**
             * 判断当前枚举类中是否有下一个元素
             * @return 是否有下一个元素
             */
            public boolean hasMoreElements() {
                return count < elementCount;
            }

            /**
             * 获取下一个元素
             * 当获取到下一个元素后,会发生count++ 以此来将索引进行移动,从而达到判断是否有下一个元素
             * 先调用hasMoreElements -> nextElement,否则会抛出异常
             * @return 下一个元素
             */
            public E nextElement() {
                synchronized (Vector.this) {
                    if (count < elementCount) {
                        return elementData(count++);
                    }
                }
                throw new NoSuchElementException("Vector Enumeration");
            }
        };
    }

    /**
     * 返回一个包含指定索引到结尾之间的元素的列表迭代器
     * 元素之间按照顺序排序
     * @param index 起始索引
     * @return 包含元素的列表迭代器
     */
    public synchronized ListIterator<E> listIterator(int index) {
        if (index < 0 || index > elementCount)
            throw new IndexOutOfBoundsException("Index: "+index);
        return new ListItr(index);
    }

    /**
     * 返回一个包含所有元素的列表迭代器
     * @return 包含元素的列表迭代器
     */
    public synchronized ListIterator<E> listIterator() {
        return new ListItr(0);
    }

    /**
     * 获取迭代器
     * @return 迭代器
     */
    public synchronized Iterator<E> iterator() {
        return new Itr();
    }

    /**
     * 迭代器,正向迭代
     * 通过判断是否存在下一个元素,若有则获取,若没有则说明迭代结束
     * 由于这块的代码与ArrayList中的代码是一模一样,可以参考ArrayList,不多说了
     * @param E 元素类型
     */
    private class Itr implements Iterator<E> {
        int cursor;       
        int lastRet = -1; 
        int expectedModCount = modCount;

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

        public E next() {
            synchronized (Vector.this) {
                checkForComodification();
                int i = cursor;
                if (i >= elementCount)
                    throw new NoSuchElementException();
                cursor = i + 1;
                return elementData(lastRet = i);
            }
        }

        public void remove() {
            if (lastRet == -1)
                throw new IllegalStateException();
            synchronized (Vector.this) {
                checkForComodification();
                Vector.this.remove(lastRet);
                expectedModCount = modCount;
            }
            cursor = lastRet;
            lastRet = -1;
        }

        @Override
        public void forEachRemaining(Consumer<? super E> action) {
            Objects.requireNonNull(action);
            synchronized (Vector.this) {
                final int size = elementCount;
                int i = cursor;
                if (i >= size) {
                    return;
                }
        @SuppressWarnings("unchecked")
                final E[] elementData = (E[]) Vector.this.elementData;
                if (i >= elementData.length) {
                    throw new ConcurrentModificationException();
                }
                while (i != size && modCount == expectedModCount) {
                    action.accept(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();
        }
    }

    /**
     * 列表迭代器,正向迭代
     * 可获取上一个元素、下一个元素及索引
     * 与ArrayList一模一样的代码,不多做说明了
     */
    final 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;
        }

        public E previous() {
            synchronized (Vector.this) {
                checkForComodification();
                int i = cursor - 1;
                if (i < 0)
                    throw new NoSuchElementException();
                cursor = i;
                return elementData(lastRet = i);
            }
        }

        public void set(E e) {
            if (lastRet == -1)
                throw new IllegalStateException();
            synchronized (Vector.this) {
                checkForComodification();
                Vector.this.set(lastRet, e);
            }
        }

        public void add(E e) {
            int i = cursor;
            synchronized (Vector.this) {
                checkForComodification();
                Vector.this.add(i, e);
                expectedModCount = modCount;
            }
            cursor = i + 1;
            lastRet = -1;
        }
    }

获取元素

    /**
     * 获取数组中指定索引的元素
     * @param index 指定索引
     * @return 指定索引对应的元素
     */
    public synchronized E elementAt(int index) {
        if (index >= elementCount) {
            throw new ArrayIndexOutOfBoundsException(index + " >= " + elementCount);
        }

        return elementData(index);
    }

    /**
     * 获取数组第一个元素
     * @return 第一个元素
     */
    public synchronized E firstElement() {
        if (elementCount == 0) {
            throw new NoSuchElementException();
        }
        return elementData(0);
    }

    /**
     * 获取数组最后一个元素
     * @return 最后一个元素
     */
    public synchronized E lastElement() {
        if (elementCount == 0) {
            throw new NoSuchElementException();
        }
        return elementData(elementCount - 1);
    }

    /**
     * 获取数组中指定索引的元素
     * @param index 指定索引
     * @return 指定索引对应的元素
     */
    public synchronized E get(int index) {
        if (index >= elementCount)
            throw new ArrayIndexOutOfBoundsException(index);

        return elementData(index);
    }

修改元素

    /**
     * 修改数组中指定索引的元素
     * @param index 索引
     * @param element 新元素,替换索引对应的元素
     */
    public synchronized void setElementAt(E obj, int index) {
        if (index >= elementCount) {
            throw new ArrayIndexOutOfBoundsException(index + " >= " +
                                                     elementCount);
        }
        elementData[index] = obj;
    }

    /**
     * 修改数组中指定索引的值
     * 与上面的方法区别在于有无返回值
     * @param index 索引
     * @param element 新元素,替换索引对应的值
     * @return 旧元素,索引对应的值
     */
    public synchronized E set(int index, E element) {
        if (index >= elementCount)
            throw new ArrayIndexOutOfBoundsException(index);

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

移除元素

    /**
     * 移除数组中指定索引的元素,移除元素之前会先进行角标越界判断
     * 移除过程中将index索引位置后续的所有元素都将向左移动一格
     * 为了能让GC尽可能地回收资源,主动将尾部位置设置成null
     * @param index 指定索引
     */
    public synchronized void removeElementAt(int index) {
        modCount++;
        if (index >= elementCount) {
            throw new ArrayIndexOutOfBoundsException(index + " >= " +
                                                     elementCount);
        }
        else if (index < 0) {
            throw new ArrayIndexOutOfBoundsException(index);
        }
        int j = elementCount - index - 1;
        if (j > 0) {
            System.arraycopy(elementData, index + 1, elementData, index, j);
        }
        elementCount--;
        elementData[elementCount] = null; /* to let gc do its work */
    }

    /**
     * 移除数组中第一次出现的指定元素
     * 若数组中不存在指定元素则返回-1
     * @param obj 指定元素
     * @return 是否删除成功
     */
    public synchronized boolean removeElement(Object obj) {
        modCount++;
        int i = indexOf(obj);
        if (i >= 0) {
            removeElementAt(i);
            return true;
        }
        return false;
    }

    /**
     * 移除数组中的所有元素
     */
    public synchronized void removeAllElements() {
        modCount++;
        // Let gc do its work
        for (int i = 0; i < elementCount; i++)
            elementData[i] = null;

        elementCount = 0;
    }

    /**
     * 移除数组中第一次出现的指定值
     * 与上面的方法区别在于有无返回值
     * @param o 指定元素
     * @return 是否删除成功
     */
    public boolean remove(Object o) {
        return removeElement(o);
    }

    /**
     * 移除数组中指定索引的值,移除元素之前会先进行角标越界判断
     * 移除过程中将index索引位置后续的所有元素都将向左移动一格
     * 为了能让GC尽可能地回收资源,主动将尾部位置设置成null
     * @param index 索引
     * @return 移除的旧值
     */
    public synchronized E remove(int index) {
        modCount++;
        if (index >= elementCount)
            throw new ArrayIndexOutOfBoundsException(index);
        E oldValue = elementData(index);

        int numMoved = elementCount - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--elementCount] = null; // Let gc do its work

        return oldValue;
    }

    /**
     * 批量移除数组中的指定数组的元素
     * @param c 指定移除的元素集合
     * @return 是否移除成功
     */ 
    public synchronized boolean removeAll(Collection<?> c) {
        return super.removeAll(c);
    }

    /**
     * 移除从指定起始索引到指定结束索引之间的所有元素
     * 移除包含fromIndex索引对应的值,但不包括toIndex索引对应的值
     * 移除过程中将toIndex索引位置及其后续的所有元素往左移动 toIndex - fromIndex 格
     * 
     * 看到这里的时候有些理解难题,在移除元素后索引位置上的元素主动设置成null,我明白这一点,不好理解的点在于算法
     * 假设如下:
     *             f           t
     * 1     2     3     4     5     6     7     8
     * 
     * 移除3后的结果,注意4是不会被移除的:
     * 1     2     6     7     8     9     null  null
     *
     * 根据需求,我们知道要将8位置上的值设置成null,那么问题就在于我怎么才能知道7位置上的索引是多少呢?哦,是7,这个不算,算法应该怎么写呢?
     * 所以我很好奇怎么是这个答案:size - (toIndex-fromIndex),后面着重理解了一下:
     *
     *             f           t
     * 1     2     6     7     8     9     null  null
     * <=             size                         =>
     *                                     <= t-f =>
     * <=               ?                   =>
     * 求?的值,也就是在求null的索引是多少,看上面的图就应该比较好理解了(不知道看的懂不),size - (toIndex-fromIndex)就刚好是索引的值
     *
     * @param fromIndex 起始索引
     * @param toIndex 结束索引
     */
    protected synchronized void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = elementCount - toIndex;
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        // Let gc do its work
        int newElementCount = elementCount - (toIndex-fromIndex);
        while (elementCount != newElementCount)
            elementData[--elementCount] = null;
    }

    /**
     * 自定义反序列化
     * 直接获取指定键值
     * @param in 输入流
     */    
    private void readObject(ObjectInputStream in)
            throws IOException, ClassNotFoundException {
        ObjectInputStream.GetField gfields = in.readFields();
        int count = gfields.get("elementCount", 0);
        Object[] data = (Object[])gfields.get("elementData", null);
        if (count < 0 || data == null || count > data.length) {
            throw new StreamCorruptedException("Inconsistent vector internals");
        }
        elementCount = count;
        elementData = data.clone();
    }

    /**
     * 自定义序列化
     * 直接设置指定键值并写入流中
     * @param s 输出流
     */
    private void writeObject(java.io.ObjectOutputStream s)
            throws java.io.IOException {
        final java.io.ObjectOutputStream.PutField fields = s.putFields();
        final Object[] data;
        synchronized (this) {
            fields.put("capacityIncrement", capacityIncrement);
            fields.put("elementCount", elementCount);
            data = elementData.clone();
        }
        fields.put("elementData", data);
        s.writeFields();
    }

添加/插入元素

    /**
     * 添加元素到数组中的指定位置,添加元素之前会先进行扩容和角标越界判断
     * 插入过程中将index索引位置及后续的所有元素都将向右移动一格,同时将当前索引位置的值修改成新值
     * 数组扩容跟size属性没有任何关系,size只负责数组中有多少个元素,插入元素后故而 + 1
     * @param obj 新元素
     * @param index 指定索引
     */
    public synchronized void insertElementAt(E obj, int index) {
        modCount++;
        if (index > elementCount) {
            throw new ArrayIndexOutOfBoundsException(index
                                                     + " > " + elementCount);
        }
        ensureCapacityHelper(elementCount + 1);
        System.arraycopy(elementData, index, elementData, index + 1, elementCount - index);
        elementData[index] = obj;
        elementCount++;
    }

    /**
     * 添加元素到数组尾部,添加元素之前会先进行扩容判断
     * @param obj 新元素
     */
    public synchronized void addElement(E obj) {
        modCount++;
        ensureCapacityHelper(elementCount + 1);
        elementData[elementCount++] = obj;
    }

    /**
     * 添加元素到数组尾部,添加元素之前会先进行扩容判断
     * 与上面方法的区别在于是否有返回值
     * @param e 新元素
     * @return 是否添加成功
     */
    public synchronized boolean add(E e) {
        modCount++;
        ensureCapacityHelper(elementCount + 1);
        elementData[elementCount++] = e;
        return true;
    }

    /**
     * 添加元素到数组中的指定位置,添加元素之前会先进行扩容和角标越界判断
     * 插入过程中将index索引位置及后续的所有元素都将向右移动一格,同时将当前索引位置的值修改成新值
     * @param index 索引
     * @param element  新元素
     */
    public void add(int index, E element) {
        insertElementAt(element, index);
    }

    /**
     * 添加数组到另外一个数组中,从尾部开始追加
     * 相当于合并两个数组
     * @param c 数组
     * @return 数组中的元素是否添加到另外一个数组中
     */
    public synchronized boolean addAll(Collection<? extends E> c) {
        modCount++;
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityHelper(elementCount + numNew);
        System.arraycopy(a, 0, elementData, elementCount, numNew);
        elementCount += numNew;
        return numNew != 0;
    }

    /**
     * 添加数组到另外一个数组中,从指定索引出开始添加
     * 插入过程中将index索引位置及后续的任何元素都将往右移动 numNew 格,相当于是批量插入
     * 相当于在插入前先将原有的元素都往右移动,预先留出空位来给后面要添加的元素
     * @param index 索引
     * @param c 数组
     * @return 数组中的元素是否添加到另外一个数组中
     */
    public synchronized boolean addAll(int index, Collection<? extends E> c) {
        modCount++;
        if (index < 0 || index > elementCount)
            throw new ArrayIndexOutOfBoundsException(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityHelper(elementCount + numNew);

        int numMoved = elementCount - index;
        if (numMoved > 0)
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);

        System.arraycopy(a, 0, elementData, index, numNew);
        elementCount += numNew;
        return numNew != 0;
    }

总结

  • Vector内部通过数组实现,属于线程安全,更准确地来说应该是相对线程安全。

    /**
     * 假设有两个个线程分别调用下面的两个方法
     * 当线程1获取到size方法返回的值时正要去执行get方法,但是却被线程2抢先一步了,导致了remove方法先执行
     * 等到remove方法执行完毕后,也就是删除了最后一个元素,等到get方法执行时,最后一个元素实际上已经被删除了,现在获取的索引已经超出了范围
     * 故会抛出索引越界错误,所以严格来说Vector属于相对线程安全.
     */
    public  Object getLast(Vector list) {
        return list.get(list.size() - 1);   //线程1
    }
    public  void deleteLast(Vector list) {
        list.remove(list.size() - 1);      //线程2
    }

  • Vector每次自动扩充的容量大小支持自定义,通过传入capacityIncrement即可。

  • 创建空参数的Vector对象时,默认的初始容量是10,当容量不足时,以2倍速度增长。

  • 构建Vector对象时,最好能预先设置容量大小,以免减少后期扩容花费的时间。

  • 与迭代器不同,elements方法返回的枚举对象不会发生快速失败。

  • Vector容量的临界值是最大值 - 8,这个数字8是因为在数组中除了存储元素之外还会存储数组的长度,而这些数据都在内存中,不同操作系统对内存的分配可能有所差异,减去8更多的是为了防止内存溢出。

  • 在获取ArrayList的子集后不能在做结构上的修改。

  • 获取迭代器后,不允许进行结构修改操作,因为会 expectedModCount 与 modCount 是否相等。

  • 在遍历过程中不允许修改结构,否则会抛出错误。

重点关注

默认每次自动扩容的关系是2倍 相对线程安全 默认初始容量是10 底层是通过数组存储元素,故是有序可重复集合 自动扩充的容量大小支持自定义(capacityIncrement)

posted @ 2020-12-21 19:37  zliawk  阅读(313)  评论(0)    收藏  举报