Java中的LinkedList源码分析

JAVA中的LinkedList

Java中的LinkedList也是java中LIst<E>接口实现的一个重要类，相比较于ArrayList，LinkedList也有自己独特的实现方式

对于一些需要频繁插入和删除的数据，LinkedList相比较ArrayList而言，会更高效一点，LinkedList采用的数据结构是

双向链表，利用的是链式存储原理。

在LinkedList类中，有两个双向链表指针节点，一个是头部指针first，一个是尾部指针last，对于LinkedList中的许多操作，

也都是通过对这两个指针进行处理来实现许多操作；下面就来看看源码

双向链表的定义：

//在LinkedList中的源码中定义的Node<E>
 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;
        }
    }

 

目录

JAVA中的LinkedList

 

1、属性

2、构造器

3、基本内部方法，为实现数据的增删查改提供保障

4、数据的处理

  1、获取数据，与遍历数据

2、添加数据插入数据与以及删除数据

---

1、属性

         

 transient int size = 0; //LinkedList中存储的数据量

    /**
     * Pointer to first node. 指向最后一个节点
     */
 transient Node<E> first;

    /**
     * Pointer to last node.
     */
 transient Node<E> last;  //指向最后一个节点

2、构造器

LinkedList有两个构造器，一个是无参构造器，一个是参数为collection<? extends E> 的构造器

    //创建一个空数据的双向链表
    public LinkedList() {
    }

    
    public LinkedList(Collection<? extends E> c) {
        this(); //重载无参构造器里的方法
        addAll(c);//将Collection中的数据添加进入LinkedList中
    }

3、基本内部方法，为实现数据的增删查改提供保障

//在双向链表的头部添加一个值，成为新的头部first
private void linkFirst(E e) {
        final Node<E> f = first; //获取之前的头部值给f
        final Node<E> newNode = new Node<>(null, e, f); //创建一个新的Node节点
        first = newNode; //头部节点前移
        if (f == null)  //判断f是否是null，如果是null的话，头部节点和尾部节点其实指向的是同一个
            last = newNode;
        else
            f.prev = newNode; //将数据插人原first的前面
        size++; //数据量加一
        modCount++;
    }

//在双向链表中的尾部添加一个值，成为一个新的尾部
    void linkLast(E e) {
        final Node<E> l = last;  //获取之前的尾部
        final Node<E> newNode = new Node<>(l, e, null); //创建一个Node节点
        last = newNode;  //后面的实现方法其实是跟前面的方法实现一样  
        if (l == null) 
            first = newNode;
        else
            l.next = newNode;
        size++;
        modCount++;
    }

    /**
     * Inserts element e before non-null Node succ.
     */
//在节点succ之前插入一个新的节点，访问方式同样也是private
    void linkBefore(E e, Node<E> succ) {
         
        final Node<E> pred = succ.prev; //获取原succ节点的前一个节点
        final Node<E> newNode = new Node<>(pred, e, succ); //创建一个新的节点
        succ.prev = newNode; 
        if (pred == null)  //如果pred是null那么说明succ就是首节点
            first = newNode;
        else
            pred.next = newNode;
        size++;  //数据量加一
        modCount++;
    }
/**
*这个方法内部的实现大致是，将succ指向的原位置与前一个节点的联系断开，重新创建一个新的节点
*插入到其中去
*
*/

    /**
     * Unlinks non-null first node 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  意思是协助JVM运行时数据区的堆区的垃圾回收GC算法，节省内存，及时清理
        first = next; //首节点指向f的下一个节点
        if (next == null) //如果f的下一个节点不存在，那么说明f已经是最后一个节点
            last = null;
        else
            next.prev = null; //将next的前一个节点消除，释放内存
        size--;
        modCount++;
        return element;
    }

    /**
     * Unlinks non-null last node l.
     */
//将last节点向前移一个节点 实现方式跟unlinkFirst一样
    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;
    }

    /**
     * Unlinks non-null node x.
     */
