4. LindedList源码分析

一、简述

我们知道,数据结构中主要有两种存储结构,分别是:顺序存储结构(线性表)、链式存储结构(链表),在Java中,对这两种结构分别进行实现的类有:

  • 顺序存储结构:ArrayList、Vector、Stack
  • 链式存储结构:LinkedList、Queue

二、归纳

  • 继承了AbstractList抽象类,实现了List和Deque接口,底层基于双向链表实现的,允许null的存在。
  • 实现了Cloneable, java.io.Serializable接口,所以支持复制(拷贝)、序列化。
  • LinkedList中的元素就是一个个的节点,而真正的数据则存放在Node之中。
  • 增和删除操非常快【时间复杂度:O(1)】,查和改操作相对较慢【时间复杂度:最快O(1)最慢O(n)】。
  • LinkedList的操作单线安全,多线程不安全。

三、分析

1、接口

在分析ArrayList源码之前,我们先来看看集合的接口--List。

public interface List<E> extends Collection<E> {
    ...
    // 增
    boolean add(E e);
    void add(int index, E element);
    // 删
    boolean remove(Object o);
    E remove(int index);
    // 改
    E set(int index, E element);
    // 查
    E get(int index);
    ...
}

在上述接口中,我只抽取了比较重要的几个方法,然后以此为后续重点分析目标,其List接口对应的源码中远不止上述几个方法,有兴趣的同学可以自行翻阅。

2、成员变量

在LinkedList的源码中,其成员变量并不多,所以在此把它们都一一列出。

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    // 序列化唯一表示UID
    private static final long serialVersionUID = 876323262645176354L;
    
    // LinkedList的大小,其实就是其内部维护的双向链表存储元素的数量
    transient int size = 0;

    // 头结点,指向第一个节点的指针或引用,默认为null
    transient Node<E> first;

    // 尾节点,指向最后一个节点的指针或引用,默认为null
    transient Node<E> last;
    ...
    
}

3、构造函数

构造函数是一个类最常见的,同样也是最常被使用到的,接着我们分析LinkedList的两个不同的构造函数。

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 无参的构造函数
     */
    public LinkedList() {
    }

    /**
     * 有参构造函数
     * 构造包含指定元素的列表集合
     *
     * @param  c 集合元素
     * @throws NullPointerException 如果c为null,则会抛出空指针异常
     */
    public LinkedList(Collection<? extends E> c) {
        // 指向无参的构造函数
        this();
        addAll(c);
    }
    ...
    
}

4、内部的Node节点

因为LinkedList是双向链表,故从下面的Node节点可以看出有两个指针数据,一个指向上一个节点,一个指向下一个节点;</br>

  • 为什么Node这个类是静态的?</br>
    答案是:这跟内存泄露有关,Node类是在LinkedList类中的,也就是一个内部类,若不使用static修饰,那么Node就是一个普通的内部类,在java中,一个普通内部类在实例化之后,默认会持有外部类的引用,这就有可能造成内存泄露。但使用static修饰过的内部类(称为静态内部类),就不会有这种问题,在Android中,有很多这样的情况,如Handler的使用。
public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    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;
            }
    }
    ...
    
}

5、增

LinkedList的增操作有两种实现,分别为add(E e)和add(int index, E element),下面我们来分析其两种实现。

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 将指定的元素添加到此列表的末尾
     *
     * @param e 将要添加的元素
     * @return 返回true标识添加成功
     */
    public boolean add(E e) {
        linkLast(e);
        return true;
    }
    
    /**
     * 将指定的元素添加到指定的位置
     *
     * @param index 要插入指定元素的索引
     * @param element 要插入的元素
     * @throws IndexOutOfBoundsException 如果索引角标不合法,则抛出索引越界异常
     */
    public void add(int index, E element) {
        // 判断index是否合法,不合法则抛出索引越界异常
        checkPositionIndex(index);
        // 判断要添加的是否是最后一个索引位置
        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    }
    
    /**
     * 将元素e添加到链表最后
     */
    void linkLast(E e) {
        final Node<E> l = last;
        final Node<E> newNode = new Node<>(l, e, null);
        last = newNode;
        // 如果当前链表还没有元素,则将当前元素赋值为first
        if (l == null)
            first = newNode;
        else
            l.next = newNode;
        // 维护size
        size++;
        // 用来记录LinkedList结构性变化的次数
        modCount++;
    }
    
    /**
     * 将元素e插入到指定的index索引位置
     */
    void linkBefore(E e, Node<E> succ) {
        // 获取原本index索引位置的元素的前节点
        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
        size++;
        // 用来记录LinkedList结构性变化的次数
        modCount++;
    }
    
    /**
     * 返回指定元素索引处的(非空)节点
     */
    Node<E> node(int index) {
        // 它对index与集合长度的一半做比较,来确定是在集合的前半段还是后半段进行查找,
        // 从而达到节省一半的时间。
        
        // size>>1相当于size除以2,这里的意思就是判断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;
        }
    }
    ...
    
}

6、删

