Java集合类详解(2) -- 从JDK1.8源码看LinkedList

上一篇文章我们分析了ArrayList,今天我们来讲讲LinkedList,与ArrayList的底层实现为动态数组不同,LinkedList的底层实现为双向链表,下面我们一起进入LinkedList的学习吧!

我们今天走走高速,直接先上定义

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable

其他的都没啥好说的,我们来讲讲Deque接口,它是一个双向队列,意味着其实也可以把LinkedList看作一个双向队列。

双向链表的节点实现

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;
    	}
}

LinkedList的属性

// 实际元素个数
transient int size = 0;
// 头结点
transient Node<E> first;
// 尾结点
transient Node<E> last;

一个非常标准的双向链表内部属性,transient关键字防止属性被初始化。

LinkedList的构造函数

无参构造函数

public LinkedList() {}

有参构造函数

public LinkedList(Collection<? extends E> c) {
        // 调用无参构造函数
        this();
        // 添加集合中所有的元素
        addAll(c);
}

如果传入一个集合作为参数,则调用addAll()方法将集合所有元素添加至LinkedList中

LinkedList的方法

add方法

public boolean add(E e) {
        // 添加到末尾
        linkLast(e);
        return true;
}

调用add(),在其内部调用linkLast(),将元素添加至链表末尾,接下来我们来介绍linkLast方法

void linkLast(E e) {
        // 保存尾结点,l为final类型,不可更改
        final Node<E> l = last;
        // 新生成结点的前驱为l,后继为null
        final Node<E> newNode = new Node<>(l, e, null);
        // 重新赋值尾结点
        last = newNode;    
        if (l == null) 
            first = newNode; // 赋值头结点
        else 
            l.next = newNode; // 尾结点的后继为新生成的结点
          
        size++;
        modCount++;
}

下面我们来看一个重载的add方法

public void add(int index, E element) {
		// 检查插入的的位置是否合法
        checkPositionIndex(index); 

        if (index == size)//添加在链表尾部
            linkLast(element);
        else//添加在链表中间
            linkBefore(element, node(index));
}

该方法用于在指定的位置添加元素,add调用的方法中,linkLast我们已经讲解过了,下面我们来谈谈linkBefore

void linkBefore(E e, Node<E> succ) {
        
        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++;
}

其实就是在succ之前插入元素。。。。。

addAll方法

public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
}

其实还是调用了另一个重载方法

public boolean addAll(int index, Collection<? extends E> c) {
        // 检查插入的的位置是否合法
        checkPositionIndex(index);
        // 将集合转化为数组
        Object[] a = c.toArray();
        
        int numNew = a.length;
        if (numNew == 0) 
            return false;

        Node<E> pred, succ; // 前驱,后继
        if (index == size) { // 如果插入位置为链表末尾,则后继为null,前驱为尾结点
            succ = null;
            pred = last;
        } else { // 插入位置为其他某个位置
            succ = node(index); // 寻找到该结点
            pred = succ.prev; // 保存该结点的前驱
        }

        for (Object o : a) { 
            @SuppressWarnings("unchecked") E e = (E) o; // 向下转型
            // 生成新结点
            Node<E> newNode = new Node<>(pred, e, null);
            if (pred == null) // 表示在第一个元素之前插入(索引为0的结点)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }

        if (succ == null) { // 表示在最后一个元素之后插入
            last = pred;
        } else {
            pred.next = succ;
            succ.prev = pred;
        }
        
        size += numNew;
        modCount++;
        return true;
}

该方法表示将集合所有元素添加至LinkedList中,传入的参数中,index代表在索引下标为index的节点之前插入,c为要插入的集合。我们可发现上面用到了node()函数,其作用为根据索引下标找到节点,下面我们来介绍一下其源码。

Node<E> node(int 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; 
        }
}

这里实现了一个优化,若节点在链表前半段则正向遍历,否则逆向遍历。

get方法

public E get(int index) {
        //检查边界
        checkElementIndex(index);
        return node(index).item;
}

根据索引返回数据,若索引越界则报错

indexOf方法

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;
    }

该方法实现对链表的正向遍历

lastIndexOf方法

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;
    }

该方法实现对链表的逆向遍历

remove方法

public boolean remove(Object o) {
        //如果删除对象为null
        if (o == null) {
            for (Node<E> x = first; x != null; x = x.next) {
                //一旦匹配,调用unlink()方法和返回true
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            for (Node<E> x = first; x != null; x = x.next) {
                //一旦匹配,调用unlink()方法和返回true
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

该方法用于删除对象,我们可以发现其内部删除元素的具体实现函数为unlink(),下面我们来看看这个函数

 E unlink(Node<E> x) {
        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;
    }

实现了将要删除的元素移除出链表

iterator方法

public Iterator<E> iterator() {
        return listIterator();
}

iterator方法用于返回一个迭代器,其内部调用了listIterator方法

public ListIterator<E> listIterator() {
        return listIterator(0);
}
//index代表迭代器开始的位置
public ListIterator<E> listIterator(int index) {
        checkPositionIndex(index);
        return new ListItr(index);
}

最终还是创建了一个ListItr,我们再来看看ListItr的实现

private class ListItr implements ListIterator<E> {
        private Node<E> lastReturned;
        private Node<E> next;
        private int nextIndex;
        private int expectedModCount = modCount;//保存当前modCount,确保fail-fast机制

        ListItr(int index) {
            next = (index == size) ? null : node(index);//得到当前索引指向的next节点
            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;
        }

        //获取前一个节点,将next节点向前移
        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();
        }
    }

我们需要注意,在ListIterator初始时,exceptedModCount保存了当前的modCount,如果在迭代期间,有操作改变了链表的底层结构,那么再操作迭代器的方法时将会抛出ConcurrentModificationException。

LinkedList实现Deque接口的一些方法(举例,不全)

addFirst方法

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;
        //如果链表为空,last节点也指向该节点
        if (f == null)
            last = newNode;
        //否则,将头节点的前驱指针指向新节点
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

本质上还是在头节点之前插入一个新节点嘛

addLast方法

public void addLast(E e) {
        linkLast(e);
}

将元素添加至链表尾部,其实与add的实现是一样的

对LinkedList的总结

  1. LinkedList并不是线性安全的
  2. LinkedList是一个实现了Deque的双端队列,所以我们既可以把LinkedList当做队列,也可以把他当做栈使用
  3. LinkedList的底层实现为链表,故其增加,删除效率较高,而查找效率较低

参考: 【集合框架】JDK1.8源码分析之LinkedList(七)
JDK 1.8 LinkedList源码分析

你可能感兴趣的:(Java集合类,LinkedList,java,集合类,jdk1.8,链表)