//删除x节点，并返回原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;

        if (prev == null) {  //如果前一个节点为null，说明移除的是首节点，首节点后移一个单位
            first = next;  
        } else {
            prev.next = next; //pred与next简历从前往后的连接
            x.prev = null;
        }

        if (next == null) { //如果后一个节点为null，说明移除的是尾节点，尾节点前移一个单位
            last = prev;
        } else {
            next.prev = prev;  //next与pred建立一个从后往前的连接，双向连接完成建立
            x.next = null;
        }

        x.item = null; 
        size--;
        modCount++;
        return element;  //返回移除的元素
    }

4、数据的处理

  1、获取数据，与遍历数据

//获取首节点的数据
public E getFirst() {
        final Node<E> f = first;  //获取首节点的临时变量
        if (f == null)  //判断首节点是否为空，为空的话，抛出NoSuchElenmentException异常
            throw new NoSuchElementException();
        return f.item;
    }
//为什么要用f=first;而不直接调用first，因为first在jvm的方法区内部，而方法的执行实在java虚拟机
//栈中实现的，而临时变量存储在java虚拟机栈中，内存位置近，所以用临时变量f代替first能减少时间复杂度
//getLast方法也是同一个思维

//获取尾节点的数据
public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }
//根据索引获取双向链表中的数据
 public E get(int index) {
        checkElementIndex(index);  //判断index是否超出size，超出的话，抛出OutOfBoundException异常
        return node(index).item; //返回index索引处节点的值
    }

//checkElementIndex在LinkedList中的定义方法
private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
private boolean isElementIndex(int index) {
        return index >= 0 && index < size;
    }

private boolean isPositionIndex(int index) {
        return index >= 0 && index <= size;
    }
//isElenmentIndex方法和isPositionIndex方法的唯一区别是，前一个是判断索引值是否在size前
//不包括最后一个元素，而isPositionIndex包括

//查找数据，node(index)方法，访问方式为private
 Node<E> node(int index) {
        // assert isElementIndex(index);
//在这个判断语句中，是判断头部开始遍历还是从尾部开始遍历，尽可能地减少遍历次数，减小时间复杂度
//size>>1是采用位运算地方法，其实 size>>1之指的是size右移一位等于size/2，但是size>>1比size/2地速度块
        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 boolean contains(Object o) {
        return indexOf(o) >= 0;
    }
//从头部开始遍历，查找双向链表中从头向尾开始的第一个数据为o的节点，存在的话，返回那个index索引值
//不存在的话，返回-1
public int indexOf(Object o) {
        int index = 0;
        if (o == 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;
    }

//还有一个从尾部遍历方法，得到的值也就是与其相反
    public int lastIndexOf(Object o) {
        int index = size;
        if (o == null) {
            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;
    }

//indexOf方法和lastIndexOf方法都采用了定义局部变量的方法，目的就是为了提高运行效率

2、添加数据插入数据与以及删除数据

//在尾部添加数据
  public boolean add(E e) {
        linkLast(e);  //调用前面的六个基本方法中的linklast，将数据添加到尾部
        return true;
    }

//将数据E插入到index节点之后，原index+1节点后移一个单位
public void add(int index, E element) {
        checkPositionIndex(index);  //检查index是否合法，不合法的话抛出异常

        if (index == size)  //如果index=size，说明index为last节点处
            linkLast(element);
        else
            linkBefore(element, node(index)); //否则，将element插入到节点index后面
    }



//移除链表内从头到尾第一个为o的元素并返回true，如果链表内不存在这个元素，返回false
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;
    }

//移除索引index处的节点元素
public E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index));
    }


//将节点index处的元素修改为element，并返回原index节点处存储的元素
public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
    }

//移除双向链表里面的所有元素
public void clear() {
        // Clearing all of the links between nodes is "unnecessary", but:
        // - helps a generational GC if the discarded nodes inhabit
        //   more than one generation
        // - is sure to free memory even if there is a reachable Iterator
        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;
        size = 0;