java进阶|LinkedList源码解析和理解

码农王同学

发布于 2020-04-08 16:48:23

3220

发布于 2020-04-08 16:48:23

额，本来打算分析队列queue的源码，结果linkedList链表结构没有去分析，导致这里不得不分析linkedList源码了，由于LinkedList数据结构是Queue接口的一种，也是多态的一种体现，这也是自己最近理解多态概念的一种方式了。

先暂时看下LinkedList的结构图，然后看下类继承关系，啧啧，同一个套路，同一个写法。

看下类的继承结构，主要看其提供了哪些方法。

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

首先看下LinkedList都有哪些构造函数，默认一个无参构造函数，一个可以将指定集合数据转为链表的构造函数。

    /**
     * Constructs an empty list.
     */
    public LinkedList() {//创建一个无参构造函数
    }

如何往一个链表里面添加元素item，然后构成一条数据链。

即add()方法的使用，这也是在链表的尾部添加元素的方法。

public boolean add(E e) {
        linkLast(e);
        return true;
  }
  步骤一:
    /**
     * Links e as last element.这句话翻译的意思就是将元素e链接到链表的最后一个节点
     */
    void linkLast(E e) {
        final Node<E> l = last;//获取最后一个节点的地址引用
        //创建一个数据节点，下一个节点的引用地址为null
        final Node<E> newNode = new Node<>(l, e, null);
        last = newNode;//将新节点引用指向最后一个节点额引用last
        if (l == null)
        //首先先判断最后一个节点是否为null，若是null则链表为空，需要将新节点的引用指向first头节点
            first = newNode;
        else
        //若不是，则链表不为空，则需要将新节点链接到最后一个结点地址的后面，
        //想想自行车的链条就非常好理解了
            l.next = newNode;
        size++;
        modCount++;
    }

在链表的头部添加一个元素:addFirst()方法。

   
    public void addFirst(E e) {//在链表的头部插入元素
        linkFirst(e);
    }
 步骤一:
    /**
     * Links e as first element.//这句话的意思就是将元素链接到链表的头部
     */
    private void linkFirst(E e) {
        final Node<E> f = first;//获取链表的第一个节点引用
        final Node<E> newNode = new Node<>(null, e, f);//新建一个数据节点，看下这个数据节点Node的构造参数可知,f变成了next节点引用
        first = newNode;
        if (f == null)//首先判断首节点引用是否为空，若为空，表示链表为空，则新节点指向last
            last = newNode;
        else
            f.prev = newNode;//若不为空，只需要将新节点放到原来节点的前一个引用prev，链条的挂在节点。
        size++;//元素数量加1
        modCount++;
    }

获取链表的第一个节点数据:getFirst()方法。

public E getFirst() {
        final Node<E> f = first;//获取链表的首个节点的引用
        if (f == null)//若引用为null，则直接抛出运行时异常，为什么称为运行时异常，因为其继承了RuntimeException类
            throw new NoSuchElementException();
        return f.item;//返回数据节点，因为一个结点数据包含地址和数据值，这里只返回了数据值。
    }

public class NoSuchElementException extends RuntimeException {}

获取链表数据的最后一个数据结点:getLast()。

public E getLast() {
        final Node<E> l = last;//获取链表最后一个结点引用
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

移除链表的第一个数据结点:removeFirst()方法。

 public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }
步骤一:
private E unlinkFirst(Node<E> f) {
        final E element = f.item;//获取要删除头结点的元素item
        final Node<E> next = f.next;//获取头结点的next指向结点
        f.item = null;//gc操作，收集时间不确定。
        f.next = null; // help GC
        first = next;//将下一个结点指向first，就是因为首部结点没了，下一个结点进行替换
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;//数据减一
        modCount++;
        return element;//返回要删除的元素
    }

移除数据链表的最后一个结点:removeLast()方法。

public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }
步骤一:
private E unlinkLast(Node<E> l) {
        final E element = l.item;
        final Node<E> prev = l.prev;
        l.item = null;
        l.prev = null; // help GC
        last = prev;
        if (prev == null)//若prev结点为null说明first引用为null
            first = null;
        else
            prev.next = null;
        size--;//数据元素个数减一
        modCount++;
        return element;
    }

