1、LinkedList源碼註釋前端
//LinkedList源碼 jdk版本1.8.0_121 public class LinkedList<E> extends AbstractSequentialList<E> implements List<E>, Deque<E>, Cloneable, java.io.Serializable { transient int size = 0; /** * 指向第一節點 * first和last要麼都爲null,要麼都不爲null。不要把節點node和節點的item混淆 */ transient Node<E> first; /** * 指向最後一個節點 */ transient Node<E> last; /** * 構造一個空的LinkedList */ public LinkedList() { } /** * 經過集合來構建LinkedList */ public LinkedList(Collection<? extends E> c) { this(); addAll(c); } /** * 將元素放在第一個位置 * 具體作法就是建立一個新的節點newNode,newNode的item設置爲該元素,而後newNode的next指向原來的第一個節點 * 將first指向新的節點,若是是第一次添加節點就將last也指向該節點,若是不是第一次添加就將原來的第一個節點的prev指向新的節點 */ 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 = newNode; else//不是第一次添加節點 f.prev = newNode; size++; modCount++; } /** * 將元素放在最後一個位置 * 建立一個新的節點newNode,將newNode的prev指向原來的最後一個節點 * 將last指向newNode,若是是第一次添加就將first也指向newNode,若是不是第一次添加就將原來最後一個節點的next指向newNode */ void linkLast(E e) { final Node<E> l = last; final Node<E> newNode = new Node<>(l, e, null); last = newNode; if (l == null) first = newNode; else l.next = newNode; size++; modCount++; } /** * 將元素插入到另一個節點的前面 * 根據元素建立一個新的節點newNode,newNode的prev指向另外一個節點succ的prev所指向的節點,newNode的next指向succ * 若是succ的prev爲null,也就是說我succ爲第一個節點,那麼要將fisrt指向newNode,若是succ不是第一個節點,那麼就讓succ的prev所指向的節點的next指向newNode */ 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++; } /** * 將節點從第一個位置上移除 * 將第一個元素的item和next都置爲null,方便垃圾回收 * first指向將next指向的節點,若是next指向的節點爲null,就將last也設置爲null(也就是說這個要移除的節點是鏈表中的最後一個節點) * 若是next指向的節點不爲null,那麼就將next指向的節點的prev設置爲null */ 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) last = null; else next.prev = null; size--; modCount++; return element; } /** * 移除最後一個元素 * 將最後一個元素的item和prev置爲null,它的last原本就爲null因此不用管 * 而後將last指向prev指向的節點,若是prev指向的節點爲null,那麼就將first也設置爲null(也就是說這個要移除的節點是鏈表中的最後一個節點) * 若是prev指向的節點不爲null,那麼就將prev指向節點的next設置爲null */ private E unlinkLast(Node<E> l) { // assert l == last && l != null; final E element = l.item; final Node<E> prev = l.prev; l.item = null; l.prev = null; // help GC last = prev; if (prev == null) first = null; else prev.next = null; size--; modCount++; return element; } /** * 移除一個節點 * 若是該節點是第一個節點,就將first指向該節點的下一個節點,不然將該節點的上一個節點的next指向該節點的下一個節點 * 若是該節點是最後一個節點,就將last指向該節點的上一個節點,不然就將下一個節點的prev指向該節點的上一個節點 * 將當前的接電點的prev、item、next都置爲null,方便GC */ E unlink(Node<E> x) { // assert x != null; final E element = x.item; final Node<E> next = x.next; final Node<E> prev = x.prev; if (prev == null) { first = next; } else { prev.next = next; x.prev = null; } if (next == null) { last = prev; } else { next.prev = prev; x.next = null; } x.item = null; size--; modCount++; return element; } /** * 獲取list中的第一個元素,直接經過first節點,獲取其中的item,若是是空list會報錯 */ public E getFirst() { final Node<E> f = first; if (f == null) throw new NoSuchElementException(); return f.item; } /** * 獲取list中的最後一個元素,直接經過last來獲取,若是是空list會報錯 */ public E getLast() { final Node<E> l = last; if (l == null) throw new NoSuchElementException(); return l.item; } /** * 刪除第一個節點,若是是空list會報錯 */ public E removeFirst() { final Node<E> f = first; if (f == null) throw new NoSuchElementException(); return unlinkFirst(f); } /** * 刪除最後一個節點,若是是空list會報錯 */ public E removeLast() { final Node<E> l = last; if (l == null) throw new NoSuchElementException(); return unlinkLast(l); } /** * 將元素加入到list最前面 */ public void addFirst(E e) { linkFirst(e); } /** * 將元素加入到list最後面 */ public void addLast(E e) { linkLast(e); } /** * 判斷list是否包含該對象 */ public boolean contains(Object o) { return indexOf(o) != -1; } /** * 返回元素的個數 */ public int size() { return size; } /** * 將元素添加到LinkedList尾部 */ public boolean add(E e) { linkLast(e); return true; } /** * 刪除某個對象 * 迭代從前日後進行匹配,若是知足條件就刪除,最多刪除一次,後續再匹配上也不刪除 */ public boolean remove(Object o) { if (o == null) { for (Node<E> x = first; x != null; x = x.next) { if (x.item == null) { unlink(x); return true; } } } else { for (Node<E> x = first; x != null; x = x.next) { if (o.equals(x.item)) { unlink(x); return true; } } } return false; } /** * 批量加入集合中的元素到list尾部 */ public boolean addAll(Collection<? extends E> c) { return addAll(size, c); } /** * 批量加入集合中的元素到list的index處 */ public boolean addAll(int index, Collection<? extends E> c) { checkPositionIndex(index); //若是傳入的集合中元素個數爲0,直接返回false Object[] a = c.toArray(); int numNew = a.length; if (numNew == 0) return false; Node<E> pred, succ;//pred 是指向插入的第一個元素的前一個節點,succ是指向插入的 最後一個元素的後一個節點 if (index == size) {//若是index爲size那就說明是插在最後一個元素的後面 succ = null; pred = last; } else { succ = node(index); pred = succ.prev; } //循環將集合中的元素加入到list中 for (Object o : a) { @SuppressWarnings("unchecked") E e = (E) o; Node<E> newNode = new Node<>(pred, e, null); if (pred == null) first = newNode; else pred.next = newNode; pred = newNode; } //若是succ爲null,則將last指向最後添加的元素,若是不爲null則和加入的最後一個元素關聯起來 if (succ == null) { last = pred; } else { pred.next = succ; succ.prev = pred; } size += numNew; modCount++; return true; } /** * 清空LinkedList中全部的數據 * 這裏循環清空了全部節點之間的聯繫,雖然這不是必須的,可是這樣作會有助於分代GC */ public void clear() { // Clearing all of the links between nodes is "unnecessary", but: // - helps a generational GC if the discarded nodes inhabit // more than one generation // - is sure to free memory even if there is a reachable Iterator for (Node<E> x = first; x != null; ) { Node<E> next = x.next; x.item = null; x.next = null; x.prev = null; x = next; } first = last = null; size = 0; modCount++; } // Positional Access Operations 位置相關的一些操做,也就是和下標index有關 /** * 獲取某個下標處的元素 */ public E get(int index) { checkElementIndex(index); return node(index).item; } /** * 設置某個下標處的元素 */ public E set(int index, E element) { checkElementIndex(index); Node<E> x = node(index); E oldVal = x.item; x.item = element; return oldVal; } /** * 在某個下標處添加一個元素 */ public void add(int index, E element) { checkPositionIndex(index); if (index == size)//添加在最後面 linkLast(element); else linkBefore(element, node(index)); } /** * 刪除某個下標處的元素 */ public E remove(int index) { checkElementIndex(index); return unlink(node(index)); } /** * 判斷下標處有沒有元素 */ private boolean isElementIndex(int index) { return index >= 0 && index < size; } /** * 判斷這個index是否能夠用於添加或者迭代,和上面的相比只是多了一個size值。 */ private boolean isPositionIndex(int index) { return index >= 0 && index <= size; } /** * 越界異常語句 */ private String outOfBoundsMsg(int index) { return "Index: "+index+", Size: "+size; } private void checkElementIndex(int index) { if (!isElementIndex(index)) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } private void checkPositionIndex(int index) { if (!isPositionIndex(index)) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } /** * 返回index處非null的節點,index 小於 size的一半就從前面開始查找,不然從後面開始查找 */ Node<E> node(int index) { // assert isElementIndex(index); if (index < (size >> 1)) { 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; } } // Search Operations /** * 查找該對象在list中的下標,第一次出現的下標,沒有返回-1 */ public int indexOf(Object o) { int index = 0; if (o == null) { 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; } /** * 返回對象在list中最後一次出現的下標 */ public int lastIndexOf(Object o) { int index = size; if (o == null) { for (Node<E> x = last; x != null; x = x.prev) { index--; if (x.item == null) return index; } } else { for (Node<E> x = last; x != null; x = x.prev) { index--; if (o.equals(x.item)) return index; } } return -1; } // Queue operations.隊列的相關操做,先進先出 /** * 返回list第一個元素,沒有元素不會報錯 */ public E peek() { final Node<E> f = first; return (f == null) ? null : f.item; } /** * 返回list中第一個元素,list爲空會報錯 */ public E element() { return getFirst(); } /** * 返回並刪除list中第一個元素,list爲空不會報錯 */ public E poll() { final Node<E> f = first; return (f == null) ? null : unlinkFirst(f); } /** * 刪除並返回第一個list中的元素,list爲空會報錯 */ public E remove() { return removeFirst(); } /** * 新增一個元素到list尾部 */ public boolean offer(E e) { return add(e); } //Queue operations end // Deque operations 雙端隊列的 一些操做 /** * 在隊列的 最前端加入一個元素 */ public boolean offerFirst(E e) { addFirst(e); return true; } /** * 在隊列的 最後端加入一個元素 */ public boolean offerLast(E e) { addLast(e); return true; } /** * 獲取隊列的第一個元素 */ public E peekFirst() { final Node<E> f = first; return (f == null) ? null : f.item; } /** * 獲取隊列的最後一個元素 */ public E peekLast() { final Node<E> l = last; return (l == null) ? null : l.item; } /** * 返回並刪除隊列中的第一個元素 */ public E pollFirst() { final Node<E> f = first; return (f == null) ? null : unlinkFirst(f); } /** * 返回並刪除隊列中的最後一個元素 */ public E pollLast() { final Node<E> l = last; return (l == null) ? null : unlinkLast(l); } // Deque operations end //stack operations 出棧和入棧的 一些相關操做。 /** * 向棧中壓入一個元素 */ public void push(E e) { addFirst(e); } /** * 從棧中彈出一個元素,棧爲空會報錯 */ public E pop() { return removeFirst(); } //stack operations end /** * 刪除該對象第一次出現的節點 */ public boolean removeFirstOccurrence(Object o) { return remove(o); } /** * 刪除該對象最後一個出現的節點 */ public boolean removeLastOccurrence(Object o) { if (o == null) { for (Node<E> x = last; x != null; x = x.prev) { if (x.item == null) { unlink(x); return true; } } } else { for (Node<E> x = last; x != null; x = x.prev) { if (o.equals(x.item)) { unlink(x); return true; } } } return false; } /** * 獲取list迭代器 */ 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(); 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(); lastReturned.item = e; } public void add(E e) { checkForComodification(); 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(); } } //節點類,靜態內部類,用來做爲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; } } /** * 逆向迭代器,只能從後往前迭代 * @since 1.6 */ public Iterator<E> descendingIterator() { return new DescendingIterator(); } /** * Adapter to provide descending iterators via ListItr.previous */ private class DescendingIterator implements Iterator<E> { private final ListItr itr = new ListItr(size()); public boolean hasNext() { return itr.hasPrevious(); } public E next() { return itr.previous(); } public void remove() { itr.remove(); } } @SuppressWarnings("unchecked") private LinkedList<E> superClone() { try { return (LinkedList<E>) super.clone(); } catch (CloneNotSupportedException e) { throw new InternalError(e); } } /** * 淺克隆方法 */ public Object clone() { LinkedList<E> clone = superClone(); // Put clone into "virgin" state clone.first = clone.last = null; clone.size = 0; clone.modCount = 0; // Initialize clone with our elements for (Node<E> x = first; x != null; x = x.next) clone.add(x.item); return clone; } /** * 獲得一個包含list全部元素的數組,長度爲size */ public Object[] toArray() { Object[] result = new Object[size]; int i = 0; for (Node<E> x = first; x != null; x = x.next) result[i++] = x.item; return result; } /** * 將list中的元素存到爲數組a中,若是a的長度不否就重新反射構建一個長度爲size的數組,若是長度有多的,則就後面的都設置爲null */ @SuppressWarnings("unchecked") public <T> T[] toArray(T[] a) { if (a.length < size) a = (T[])java.lang.reflect.Array.newInstance( a.getClass().getComponentType(), size); int i = 0; Object[] result = a; for (Node<E> x = first; x != null; x = x.next) result[i++] = x.item; if (a.length > size) a[size] = null; return a; } private static final long serialVersionUID = 876323262645176354L; /** * 將list實例保存到流中 */ 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); // Write out all elements in the proper order. for (Node<E> x = first; x != null; x = x.next) s.writeObject(x.item); } /** * 從流中讀取list實例 */ @SuppressWarnings("unchecked") 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(); // Read in all elements in the proper order. for (int i = 0; i < size; i++) linkLast((E)s.readObject()); } /** * 用來多線程並行迭代的迭代器,這個迭代器的主要做用就是把list分紅了好幾段,每一個線程執行一段,所以是線程安全的。 */ @Override public Spliterator<E> spliterator() { return new LLSpliterator<E>(this, -1, 0); } /** A customized variant of Spliterators.IteratorSpliterator */ static final class LLSpliterator<E> implements Spliterator<E> { static final int BATCH_UNIT = 1 << 10; // batch array size increment static final int MAX_BATCH = 1 << 25; // max batch array size; final LinkedList<E> list; // null OK unless traversed Node<E> current; // current node; null until initialized int est; // size estimate; -1 until first needed int expectedModCount; // initialized when est set int batch; // batch size for splits LLSpliterator(LinkedList<E> list, int est, int expectedModCount) { this.list = list; this.est = est; this.expectedModCount = expectedModCount; } final int getEst() { int s; // force initialization final LinkedList<E> lst; if ((s = est) < 0) { if ((lst = list) == null) s = est = 0; else { expectedModCount = lst.modCount; current = lst.first; s = est = lst.size; } } return s; } public long estimateSize() { return (long) getEst(); } public Spliterator<E> trySplit() { Node<E> p; int s = getEst(); if (s > 1 && (p = current) != null) { int n = batch + BATCH_UNIT; if (n > s) n = s; if (n > MAX_BATCH) n = MAX_BATCH; Object[] a = new Object[n]; int j = 0; do { a[j++] = p.item; } while ((p = p.next) != null && j < n); current = p; batch = j; est = s - j; return Spliterators.spliterator(a, 0, j, Spliterator.ORDERED); } return null; } public void forEachRemaining(Consumer<? super E> action) { Node<E> p; int n; if (action == null) throw new NullPointerException(); if ((n = getEst()) > 0 && (p = current) != null) { current = null; est = 0; do { E e = p.item; p = p.next; action.accept(e); } while (p != null && --n > 0); } if (list.modCount != expectedModCount) throw new ConcurrentModificationException(); } public boolean tryAdvance(Consumer<? super E> action) { Node<E> p; if (action == null) throw new NullPointerException(); if (getEst() > 0 && (p = current) != null) { --est; E e = p.item; current = p.next; action.accept(e); if (list.modCount != expectedModCount) throw new ConcurrentModificationException(); return true; } return false; } public int characteristics() { return Spliterator.ORDERED | Spliterator.SIZED | Spliterator.SUBSIZED; } } }
2、LinkedList源碼分析java
一、繼承關係:經過下面的代碼能夠看出LinkedList自己繼承了AbstractSequentialList,說明LinkedList比較適合於順序訪問。同時它實現了Deque接口,說明LinkedList也是雙端隊列的一個實現。node
public class LinkedList<E> extends AbstractSequentialList<E> implements List<E>, Deque<E>, Cloneable, java.io.Serializable
二、內部結構後端
經過下面的代碼能夠看出LinkedList是基於node節點的雙向鏈表,其內部定義了一個靜態內部類Node來保存存入的數據,每次保存一個數據都會新建一個Node實例來進行存儲。Node中item指向存入的數據,prev指向前一個節點,next指向後一個節點,如此節點之間鏈接起來構成一個雙向鏈表,並非循環鏈表。LinkedList類中定義了兩個屬性first和last分別用來指向第一個和最後一個節點,first和last要麼都爲null,要麼都不爲null。數組
//節點類,靜態內部類,用來做爲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; } } /** * 指向第一節點 * first和last要麼都爲null,要麼都不爲null。不要把節點node和節點的item混淆 */ transient Node<E> first; /** * 指向最後一個節點 */ transient Node<E> last;
三、LinkedList與隊列、雙端隊列和棧安全
經過LinkedList 實現的接口Deque可知,LinkedList實現了隊列和雙端隊列,一樣棧的相關方法也表示在了接口Deque中。多線程
3.一、隊列:有些隊列是有長度的限制的,而LinkedList實現的隊列沒有長度限制less
add和offer 都是向隊列尾部添加元素,可是add在容量不夠的時候報錯(LinkedList沒有容量限制因此不會報錯),而offer則會返回false。ide
peek和element都是返回隊列的第一個元素,若是沒有元素peek返回null,element報錯。可是兩者在返回元素後不會將隊列中的元素刪除。源碼分析
poll和remove 都是返回隊列中的第一個元素而且將該元素從隊列中刪除,若是沒有元素poll返回null,remove則會報錯。
/** * 將元素添加到LinkedList尾部 */ public boolean add(E e) { linkLast(e); return true; } /** * 新增一個元素到list尾部 */ public boolean offer(E e) { return add(e); } /** * 返回list第一個元素,沒有元素不會報錯 */ public E peek() { final Node<E> f = first; return (f == null) ? null : f.item; } /** * 返回list中第一個元素,list爲空會報錯 */ public E element() { return getFirst(); } /** * 返回並刪除list中第一個元素,list爲空不會報錯 */ public E poll() { final Node<E> f = first; return (f == null) ? null : unlinkFirst(f); } /** * 刪除並返回第一個list中的元素,list爲空會報錯 */ public E remove() { return removeFirst(); }
3.二、雙端隊列:其實雙端隊列是在非雙端隊列的擴展,普通隊列只能從尾部添加元素,從頭部獲取元素。雙端隊列是在兩端均可以獲取和添加元素。
/** * 在隊列的 最前端加入一個元素 */ public boolean offerFirst(E e) { addFirst(e); return true; } /** * 在隊列的 最後端加入一個元素 */ public boolean offerLast(E e) { addLast(e); return true; } /** * 獲取隊列的第一個元素 */ public E peekFirst() { final Node<E> f = first; return (f == null) ? null : f.item; } /** * 獲取隊列的最後一個元素 */ public E peekLast() { final Node<E> l = last; return (l == null) ? null : l.item; } /** * 返回並刪除隊列中的第一個元素 */ public E pollFirst() { final Node<E> f = first; return (f == null) ? null : unlinkFirst(f); } /** * 返回並刪除隊列中的最後一個元素 */ public E pollLast() { final Node<E> l = last; return (l == null) ? null : unlinkLast(l); }
3.三、棧
棧只能是出棧和入棧,都是從頭部添加和獲取元素。
/** * 返回list第一個元素,沒有元素不會報錯 */ public E peek() { final Node<E> f = first; return (f == null) ? null : f.item; } /** * 向棧中壓入一個元素 */ public void push(E e) { addFirst(e); } /** * 從棧中彈出一個元素,棧爲空會報錯 */ public E pop() { return removeFirst(); }
3、LinkedList總結
一、LinkedList是經過Node節點保存存入的元素,並經過prev和next指向前一個節點和後一個節點來實現雙向鏈表。
二、因爲LinkedList是經過鏈表存儲數據,因此查詢某個下標的元素須要從頭或者末尾開始查找,不可以隨機快速訪問,因此會慢一點。
三、在新增數據都末尾的時候因爲不須要進行擴容操做,因此比較快速。可是若是想要在某個下標處新增元素須要先遍歷到該下標處獲取節點後才能新增。
四、因爲實現了Deque,因此LinkedList也是隊列、雙端隊列和棧的實現。