Vector 原始碼分析

weixin_33797791發表於2018-06-18

這篇文章來自我的部落格

正文之前

之前介紹過 ArrayListLinkedList,所以今天來說說 List 介面的另一個實現類:Vector,其實這也是一個類似的動態陣列,只不過是執行緒安全的,和 ArrayList 還是有一點區別的

主要內容:

  1. 基本概念
  2. 構造
  3. 針對容量的操作
  4. 增刪改查

正文

1. 基本概念

關於 Vector 的介紹,其實直接看 JDK 中的註釋就解釋的很清楚了:

/**
 * The {@code Vector} class implements a growable array of
 * objects. Like an array, it contains components that can be
 * accessed using an integer index. However, the size of a
 * {@code Vector} can grow or shrink as needed to accommodate
 * adding and removing items after the {@code Vector} has been created.
 *
 * <p>Each vector tries to optimize storage management by maintaining a
 * {@code capacity} and a {@code capacityIncrement}. The
 * {@code capacity} is always at least as large as the vector
 * size; it is usually larger because as components are added to the
 * vector, the vector's storage increases in chunks the size of
 * {@code capacityIncrement}. An application can increase the
 * capacity of a vector before inserting a large number of
 * components; this reduces the amount of incremental reallocation.
 */
複製程式碼

首先,Vector 是一個可增長的陣列(和 ArrayList 類似),能夠用索引直接找到元素,Vector 的容量可增可減

其次,Vector 使用變數 capacitycapacityIncrement 來進行容量的管理,關於容量和大小的說法,之前也提到過,容量是最多能夠容納多少元素,而大小是目前容納了多少元素。capacity 指的就是容量,是永遠大於或等於 Vector 的大小的,不過容量通常是大於 Vector 的大小的,因為它擴容的方式有點特殊,下文提及,在插入大量資料之前,最好能進行適當的擴容,避免了再分配的時間浪費

Vector 是執行緒安全的,它所有的方法都加上了 synchronized 關鍵字

關於 Vector,需要先介紹一下它的變數:

    // Vector 的操作就是基於這個陣列來實現的:
    protected Object[] elementData;
    
    // Vector 中的元素數量
    protected int elementCount;

    // Vector 的增量,用它來判斷需要擴容多少
    protected int capacityIncrement;

    //某些 JVM 會在陣列的前幾位保留一些資訊(具體的也不曉得)
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
複製程式碼

2. 構造

關於 Vector 的構造器,有四種方式:

1. 使用給定的初始容量和增量來創造一個空的 Vector
    public Vector(int initialCapacity, int capacityIncrement) {
        super();
        if (initialCapacity < 0)
            //容量為負
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        //根據容量創造陣列
        this.elementData = new Object[initialCapacity];
        this.capacityIncrement = capacityIncrement;
    }
複製程式碼
2. 使用給定的容量來創造一個空的 Vector

呼叫了上一個構造器

    //增量設定為0
    public Vector(int initialCapacity) {
        this(initialCapacity, 0);
    }
複製程式碼
3. 不帶引數創造一個空的 Vector

呼叫上一個構造器,並將容量初始值設為10

    public Vector() {
        this(10);
    }
複製程式碼
4. 創造一個帶有其他容器元素的 Vector
    public Vector(Collection<? extends E> c) {
        elementData = c.toArray();
        elementCount = elementData.length;
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, elementCount, Object[].class);
    }
複製程式碼

3. 針對容量的操作

1. 增長容量

增長容量的操作真是一套又一套,和俄羅斯套娃一樣,用一個同步的公有方法來呼叫其他未同步的私有方法:

    public synchronized void ensureCapacity(int minCapacity) {
        if (minCapacity > 0) {
            modCount++;
            ensureCapacityHelper(minCapacity);
        }
    }

    private void ensureCapacityHelper(int minCapacity) {
        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    //先確定需要擴容多少,在方法最後才進行擴容
    private void grow(int minCapacity) {
        // overflow-conscious code
        //現有的容量
        int oldCapacity = elementData.length;
        //如果增量大於0,就按增量來擴容,否則就擴容至原來的2倍容量
        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);
    }

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }
複製程式碼
2. 縮減容量

有時候,使用 Vector 完成任務之後,容量會有剩餘,可以呼叫這個方法把容量調整至與大小相同:

    public synchronized void trimToSize() {
        modCount++;
        int oldCapacity = elementData.length;
        //如果容量多餘
        if (elementCount < oldCapacity) {
            //原地複製
            elementData = Arrays.copyOf(elementData, elementCount);
        }
    }
複製程式碼
3. 設定大小

根據給定的大小設定 Vector,如果 newSize 小於 Vector 的 size,則抹掉後面的部分

    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;
    }
複製程式碼
4. 得到容量或大小的數值

很簡單,直接上程式碼:

    public synchronized int capacity() {
        return elementData.length;
    }

    public synchronized int size() {
        return elementCount;
    }
複製程式碼
5. 判斷是否為空
    public synchronized boolean isEmpty() {
        return elementCount == 0;
    }
複製程式碼

4. 增刪改查

1. 增
  • 先擴容,再新增:
    public synchronized boolean add(E e) {
        modCount++;
        //先擴容
        ensureCapacityHelper(elementCount + 1);
        elementData[elementCount++] = e;
        return true;
    }
複製程式碼
  • 在指定位置新增:
    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++;
    }

    //呼叫上面的方法
    public void add(int index, E element) {
        insertElementAt(element, index);
    }
