java容器體系(三)----List(LinkedList)
LinkedList 是 List 的又一種實現方法,首先看一下它的類圖:
LinkedList 繼承自 AbstractSequentialList, 實現了Deque、Cloneable、Serializable 介面,同 ArrayList 一樣,它包含了AbstractList 的所有的行為特徵,但它的實現方式是連結串列,而且是雙向連結串列。
1、成員變數
LinkedList 提供了四個成員變數
transient int size = 0; // LinkedList 的容量 transient Node<E> first; // 第一個節點 transientNode<E> last; // 最後一個節點 protected transient int modCount = 0; // List結構化修改的次數(size大小發生改變的操作都會增加)
可以看到,四個變數都使用了 transient 進行修飾,在序列化的時候這三個變數不會序列化。
Node 是 LinkedList 的私有內部類,實現程式碼如下:
private static class Node<E> { E item; // 當前節點的元素 Node<E> next; // 後一節點的引用地址 Node<E> prev; //前一節點的引用地址 Node(Node<E> prev, E element, Node<E> next) { // 節點初始化時會帶有三個引數,前一節點引用、當前節點元素和後一節點引用 this.item = element; this.next = next; this.prev = prev; } }
2、建構函式
public LinkedList() { } public LinkedList(Collection<? extendsE> c) { this(); addAll(c); }
LinkedList 提供了兩個建構函式,一個是無引數建構函式;另一個是帶有 Collection 型別引數的建構函式。可以看到,與ArrayList不同,LinkedList 並不需要設定初始容量。
3、實現自Deque的方法
Deque 是一個佇列介面,表明該類的實現類是一個雙向佇列,實現了 Queue。Queue 提供了 add(E e)、offer(E e)、remove()、poll()、element()、peek() 方法,Deque 提供了addFirst(E e)、addLast(E e)、offerFirst(E e)、offerLast(E e)、removeFirst()、removeLast()、pollFirst()、pollLast()、getFirst()、getLast()、peekFirst()、peekLast()等。
Queue 提供的方法主要是佇列頭部取出以及尾部的加入方法,是FIFO(先入先出)的資料結構;Deque 在佇列的頭部和尾部均可以獲取、新增、以及刪除。下面分析一下具體方法的實現:
(1)add(E e) 方法
public boolean add(E e) { // 在尾部新增一個元素,等同於 addLast(E e) linkLast(e); return true; } void linkLast(E e) { final Node<E> l = last; final Node<E> newNode = new Node<>(l, e, null); last = newNode; if (l == null) // 加入之前,last 未初始化 first = newNode; // 初始化 first,此時first = last else l.next = newNode; size++; // 元素數量+1 modCount++; // 修改次數+1 }
(2)offer(E e) 方法 其實使用的是add方法
public boolean offer(E e) { return add(e); }
(3) remove() 方法
public E remove() { // 刪除佇列的第一個接地那 return removeFirst(); } public E removeFirst() { final Node<E> f = first; if (f == null) // first 未初始化,表示佇列裡無資料 throw new NoSuchElementException(); return unlinkFirst(f); } private E unlinkFirst(Node<E> f) { // 刪除第一個相等的元素 // assert f == first && f != null; final E element = f.item; final Node<E> next = f.next; f.item = null; f.next = null; // help GC first = next; if (next == null) // 即此時first=null時,佇列裡沒有元素,last也置為null last = null; else next.prev = null; // 前驅節點釋放 size--; // 佇列元素數量-1 modCount++; // 結構化修改數量+1 return element; }
(4)poll() 方法
public E poll() { // 刪除佇列頭部的第一個元素並返回 final Node<E> f = first; return (f == null) ? null : unlinkFirst(f); }
poll() 方法和 remove() 方法差不多,都是使用 unlinkFirst(E e) 刪除頭部的第一個元素,但是和 remove(E e) 不同的是,在佇列為空的情況下呼叫 poll() 會返回 null,而 remove() 方法會丟擲 NoSuchElementException 異常(其實是使用removeFirst(E e) 方法丟擲的異常)。
(5)element() 方法
public E element() { // 返回頭部節點的元素 return getFirst(); } public E getFirst() { final Node<E> f = first; if (f == null) // 佇列為空時,丟擲異常 throw new NoSuchElementException(); return f.item; }
(6)peek() 方法
public E peek() { final Node<E> f = first; return (f == null) ? null : f.item; }
peek() 和 element() 方法都是返回佇列的頭部節點,佇列為空時,peek() 會返回 null ,element() 會丟擲 NoSuchElementException 異常。
以上是Queue 提供的方法,其實還有 Collection 當中的方法,後面再介紹,下面介紹 Dueue的方法。
(1)addFirst(E e)
public void addFirst(E e) { // 在佇列的頭部新增元素 linkFirst(e); } private void linkFirst(E e) { final Node<E> f = first; final Node<E> newNode = new Node<>(null, e, f); first = newNode; if (f == null) // 佇列為空時,新加入節點是last,first為null last = newNode; else f.prev = newNode; size++; modCount++; }
(2)addLast(E e)
public void addLast(E e) { // 等同於add(E e)和offer(E e),只是沒有返回值 linkLast(e); }
(3)offerFirst(E e)
public boolean offerFirst(E e) { // 等同於addFirst(E e),有返回值 addFirst(e); return true; }
(4)offerLast(E e)
public boolean offerLast(E e) { // 等同於addLast(E e),有返回值 addLast(e); return true; }
(5)push(E e)
public void push(E e) { addFirst(e); }
(6)pop(E e)
public E pop() { // 刪除佇列頭部元素並返回,佇列為空會丟擲異常 return removeFirst(); }
4、其他方法
(1)get(int index)方法
public E get(int index) { // 獲取指定位置的元素 checkElementIndex(index); return node(index).item; } private void checkElementIndex(int index) { if (!isElementIndex(index)) // 判斷是否 0<=index<size throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } private boolean isElementIndex(int index) { return index >= 0 && index < size; } private String outOfBoundsMsg(int index) { return "Index: "+index+", Size: "+size; } Node<E> node(int index) { // 這個才是真正的獲取指定位置元素的方法,獲取的是引用 // assert isElementIndex(index); if (index < (size >> 1)) { // index < size/2,從頭部開始遍歷,否則從尾部開始遍歷 Node<E> x = first; for (int i = 0; i < index; i++) x = x.next; return x; } else { Node<E> x = last; for (int i = size - 1; i > index; i--) x = x.prev; return x; } }
(2)set(int index,E element)
public E set(int index, E element) { checkElementIndex(index); Node<E> x = node(index); // 將獲取到指定位置的引用返回 E oldVal = x.item; x.item = element; return oldVal; }
(3)add(int index, E element)
public void add(int index, E element) { checkPositionIndex(index); if (index == size) linkLast(element); // 從尾部新增元素 else // 獲取指定位置元素的引用,其前驅節點改為新元素 linkBefore(element, node(index)); } void linkBefore(E e, Node<E> succ) { // assert succ != null; final Node<E> pred = succ.prev; final Node<E> newNode = new Node<>(pred, e, succ); succ.prev = newNode; if (pred == null) first = newNode; else pred.next = newNode; size++; modCount++; }
(4)indexOf(Object o)
public int indexOf(Object o) { // 從頭部遍歷,返回頭一個等於輸入引數的元素位置 int index = 0; if (o == null) { // 為 null 時,判斷元素等於null,否則呼叫equals判斷元素相等 for (Node<E> x = first; x != null; x = x.next) { if (x.item == null) return index; index++; } } else { for (Node<E> x = first; x != null; x = x.next) { if (o.equals(x.item)) return index; index++; } } return -1; }
(5)itrator() 方法
LinkedList 中本身沒有 itrator() 的方法體,方法體在其父類AbstractSequentialList 中,它實際使用的也是 AbstractList 的實現。
(6)listItrator() 方法
當然 ListedList 作為 AbstractList 的子孫類,同樣提供了 listItrator() 方法,既可以向前遍歷,也可以向後遍歷。其返回型別 Iterator 的實現方式也是內部類:
// 無引數的實現方式在 AbstractList 中已經實現 public ListIterator<E> listIterator(int index) { checkPositionIndex(index); return new ListItr(index); } private class ListItr implements ListIterator<E> { private Node<E> lastReturned; private Node<E> next; private int nextIndex; private int expectedModCount = modCount; ListItr(int index) { // assert isPositionIndex(index); next = (index == size) ? null : node(index); // 下一節點位置 nextIndex = index; } public boolean hasNext() { return nextIndex < size; } public E next() { checkForComodification(); if (!hasNext()) throw new NoSuchElementException(); lastReturned = next; next = next.next; nextIndex++; return lastReturned.item; } public boolean hasPrevious() { return nextIndex > 0; } public E previous() { checkForComodification(); if (!hasPrevious()) throw new NoSuchElementException(); lastReturned = next = (next == null) ? last : next.prev; nextIndex--; return lastReturned.item; } public int nextIndex() { return nextIndex; } public int previousIndex() { return nextIndex - 1; } public void remove() { checkForComodification(); // 檢查expectedModCount 與 modCount 是否相等 if (lastReturned == null) throw new IllegalStateException(); Node<E> lastNext = lastReturned.next; unlink(lastReturned); if (next == lastReturned) next = lastNext; else nextIndex--; lastReturned = null; expectedModCount++; } public void set(E e) { if (lastReturned == null) throw new IllegalStateException(); checkForComodification(); // 檢查expectedModCount 與 modCount 是否相等 lastReturned.item = e; } public void add(E e) { checkForComodification(); // 檢查expectedModCount 與 modCount 是否相等 lastReturned = null; if (next == null) linkLast(e); else linkBefore(e, next); nextIndex++; expectedModCount++; } public void forEachRemaining(Consumer<? super E> action) { Objects.requireNonNull(action); while (modCount == expectedModCount && nextIndex < size) { action.accept(next.item); lastReturned = next; next = next.next; nextIndex++; } checkForComodification(); } final void checkForComodification() { if (modCount != expectedModCount) throw new ConcurrentModificationException(); } }
(7)descendingIterator() 方法
descendingIterator() 方法是 LinkedList 特有的方法,該方法可以看做將 itrator() 倒過來,方法名稱一樣,只是倒序遍歷
public Iterator<E> descendingIterator() { return new DescendingIterator(); } // 同樣的hasNext()/next()名稱,卻是由後向前遍歷 private class DescendingIterator implements Iterator<E> { private final ListItr itr = new ListItr(size()); // LinkedList的內部類 public boolean hasNext() { return itr.hasPrevious(); } public E next() { return itr.previous(); } public void remove() { itr.remove(); } }
(8)clone() 方法
private LinkedList<E> superClone() { try { return (LinkedList<E>) super.clone(); } catch (CloneNotSupportedException e) { throw new InternalError(e); } } public Object clone() { LinkedList<E> clone = superClone(); // 感覺可以用new LinkedList()的 // Put clone into "virgin" state clone.first = clone.last = null; // first和last 置為空 clone.size = 0; clone.modCount = 0; // 將元素一個一個裝入克隆物件 for (Node<E> x = first; x != null; x = x.next) clone.add(x.item); return clone; }
(9)序列化和反序列化方法
前面介紹過 LinkedList 的四個成員變數 first、last、size、modCount 都使用了 transient 修飾,無法被序列化。java 對它們進行了重寫。
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException { // Write out any hidden serialization magic s.defaultWriteObject(); // Write out size s.writeInt(size); // 將 size 寫出 // Write out all elements in the proper order. for (Node<E> x = first; x != null; x = x.next) s.writeObject(x.item); // 一個接一個將元素寫出 } private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException { // Read in any hidden serialization magic s.defaultReadObject(); // Read in size int size = s.readInt(); // 這裡可沒有對成員變數size賦值 // Read in all elements in the proper order. for (int i = 0; i < size; i++) linkLast((E)s.readObject()); // 內部會進行modCount++,size++操作,因此 modCount=size }