判断链表是否包含指定元素:contains()方法。

public boolean contains(Object o) {
        return indexOf(o) != -1;
    }
步骤一:
public int indexOf(Object o) {
        int index = 0;
        if (o == null) {//首先判断元素e是否为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;
    }

获取链表元素个数的方法:size()。

 public int size() {
        return size;
  }

清空链表数据的节点:clear()方法。

public void clear() {
//循环迭代链表元素，进行数据项和指针地址引用为null，使用gc机制进行清理。
        for (Node<E> x = first; x != null; ) {
            Node<E> next = x.next;
            x.item = null;
            x.next = null;
            x.prev = null;
            x = next;
        }
        first = last = null;//let's gc to collect
        size = 0;//链表元素个数清零
        modCount++;
    }

获取指定位置的元素:get()方法。

public E get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }
步骤一:检查索引位置是否合法
private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
步骤二:
 private boolean isElementIndex(int index) {
        return index >= 0 && index < size;
    }
步骤三:
Node<E> node(int 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;
        }
    }

在指定的索引位置设置元素:set()方法。

public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);//获取指定位置的节点
        E oldVal = x.item;
        x.item = element;//将element设置为x节点的元素，进行替换。
        return oldVal;
    }
 步骤一:
 private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

获取链表的第一个数据结点:peekFirst()。

public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }

获取链表的最后一个数据结点:peekLast()。

 public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }

链表数据转换为数组:toArray()。

public Object[] toArray() {
        Object[] result = new Object[size];//定义一个object数组，可以接收任意类型的数据
        int i = 0;
        for (Node<E> x = first; x != null; x = x.next)//循环迭代列表数据，获取数值，然后赋值到数组中，进行数据的返回
            result[i++] = x.item;
        return result;
    }

关于链表LinkedList的其它方法就不多介绍了，其基本上都是复用了上面方法的解析，到这里就结束了，这里还是按照以往的风格进行编写。

关于源码走读的示例程序:

package com.wpw.springbootjuc.java8.map;

import lombok.extern.slf4j.Slf4j;

import java.util.LinkedList;

/**
 * queue源码走读
 *
 * @author wpw
 */
@Slf4j
public class QueueTest {
    public static void main(String[] args) {
        //额，本来打算分析队列queue的源码，特么结果linkedList链表结构没有去分析，导致这里不得不分析linkedList源码了
        //        //由于LinkedList数据结构是Queue接口的一种，也是多态的一种体现，这也是自己最近理解多态概念的全面理解了。
        LinkedList<Integer> linkedList = new LinkedList<>();
        linkedList.add(1);
        linkedList.add(2);
        linkedList.add(3);
        log.info("循环输出链表的元素");
        linkedList.stream().forEachOrdered(x -> System.out.print(x + "\t"));
        log.info("在链表的头部增加元素");
        linkedList.addFirst(4);
        log.info("循环输出链表的元素结点");
        linkedList.stream().forEach(x -> System.out.print(x + "\t"));
        log.info("获取链表的第一个数据结点");
        Integer first = linkedList.getFirst();
        System.out.println("first = " + first);
        log.info("获取链表的最后一个数据结点");
        Integer last = linkedList.getLast();
        System.out.println("last = " + last);
        log.info("移除链表的第一个数据结点");
        Integer removeFirst = linkedList.removeFirst();
        System.out.println("removeFirst = " + removeFirst);
        linkedList.forEach(x -> System.out.print(x + "\t"));
        Integer removeLast = linkedList.removeLast();
        System.out.println("removeLast = " + removeLast);
        System.out.println();
        linkedList.stream().forEach(x->System.out.print(x+"\t"));
        log.info("判断链表是否包含指定元素");
        boolean flag = linkedList.contains(2);
        System.out.println("flag = " + flag);
        log.info("获取指定位置的元素");
        Integer integer = linkedList.get(1);
        System.out.println("integer = " + integer);
        System.out.println();
        log.info("获取链表的第一个结点数据");
        Integer peekFirst = linkedList.peekFirst();
        System.out.println("peekFirst = " + peekFirst);
        System.out.println();
        log.info("获取链表的最后一个节点数据");
        Integer peekLast = linkedList.peekLast();
        System.out.println("peekLast = " + peekLast);
    }
}