JDK8中LinkedList源码分析

LinkedList:是一个基于链表实现的List集合,是一个双向链表

1.前言

上一章讲述了基于数组的List集合ArrayList,由于是基于数组实现,因此,它和数组一样查找较快,但是删除和添加涉及到数组的位置调整,效率较低.如果涉及到频繁插入和删除的场景,我们一般用LinkedList,它是基于链表实现,可通过指针更改轻松显示元素的插入和删除

2.目录

目录

3.LinkedList源码分析

3.1.类和属性

3.1.1.实现接口

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

• Deque:拥有双向队列的所有功能
• Cloneable:方便集合数据的复制
• Serializable:可序列化传输集合数据

3.1.2.双向链表的节点所对应的数据结构。

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

3.1.3.属性

// 序列化id
private static final long serialVersionUID = 876323262645176354L;
//当前结点总数
transient int size = 0;
//第一个结点 序列化每个结点的值
transient Node<E> first;
//最后一个结点
transient Node<E> last;

3.2.初始化

构造器:无参构造除只初始化对象,有参构造调用默认无参构造,调用addAll(),循环遍历将数组里面的元素创建成拥有前后连接的结点，构造成双向链表

//一个空的list
public LinkedList() {
}

public LinkedList(Collection<? extends E> c) {
    this();
    //将Collection数据添加到LinkedList
    addAll(c);
}

//index 从index开始添加
public boolean addAll(int index, Collection<? extends E> c) {
    //检查索引是否越界
    checkPositionIndex(index);
    //Collection转对对象数组
    Object[] a = c.toArray();
    int numNew = a.length;
    //长度为0添加失败
    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);
        //之前的list为空
        if (pred == null)
            first = newNode;
        else
            //指向新结点
            pred.next = newNode;
        pred = newNode;
    }
    //在最后位置添加结点
    if (succ == null) {
        last = pred;
    } else {
        //在中间位置添加结点
        pred.next = succ;
        succ.prev = pred;
    }
    //list大小加1
    size += numNew;
    modCount++;
    return true;
}

3.3.常用方法

3.3.1.add方法

add(E e)方法:该方法直接将新增的元素放置链表的最后面,然后链表的长度加1

public boolean add(E e) {
    linkLast(e);
    return true;
}

void linkLast(E e) {
    final Node<E> l = last;
    //Node的构造参数分别为前一个结点,当前结点,下一个结点
    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);
    if (index == size)
        //在最后位置添加
        linkLast(element);
    else
        //插入到结点前
        linkBefore(element, node(index));
}

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);
    //插入的后一个结点prev指向新结点
    succ.prev = newNode;
    if (pred == null)
        //结点前没元素
        first = newNode;
    else
        //插入的后一个结点prev指向新结点
        pred.next = newNode;
    //大小加1
    size++;
    modCount++;
}

get(int index)方法:获取指定索引处的元素

public E get(int index) {
    //检查下标是否越界
    checkElementIndex(index);
    return node(index).item;
}

Node<E> node(int index) {
    // assert isElementIndex(index);
    //判断索引是否大于list大小的一半
    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;
    }
}

set(int index, E element):给指定索引处的元素附新值

public E set(int index, E element) {
    //检查索引是否越界
    checkElementIndex(index);
    //找到该结点值
    Node<E> x = node(index);
    E oldVal = x.item;
    //赋值为新值
    x.item = element;
    //返回旧值
    return oldVal;
}

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;
    //头结点值值null
    f.item = null;
    //指针置空
    f.next = null; // help GC
    //下一个结点变头结点
    first = next;
    if (next == null)
        //空链表
        last = null;
    else
        //变为头结点
        next.prev = null;
    //大小减1
    size--;
    modCount++;
    //返回删除结点值
    return element;
}

remove(int index)方法:移除指定索引处元素

public E remove(int index) {
    checkElementIndex(index);
    //移除该结点
    return unlink(node(index));
}

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

remove(Object o)方法:移除list中的指定元素结点

public boolean remove(Object o) {
    //避免空指针 节约效率分null和非null
    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;
}

listIterator:LinkedList的遍历迭代器,通过内部类ListItr实现

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();
        //返回该结点值 将指针索引加1
        lastReturned = next;
        next = next.next;
        nextIndex++;
        return lastReturned.item;
    }
    //向前遍历
    public boolean hasPrevious() {
        return nextIndex > 0;
    }
    public E previous() {
        checkForComodification();
        if (!hasPrevious())
            throw new NoSuchElementException();
        //返回该结点值 将指针索引减1
        lastReturned = next = (next == null) ? last : next.prev;
        nextIndex--;
        return lastReturned.item;
    }
    public int nextIndex() {
        return nextIndex;
    }
    public int previousIndex() {
        return nextIndex - 1;
    }
    //iterator的remove 不会发生并发修改异常
    public void remove() {
        checkForComodification();
        if (lastReturned == null)
            throw new IllegalStateException();
        //获取下一个结点
        Node<E> lastNext = lastReturned.next;
        //解链 lastReturned置为空结点
        unlink(lastReturned);
        //下一个结点为为空结点(错误X)
        //应该是判断是否是往前遍历
        //看next方法和previous previous中next= lastReturned
        if (next == lastReturned)
            //往前遍历 删除后 赋值为下一个结点 用于找previous
            next = lastNext;
        else
            //往后遍历只需索引减1
            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++;
    }
    ...
}

4.总结

本章主要讲解了java常用集合LinkedList的源码实现,包括结点的构成,LinkedList的初始化,元素的添加,元素的删除,迭代元素时的并发修改异常.LinkedList是通过双向链表实现,存储时可使用零散的内存空间