Java源码系列之LinkedList

Posted 2023-02-03 wanmeilingdu

一、介绍

• 是一个继承于AbstractSequentialList的双向链表。它可以被当成堆栈、队列或双端队列进行操作。
• 实现了List接口，能对它进行队列操作。
• 实现了Deque接口，能当作双端队列使用。
• 实现了Cloneable接口，覆盖了clone(),能克隆。
• 实现了java.io.Serializable接口，这意味着LinkedList支持序列化，能通过序列化去传输。
• 是非同步的

它的继承类图关系如下：

二、源码解析

基本属性

	//元素个数
	transient int size = 0;

	//链表的首元素
    transient Node<E> first;

	//链表的尾元素    
    transient Node<E> last;

内部类之Node

	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;
        
    

注：双向链表结构

构造方法

	//无参构造方法
	public LinkedList() 
    

	/**
	* 有参构造方法，初始化，并集合c的元素添加到LinkedList中
	*/
    public LinkedList(Collection<? extends E> c) 
        this();
        addAll(c);
    

	public boolean addAll(Collection<? extends E> c) 
        return addAll(size, c);
    
	
	public boolean addAll(int index, Collection<? extends E> c) 
        //检查是否越界
        checkPositionIndex(index);
		//集合c转为数组
        Object[] a = c.toArray();
        int numNew = a.length;
        //如果集合c为空，则直接返回false
        if (numNew == 0)
            return false;
		//定义前置节点、待添加节点
        Node<E> pred, succ;
        //如果插入的位置等于链表的长度，就是将原集合元素附加到链表的末尾
        if (index == size) 
            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);
            //如果pred==null，说明是插入的第一个元素
            if (pred == null)
                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;
    

	//检查index是否越界，越界则抛出异常
	private void checkPositionIndex(int index) 
        if (!isPositionIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    
	private boolean isPositionIndex(int index) 
        return index >= 0 && index <= size;
    

添加元素方法（双端队列）

    //添加元素，默认是添加到尾部
	public boolean add(E e) 
        linkLast(e);
        return true;
    
	//添加元素到首部
    public void addFirst(E e) 
        linkFirst(e);
    
	//添加元素到尾部
    public void addLast(E e) 
        linkLast(e);
    

    // 作为无界队列，添加元素总是会成功的
    public boolean offerFirst(E e) 
        addFirst(e);
        return true;
    

    public boolean offerLast(E e) 
        addLast(e);
        return true;
    

    // 从队列首添加元素
    private void linkFirst(E e) 
        // 首节点
        final Node<E> f = first;
        // 创建新节点，新节点的next是首节点
        final Node<E> newNode = new Node<>(null, e, f);
        // 让新节点作为新的首节点
        first = newNode;
        // 判断是不是第一个添加的元素
        // 如果是就把last也置为新节点
        // 否则把原首节点的prev指针置为新节点
        if (f == null)
            last = newNode;
        else
            f.prev = newNode;
        // 元素个数加1
        size++;
        // 修改次数加1，说明这是一个支持fail-fast的集合
        modCount++;
    

    // 从队列尾添加元素
    void linkLast(E e) 
        // 队列尾节点
        final Node<E> l = last;
        // 创建新节点，新节点的prev是尾节点
        final Node<E> newNode = new Node<>(l, e, null);
        // 让新节点成为新的尾节点
        last = newNode;
        // 判断是不是第一个添加的元素
        // 如果是就把first也置为新节点
        // 否则把原尾节点的next指针置为新节点
        if (l == null)
            first = newNode;
        else
            l.next = newNode;
        // 元素个数加1
        size++;
        // 修改次数加1
        modCount++;
    

注：在队列首尾添加元素很高效，时间复杂度为O(1)。

添加元素方法（List）

    // 在指定index位置处添加元素
    public void add(int index, E element) 
        // 判断是否越界
        checkPositionIndex(index);
        // 如果index是在队列尾节点之后的一个位置
        // 把新节点直接添加到尾节点之后
        // 否则调用linkBefore()方法在中间添加节点
        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    

	// 在节点succ之前添加元素
    void linkBefore(E e, Node<E> succ) 
        // succ是待添加节点的后继节点
        // 找到待添加节点的前置节点
        final Node<E> pred = succ.prev;
        // 在其前置节点和后继节点之间创建一个新节点
        final Node<E> newNode = new Node<>(pred, e, succ);
        // 修改后继节点的前置指针指向新节点
        succ.prev = newNode;
        // 判断前置节点是否为空
        // 如果为空，说明是第一个添加的元素，修改first指针
        // 否则修改前置节点的next为新节点
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        // 修改元素个数
        size++;
        // 修改次数加1
        modCount++;
    

    // 寻找index位置的节点
    Node<E> node(int index) 
        // 因为是双链表
        // 所以根据index是在前半段还是后半段决定从前遍历还是从后遍历
        // 这样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;
        
    

注：在中间添加元素比较低效，首先要先找到插入位置的节点，再修改前后节点的指针，时间复杂度为O(n)。

修改元素方法

	//修改指定位置的元素
	public E set(int index, E element) 
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
    

	//寻找index位置的节点
    Node<E> node(int index) 
        // 因为是双链表
        // 所以根据index是在前半段还是后半段决定从前遍历还是从后遍历
        // 这样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;
        
    

删除元素方法

• 作为双端队列，删除元素有两种方式，一种是队列首删除元素，一种是队列尾删除元素；
• 作为List，要支持删除指定位置的元素；

所以删除元素方法一共有三个方法，分别如下：

    // remove的时候如果没有元素抛出异常
    public E removeFirst() 
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    

    // remove的时候如果没有元素抛出异常
    public E removeLast() 
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    

    // 删除首节点
    private E unlinkFirst(Node<E> f) 
        // 首节点的元素值
        final E element = f.item;
        // 首节点的next指针
        final Node<E> next = f.next;
        // 添加首节点的内容，帮助GC
        f.item = null;
        f.next = null; // help GC
        // 把首节点的next作为新的首节点
        first = next;
        // 如果只有一个元素，删除了，把last也置为空
        // 否则把next的前置指针置为空
        if (next == null)
            last = null;
        else
            next.prev = null;
        // 元素个数减1
        size--;
        // 修改次数加1
        modCount++;
        // 返回删除的元素
        return element;
    

    // 删除尾节点
    private E unlinkLast(Node<E> l) 
        // 尾节点的元素值
        final E element = l.item;
        // 尾节点的前置指针
        final Node<E> prev = l.prev;
        // 清空尾节点的内容，帮助GC
        l.item = null;
        l.prev = null; // help GC
        // 让前置节点成为新的尾节点
        last = prev;
        // 如果只有一个元素，删除了把first置为空
        // 否则把前置节点的next置为空
        if (prev == null)
            first = null;
        else
            prev.next = null;
        // 元素个数减1
        size--;
        // 修改次数加1
        modCount++;
        // 返回删除的元素
        return element;
    

    // 删除中间节点
    public E remove(int index) 
        // 检查是否越界
        checkElementIndex(index);
        // 删除指定index位置的节点
        return unlink(node(index));
    

    // 删除指定节点x
    E unlink(Node<E> x) 
        // x的元素值
        final E element = x.item;
        // x的前置节点
        final Node<E> next = x.next;
        // x的后置节点
        final Node<E> prev = x.prev;

        // 如果前置节点为空
        // 说明是首节点，让first指向x的后置节点
        // 否则修改前置节点的next为x的后置节点
        if (prev == null) 
            first = next;
         else 
            prev.next = next;
            x.prev = null;
        

        // 如果后置节点为空
        // 说明是尾节点，让last指向x的前置节点
        // 否则修改后置节点的prev为x的前置节点
        if (next == null) 
            last = prev;
         else 
            next.prev = prev;
            x.next = null;
        

        // 清空x的元素值，协助GC
        x.item = null;
        // 元素个数减1
        size--;
        // 修改次数加1
        modCount++;
        // 返回删除的元素
        return element;
    

    // poll的时候如果没有元素返回null
    public E pollFirst() 
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    
    // poll的时候如果没有元素返回null
    public E pollLast() 
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    

注：在队列首尾删除元素很高效，时间复杂度为O(1)；在中间删除元素比较低效，首先要找到删除位置的节点，再修改前后指针，时间复杂度为O(n)。

查找元素方法

• 作为双端队列，查找元素有两种方式，一种是获取队列首的元素，一种是获取队列尾的元素；
• 作为List，要支持指定位置查找元素；

所以查找元素一共有三个方法，分别如下：

	//获取队首的元素
	public E getFirst() 
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    

	//获取队尾的元素
	public E getLast() 
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    
	
	//获取指定位置的元素
	public E get(int index) 
        checkElementIndex(index);
        return node(index).item;
    

索引元素方法

	//获取指定元素第一次出现的索引，索引到返回位置，如果列表不包含元素，则返回-1
	public int indexOf(Object o) 
        int index = 0;
        //如果查找的元素为null(LinkedList可以允许null值)
        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;
    

栈

• LinkedList是双端队列，双端队列可以作为栈使用；
• 栈的特性是LIFO(Last In First Out)，所以作为栈使用也很简单，添加删除元素都只操作队列首节点即可；

    public void push(E e) 
        addFirst(e);
    

    public E pop() 
        return removeFirst();
    

三、总结

• LinkedList是一个以双链表实现的List；
• LinkedList还是一个双端队列，具有队列、双端队列、栈的特性；
• LinkedList在队列首尾添加、删除元素非常高效，时间复杂度为O(1)；
• LinkedList在中间添加、删除元素比较低效，时间复杂度为O(n)；
• LinkedList不支持随机访问，所以访问非队列首尾的元素比较低效；
• LinkedList在功能上等于ArrayList + ArrayDeque；