LinkedList Source Sode | LinkedList源码学习

/ 2021-07-26 / 900 Words/has been Read   Times


基本结构 #

LinkedList是Java对线性表的一种实现,它实现的接口有List, Deque, Cloneable, java.io.Serializable,同时它也继承了util包下的AbstractSequentialList抽象类。

LinkedList是用链表来实现List接口的,它对链表的封装如下:

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

它的成员变量如下:

private static final long serialVersionUID = 876323262645176354L; //序列化号
transient int size = 0; //链表的大小,transient关键字载序列化对象的时候,这个属性就不会被序列化
transient Node<E> first;  //链表的头结点
transient Node<E> last;   //链表的尾结点

构造方法如下:

public LinkedList() {  //无参构造方法
}
public LinkedList(Collection<? extends E> c) {  //传一个Collection的对象
    this();
    addAll(c);
}

从前面的有参构造方法可以看出,它要求传入一个实现了Collection接口的类,这个接口为线性表,向量,栈,队列等定义了共同的操作。在传了一个Collection的对象(接口本身是不能创建对象的,这里只是为了说明方便)之后会调用addAll()方法来初始化,这是一个封装好的方法,方法内部会调用它的重载方法,多传入一个index的参数,这个参数值在方法内部默认为size。方法的实现如下:

public boolean addAll(int index, Collection<? extends E> c) {
        checkPositionIndex(index); //这里会检查传入下标的合法性,index >= 0 && index <= size,不满足会抛出异常

        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)  //如果传入的 Collection对象为空,返回false表示添加失败
            return false;

        Node<E> pred, succ;
        if (index == size) {
            succ = null;
            pred = last;
        } else {
            succ = node(index);  //调用node函数返回index下标对应的Node结点
            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;
        }

        if (succ == null) {
            last = pred;
        } else {
            pred.next = succ;
            succ.prev = pred;
        }

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

在上面的方法中调用node函数返回index下标对应的Node结点,这个函数在其他的方法中也有用到,我们单独进行一下分析。函数内部首先会对当前链表的大小除以2,如果index小于这个数,就说明这个下标对应链表的前半部分,然后就从头结点开始向后遍历;否则说明在整个链表的后半部分,就从后往前遍历,最后都是返回对应的结点,只不过这样会减少遍历的次数,节省时间。具体的代码如下:

Node<E> node(int index) {
        // assert isElementIndex(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;
        }
}

常用方法 #

下面我们来了解一些场用的一些方法:

插入元素 #

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;
        if (f == null)  //如果原来的头结点是null,说明现在整个链表只有一个元素
            last = newNode; //所以链表的尾结点也是newNode
        else
            f.prev = newNode; //这时原来头结点的prev就是现在的头结点
        size++;
        modCount++;
}

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)  //如果原来的尾结点是null,说明现在整个链表只有一个元素
            first = newNode; //所以链表的头结点也是newNode
        else
            l.next = newNode;
        size++;
        modCount++;
    }

public boolean add(E e) {
        linkLast(e);  //默认的添加元素是添加到链表尾部
        return true;
}

 public void add(int index, E element) {  //在固定下标处添加元素
        checkPositionIndex(index);  //检查下标的合法性,index >= 0 && index <= size

        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);
        succ.prev = newNode;
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        size++;
        modCount++;
}

查找元素 #

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

删除元素 #

删除元素和前面的插入元素正好是对偶的操作,在删除元素的代码中,这里作者并不是直接将头结点的指针指向下一个结点,而是先把要删除元素的内容全部设置为null,这样做更加方便jvm进行垃圾回收。

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

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

private E unlinkLast(Node<E> l) {
        // assert l == last && l != null;
        final E element = l.item;
        final Node<E> prev = l.prev;
        l.item = null;
        l.prev = null; // help GC
        last = prev;
        if (prev == null)
            first = null;
        else
            prev.next = null;
        size--;
        modCount++;
        return element;
    }

public boolean remove(Object o) {  //删除对应元素的结点
        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;
}

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

public E remove(int index) { //删除对应下标的结点
      checkElementIndex(index);
      return unlink(node(index));
}

修改元素 #

public E set(int index, E element) {  //将下标index处的元素的值修改为element
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
}

toArray()方法 #

Collection接口提供的toArray方法返回一个collection的数组表示,无参的方法返回的是Object类型的数组,在实际中往往不好进行类型转换,所以可以传入想转换成数据类型的数组来进行转换。

 public Object[] toArray() {
        Object[] result = new Object[size];
        int i = 0;
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;
        return result;
}

public <T> T[] toArray(T[] a) {
        if (a.length < size)
            a = (T[])java.lang.reflect.Array.newInstance(
                                a.getClass().getComponentType(), size);
        int i = 0;
        Object[] result = a;
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;

        if (a.length > size)
            a[size] = null;

        return a;
}

另外我们最开始提到LinkedList实现了Deque接口,所以它也重写了队列相关的一些方法,这些方法是对前面提到的增删改查方法的进一步封装,如offer()方法内部就是执行调用add()的方法。

Last modified on 2021-07-26