LinkedList的删操作有两种实现,分别是remove(int index)和remove(Object o),下面我们来分析其两种实现。

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    **
     * 删除索引为index的元素并返回
     *
     * @param index 要删除的索引
     * @return 返回删除的元素
     * @throws IndexOutOfBoundsException 抛出索引角标越界异常
     */
    public E remove(int index) {
        // 判断index是否合法,不合法则抛出索引越界异常
        checkElementIndex(index);
        return unlink(node(index));
    }
    
    /**
     * 删除元素o,并且返回是否有效删除
     *
     * @param o 元素将从此列表中删除(如果存在)
     * @return 如果存在该元素将其删除并返回true,否则返回false
     */
    public boolean remove(Object o) {
        // 这里把空和非空进行区分,空的话用“==”判断,非空用“equals”判断
        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;
    }
    
    /**
     * 断开非空节点x的链接
     */
    E unlink(Node<E> x) {
        // 获取当前节点的元素
        final E element = x.item;
        // 获取当前节点的下一个节点
        final Node<E> next = x.next;
        // 获取当前节点的上一个节点
        final Node<E> prev = x.prev;
        
        // 判断当前节点的上一个节点是否为null,如果为null则代表x是头结点
        if (prev == null) {
            first = next;
        } else {
            prev.next = next;
            x.prev = null;
        }
        
        // 判断当前节点的下一个节点是否为null,如果为null则代表x是尾结点
        if (next == null) {
            last = prev;
        } else {
            next.prev = prev;
            x.next = null;
        }
        // 将节点x置空
        x.item = null;
        // 维护size
        size--;
        // 用来记录LinkedList结构性变化的次数
        modCount++;
        return element;
    }
    ...
    
}

7、改

LinkedList的改操作有一种实现,对应的是set(int index, E element),下面我们来分析这种实现。

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 修改索引角标为index的元素值
     *
     * @param index 要修改的索引坐标
     * @param element 修改后存储的元素值
     * @return 返回修改前的元素值
     * @throws IndexOutOfBoundsException 抛出索引角标越界异常
     */
    public E set(int index, E element) {
        // 判断index是否合法,不合法则抛出索引越界异常
        checkElementIndex(index);
        // 获取索引为index的节点
        Node<E> x = node(index);
        // 获取节点x的值
        E oldVal = x.item;
        // 将元素element赋值给节点x的item
        x.item = element;
        // 返回原本节点x的值
        return oldVal;
    }
    ...
    
}

8、查

LinkedList的查操作有一种实现,对应的是get(int index),下面我们来分析这种实现。

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 查找索引角标为index的元素值
     *
     * @param index 要修改的索引坐标
     * @return 返回查找到的索引为index的元素值
     * @throws IndexOutOfBoundsException 抛出索引角标越界异常
     */
    public E get(int index) {
        // 判断index是否合法,不合法则抛出索引越界异常
        checkElementIndex(index);
        return node(index).item;
    }
    ...
    
}

四、队列

1、LinkedList源码分析为什么会牵扯到Queue?

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

从上面的代码中可以看到LinkedList实现了Deque,那么Deque又是什么呢?不急咱们慢慢分析。

public interface Deque<E> extends Queue<E> { ... }

由此看出代码中的Deque是Queue的一个子接口,它继承了Queue。我们都知道队列的特性是:先进先出,而Queue中的方法就是体现了这种特性。

public interface Queue<E> extends Collection<E> {
    ...
    // 添加队尾元素
    boolean offer(E e);
    // 删除对头元素
    E poll();
    // 获取对头元素
    E peek();
    ...
}

那么我们再从上述几个方法中再来看看LinkedList是如何实现的。

2、LinkedList对Queue的增操作

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 将元素e添加到列表的末尾
     *
     * @param e 将要添加的元素
     * @return 返回true标识添加成功
     */
    public boolean offer(E e) {
        return add(e);
    }

    ...
    
}

由上述代码可以看出,在LinkedList中,队列的offer(E e)方法实际上就是调用了LinkedList的#add(E e)方法,而add(E e)方法已经在最前面咱们分析过了,就是在链表的尾部添加一个元素。

3、LinkedList对Queue的删操作

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 删除队列对头的元素
     *
     * @return 返回对头元素
     */
    public E poll() {
        // 头结点
        final Node<E> f = first;
        // 判断头结点是否为null,因为可能还没存入元素
        return (f == null) ? null : unlinkFirst(f);
    }
    
    /**
     * 删除原本的头结点,删除后维护好现有的链表
     */
    private E unlinkFirst(Node<E> f) {
        // 在前面已做鲁棒性
        final E element = f.item;
        final Node<E> next = f.next;
        f.item = null;
        f.next = null; // 防止GC
        first = next;
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }
    ...
    
}

4、LinkedList对Queue的查操作

public class LinkedList<E> extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
    
    ...
    /**
     * 获取对头的元素
     *
     * @return 返回对头元素,如果对头为null,则返回null,否则返回队列头部的元素
     */
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }
    ...
    
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容