複製程式碼
  • 在末尾新增:
    public synchronized void addElement(E obj) {
        modCount++;
        //擴容後在末尾新增
        ensureCapacityHelper(elementCount + 1);
        elementData[elementCount++] = obj;
    }
複製程式碼
  • 在末尾新增指定集合的元素:
    public synchronized boolean addAll(Collection<? extends E> c) {
        modCount++;
        //轉為陣列後根據大小進行擴容
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityHelper(elementCount + numNew);
        //將陣列內容複製到 Vector 的末尾
        System.arraycopy(a, 0, elementData, elementCount, numNew);
        elementCount += numNew;
        return numNew != 0;
    }
複製程式碼
  • 在指定位置新增指定集合的元素
    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;
    }
複製程式碼
2. 刪
  • 刪除指定位置的元素(無返回值)
    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);
        }
        //元素前移,大小減1,並將最後一個位置設為 null,讓 GC 進行處理
        elementCount--;
        elementData[elementCount] = null; /* to let gc do its work */
    }
複製程式碼
  • 刪除指定位置的元素(有返回值)

過程和上面的是類似的,區別就是這個方法返回刪除的元素

    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;
    }
複製程式碼
  • 在某個元素第一次出現的位置將其刪除:
    public synchronized boolean removeElement(Object obj) {
        modCount++;
        //查詢該元素位置
        int i = indexOf(obj);
        if (i >= 0) {
            removeElementAt(i);
            return true;
        }
        return false;
    }

    //這也是一樣的
    public boolean remove(Object o) {
        return removeElement(o);
    }
複製程式碼
  • 刪除全部元素
    public synchronized void removeAllElements() {
        modCount++;
        // Let gc do its work
        for (int i = 0; i < elementCount; i++)
            //把每個位置都設為空就行了
            elementData[i] = null;

        elementCount = 0;
    }

    //清空列表,效果是一樣的
    public void clear() {
        removeAllElements();
    }
複製程式碼
3. 改
  • 修改指定位置的元素
    public synchronized void setElementAt(E obj, int index) {
        if (index >= elementCount) {
            throw new ArrayIndexOutOfBoundsException(index + " >= " +
                                                     elementCount);
        }
        elementData[index] = obj;
    }

    //和上面方法類似,只是引數位置對調,帶有返回值
    public synchronized E set(int index, E element) {
        if (index >= elementCount)
            throw new ArrayIndexOutOfBoundsException(index);

        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }
複製程式碼
4. 查

Vector 中查詢的方式比較多,下面一一列舉:

  • 列舉出所有元素
    public Enumeration<E> elements() {
        return new Enumeration<E>() {
            int count = 0;

            public boolean hasMoreElements() {
                return count < elementCount;
            }

            public E nextElement() {
                synchronized (Vector.this) {
                    if (count < elementCount) {
                        return elementData(count++);
                    }
                }
                throw new NoSuchElementException("Vector Enumeration");
            }
        };
    }
複製程式碼
  • 從指定位置開始搜尋元素第一次出現的位置:
    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;
    }
複製程式碼
  • 查詢指定元素或判斷是否包含指定元素:
    //從0開始查詢
    public int indexOf(Object o) {
        return indexOf(o, 0);
    }

    //也是從0開始,返回布林型別
    public boolean contains(Object o) {
        return indexOf(o, 0) >= 0;
    }
複製程式碼
  • 查詢指定元素最後一次出現的位置

其實就是把上面查詢的方式倒過來,不解釋:

    public synchronized int lastIndexOf(Object o) {
        return lastIndexOf(o, elementCount-1);
    }


    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;
    }
複製程式碼
  • 根據給定位置查詢元素:
    //兩個方法是一樣的
    public synchronized E elementAt(int index) {
        if (index >= elementCount) {
            throw new ArrayIndexOutOfBoundsException(index + " >= " + elementCount);
        }

        return elementData(index);
    }

    public synchronized E get(int index) {
        if (index >= elementCount)
            throw new ArrayIndexOutOfBoundsException(index);

        return elementData(index);
    }
複製程式碼
  • 查詢首尾元素:
    public synchronized E firstElement() {
        if (elementCount == 0) {
            throw new NoSuchElementException();
        }
        return elementData(0);
    }

    public synchronized E lastElement() {
        if (elementCount == 0) {
            throw new NoSuchElementException();
        }
        return elementData(elementCount - 1);
    }
複製程式碼

4. 總結

之前在學習 Java 的時候,沒有聽到過 Vector 的相關概念,還是在學習 ArrayList 的時候,發現挺多人拿 ArrayList 和 Vector 來作比較,後來才知道,Vector 其實可以算得上是執行緒安全的 ArrayList

首先,他們繼承的類和實現的介面是一樣的,說明他們能夠實現相同的功能:

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

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

複製程式碼

其次,在上述的操作中可以看出,它和 ArrayList 的操作還是很類似的

Vector 是從 JDK1.0 出現的,而 ArrayList 是從 JDK1.2 出現的,從網上的一些其他人的觀點中可以看出,Vector 似乎沒什麼存在感了,ArrayList 也可以通過集合的包裝來實現執行緒安全的效果,不過這不應該成為我們不學習的理由,誰知道哪一天就派上用場了呢

關於 Vector 的迭代器操作,粗略看了一下,與 ArrayList 的極其相似,甚至有一些操作就是 ArrayList 的操作,所以就不必用多篇文章來闡述,接下來會是集合類中的其他 API

相關文章