JDK1.8中LinkedList集合源码解析

@[TOC]

简介

  1. LinkedList是基于链表实现的,从UML图可以看出是一个双向链表。除了当做链表使用外,它也可以被当作堆栈、队列或双端队列进行操作。不是线程安全的,继承AbstractSequentialList实现List、Deque、Cloneable、Serializable。
  2. LinkedList是基于链表实现的,因此插入删除效率高,查找效率低(虽然有一个加速动作)
  3. LinkedList是基于链表实现的,因此不存在容量不足的问题,所以没有扩容的方法
  4. 如果想使用 LinkedList 变成线程安全的,可以调用静态类Collections类中的 synchronizedList方法

在这里插入图片描述

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable
  • 继承AbstractSequentialList,AbstractSequentialList 实现了get(int index)、set(int index, E element)、add(int index, E element) 和 remove(int index)这些函数。

  • 实现 List 接口,能对它进行队列操作

  • 实现 Deque 接口,将LinkdList当作双端队列使用

  • 实现了 Cloneable 接口,即克隆

  • 实现java.io.Serializable接口,这意味着LinkedList支持序列化,能通过序列化去传输。

内部结构


    /**
     * Pointer to first node.
     * Invariant: (first == null && last == null) ||
     *            (first.prev == null && first.item != null)
     */
    transient Node<E> first;

    /**
     * Pointer to last node.
     * Invariant: (first == null && last == null) ||
     *            (last.next == null && last.item != null)
     */
    transient Node<E> last;
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;
        }
    }

这个类就代表双端链表的节点Node。这个类有三个属性,分别是节点值,下一个节点,上一个节点

源码分析


1. 构造方法

空构造方法:

    public LinkedList() {
    }

集合创建链表的构造方法:

public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
    }

2. add方法

add(E e) 方法: 将元素添加到链表尾部

    public boolean add(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)
            first = newNode;
        else
            l.next = newNode; //指向下一个元素
        size++;
        modCount++;
    }

add(int index, E element) : 在指定位置添加元素

public void add(int index, E element) {
        checkPositionIndex(index); //校验索引是否处于[0-size]之间

        if (index == size) 
            linkLast(element); //添加在链表尾部
        else
            linkBefore(element, node(index)); //添加到链表中间
    }
  • linkBefore方法需要给定两个参数,一个插入节点的值,一个指定的node
   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++;
    }

addAll(Collection<? extends E> c) 方法: 将元素添加到链表尾部

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(); //toArray()方法吧集合的数据存放到数组中
        int numNew = a.length;
        if (numNew == 0)
            return false;
		// 得到前节点和后节点
        Node<E> pred, succ;
        if (index == size) {  //如果index == 0  前节点初始化一个 Node 后节点 null
            succ = null;
            pred = last; 
        } else {   // 不是0 调用node()方法得到后节点,在得到前节点
            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)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }
		//如果插入的位置在尾部,重置last节点
        if (succ == null) {
            last = pred;
        } else { //否则,将插入的链表与先前的链表连接起来
            pred.next = succ;
            succ.prev = pred;
        }

        size += numNew;
        modCount++;
        return true;
    }

addAll方法分为 :

  1. 校验元素index的下表是否在0 - size 之间
  2. toArray吧集合的数据存到对象数组中
  3. 得到插入位置的前后节点
  4. 比那里数据,将数据插入到指定位置

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

addLast(E e): 将元素添加到链表尾部,与 add(E e) 方法一样

public void addLast(E e) {
        linkLast(e);
    }
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++;
    }

3. 根据位置获取数据

get(int index) : 根据指定索引返回数据

public E get(int index) {
		//校验索引范围
        checkElementIndex(index);
        //调用Node(index)去找到index对应的node然后返回它的值
        return node(index).item;
    }

getFirst() : 获取头元素

 public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }

getLast() :获取尾部元素

public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

4. 根据对象得到索引

indexOf(Object o) : 从头遍历查找

public int indexOf(Object o) {
        int index = 0;
        if (o == null) {
        	//x = first 从头遍历查询
            for (Node<E> x = first; x != null; x = x.next) {
                if (x.item == null)
                    return index;
                index++;
            }
        } else {
        	//x = first 从头遍历查询
            for (Node<E> x = first; x != null; x = x.next) {
                if (o.equals(x.item))
                    return index;
                index++;
            }
        }
        return -1;
    }

int lastIndexOf(Object o): 从尾遍历找

public int lastIndexOf(Object o) {
        int index = size;
        if (o == null) {
        	// x是 last 从尾部遍历
            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;
    }

5. 是否包含元素

contains(Object o) : 对象是否存在链表中

public boolean contains(Object o) {
		//调用indexOf遍历查询
        return indexOf(o) != -1;
    }

6. 删除

remove() : 删除头节点

public E remove() {
		//调用删除头节点的方法
        return removeFirst();
    }
public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            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)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

poll() :删除头元素

public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

removeLast() : 删除尾部元素

public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }

pollLast() : 删除尾部元素

public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }

remove(Object o) :根据元素删除

    public boolean remove(Object o) {
    	//如果对象为null  从这里就知道能插入null值
        if (o == null) {
        	// x == first 从头遍历元素
            for (Node<E> x = first; x != null; x = x.next) {
            	//找到元素
                if (x.item == null) {
                	//移除元素
                    unlink(x);
                    return true;
                }
            }
        } else {
        	// x == first 从头遍历元素
            for (Node<E> x = first; x != null; x = x.next) {
                if (o.equals(x.item)) {
                	//从链表中找到元素删除
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

unlink(Node x) 方法:

    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; //得到上一个节点
		//如果等于 null 
        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;
    }

remove(int index) :删除指定位置的元素

public E remove(int index) {
        //检查index范围
        checkElementIndex(index);
        //将节点删除
        return unlink(node(index));
    }

个人博客地址:http://blog.yanxiaolong.cn/

end
  • 作者:yxl(联系作者)
  • 发表时间:2021-03-27 17:46
  • 版权声明:自由转载-非商用-非衍生-保持署名(创意共享3.0许可证)
  • 转载声明:如果是转载栈主转载的文章,请附上原文链接
  • 公众号转载:请在文末添加作者公众号二维码(公众号二维码见右边,欢迎关注)
  • 评论