java.util.LinkedList源码解析

1、什么是LinkedList

LinkedList 是一个用链表实现的集合,元素有序且可以重复。
在这里插入图片描述
和 ArrayList 集合一样,LinkedList 集合也实现了Cloneable接口和Serializable接口,分别用来支持克隆以及支持序列化。List 接口也不用多说,定义了一套 List 集合类型的方法规范。

注意,相对于 ArrayList 集合,LinkedList 集合多实现了一个 Deque 接口,这是一个双向队列接口,双向队列就是两端都可以进行增加和删除操作。

2、字段属性

//链表元素(节点)的个数
transient int size = 0;

 /**
  *指向第一个节点的指针
  */
 transient Node<E> first;

 /**
  *指向最后一个节点的指针
  */
 transient Node<E> last;

注意这里出现了一个 Node 类,这是 LinkedList 类中的一个内部类,其中每一个元素就代表一个 Node 类对象,LinkedList 集合就是由许多个 Node 对象类似于手拉着手构成。

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

如下图所示:
在这里插入图片描述
上图的 LinkedList 是有四个元素,也就是由 4 个 Node 对象组成,size=4,head 指向第一个elementA,tail指向最后一个节点elementD。

3、构造函数

 /**
  * Constructs an empty list.
  */
 public LinkedList() {
 }

/**
 * Constructs a list containing the elements of the specified
 * collection, in the order they are returned by the collection's
 * iterator.
 *
 * @param  c the collection whose elements are to be placed into this list
 * @throws NullPointerException if the specified collection is null
 */
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

LinkedList 有两个构造函数,第一个是默认的空的构造函数,第二个是将已有元素的集合Collection 的实例添加到 LinkedList 中,调用的是 addAll() 方法,这个方法下面我们会介绍。

注意:LinkedList 是没有初始化链表大小的构造函数,因为链表不像数组,一个定义好的数组是必须要有确定的大小,然后去分配内存空间,而链表不一样,它没有确定的大小,通过指针的移动来指向下一个内存地址的分配。

4、添加元素

①、addFirst(E e)
  将指定元素添加到链表头

 /**
   * Inserts the specified element at the beginning of this list.
   *
   * @param e the element to add
   */
  public void addFirst(E e) {
      linkFirst(e);
  }
  
/**
  * Links e as first element.
  */
 private void linkFirst(E e) {
     final Node<E> f = first;//将头节点赋值给 f
     final Node<E> newNode = new Node<>(null, e, f);//将指定元素构造成一个新节点,此节点的指向下一个节点的引用为头节点
     first = newNode;//将新节点设为头节点,那么原先的头节点 f 变为第二个节点
     if (f == null)//如果第二个节点为空,也就是原先链表是空
         last = newNode;//将这个新节点也设为尾节点(前面已经设为头节点了)
     else
         f.prev = newNode;//将原先的头节点的上一个节点指向新节点
     size++;//节点数加1
     modCount++;//和ArrayList中一样,iterator和listIterator方法返回的迭代器和列表迭代器实现使用。
 }

②、addLast(E e)和add(E e)
  将指定元素添加到链表尾

/**
  * Appends the specified element to the end of this list.
  *
  * <p>This method is equivalent to {@link #add}.
  *
  * @param e the element to add
  */
 public void addLast(E e) {
     linkLast(e);
 }
 
/**
  * Links e as last element.
  */
 void linkLast(E e) {
     final Node<E> l = last;//将l设为尾节点
     final Node<E> newNode = new Node<>(l, e, null);//构造一个新节点,节点上一个节点引用指向尾节点l
     last = newNode;//将尾节点设为创建的新节点
     if (l == null)//如果尾节点为空,表示原先链表为空
         first = newNode;//将头节点设为新创建的节点(尾节点也是新创建的节点)
     else
         l.next = newNode;//将原来尾节点下一个节点的引用指向新节点
     size++;//节点数加1
     modCount++;
 }

③、add(int index, E element)
  将指定的元素插入此列表中的指定位置

public void add(int index, E element) {
    //判断索引 index >= 0 && index <= size中时抛出IndexOutOfBoundsException异常
    checkPositionIndex(index);

    if (index == size)//如果索引值等于链表大小
        linkLast(element);//将节点插入到尾节点
    else
        linkBefore(element, node(index));
}
void linkLast(E e) {
    final Node<E> l = last;
    final Node<E> newNode = new Node<>(l, e, null);
    last = newNode;
    if (l == null)
        first = newNode;
    else
        l.next = newNode;
    size++;
    modCount++;
}
Node<E> node(int index) {
    // assert isElementIndex(index);

    if (index < (size >> 1)) {
        Node<E> x = first;//设x为头节点
        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;
    }
}
void linkBefore(E e, Node<E> succ) {
    // assert succ != null;
    final Node<E> pred = succ.prev;//将pred设为插入节点的上一个节点
    final Node<E> newNode = new Node<>(pred, e, succ);//将新节点的上引用设为pred,下引用设为succ
    succ.prev = newNode;//succ的上一个节点的引用设为新节点
    if (pred == null)//如果插入节点的上一个节点引用为空
        first = newNode;//新节点就是头节点
    else
        pred.next = newNode;//插入节点的下一个节点引用设为新节点
    size++;
    modCount++;
}

④、addAll(Collection<? extends E> c)
  按照指定集合的​​迭代器返回的顺序,将指定集合中的所有元素追加到此列表的末尾

此方法还有一个 addAll(int index, Collection<? extends E> c),将集合 c 中所有元素插入到指定索引的位置。其实

addAll(Collection<? extends E> c) == addAll(size, Collection<? extends E> c)

源码如下:

//按照指定集合的​​迭代器返回的顺序,将指定集合中的所有元素追加到此列表的末尾。
public boolean addAll(Collection<? extends E> c) {
   return addAll(size, c);
}
//将集合 c 中所有元素插入到指定索引的位置。
public boolean addAll(int index, Collection<? extends E> c) {
    //判断索引 index >= 0 && index <= size中时抛出IndexOutOfBoundsException异常
    checkPositionIndex(index);

    Object[] a = c.toArray();//将集合转换成一个 Object 类型的数组
    int numNew = a.length;
    if (numNew == 0)//如果添加的集合为空,直接返回false
        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);
        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;
}

看到上面向 LinkedList 集合中添加元素的各种方式,我们发现LinkedList 每次添加元素只是改变元素的上一个指针引用和下一个指针引用,而且没有扩容。,对比于 ArrayList ,需要扩容,而且在中间插入元素时,后面的所有元素都要移动一位,两者插入元素时的效率差异很大,下一篇博客会对这两者的效率,以及何种情况选择何种集合进行分析。

还有,每次进行添加操作,都有modCount++ 的操作

5、删除元素

删除元素和添加元素一样,也是通过更改指向上一个节点和指向下一个节点的引用即可。

①、remove()和removeFirst()
  从此列表中移除并返回第一个元素

//从此列表中移除并返回第一个元素
public E remove() {
   return removeFirst();
}
//从此列表中移除并返回第一个元素
public E removeFirst() {
    final Node<E> f = first;//f设为头结点
    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;//next 为头结点的下一个节点
    f.item = null;
    f.next = null; // help GC
    first = next;//修改头结点为第二个节点
    if (next == null)//如果第二个节点为空(当前链表只存在第一个元素)
        last = null;//那么尾节点也置为 null
    else
        next.prev = null;//如果第二个节点不为空,那么将第二个节点的上一个引用置为 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) {
    // 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)//如果倒数第二个节点为null
        first = null;//那么将节点也置为 null
    else
        prev.next = null;//如果倒数第二个节点不为空,那么将倒数第二个节点的下一个引用置为 null
    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)
  如果存在,则从该列表中删除指定元素的第一次出现

此方法本质上和 remove(int index) 没多大区别,通过循环判断元素进行删除,需要注意的是,是删除第一次出现的元素,不是所有的。

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

6、修改元素

通过调用 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;
}

这里主要是通过 node(index) 方法获取指定索引位置的节点,然后修改此节点位置的元素即可。

7、查找元素

①、getFirst()
  返回此列表中的第一个元素

public E getFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return f.item;
}

②、getLast()
  返回此列表中的最后一个元素

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

③、get(int index)
  返回指定索引处的元素

public E get(int index) {
    checkElementIndex(index);
    return node(index).item;
}

④、indexOf(Object o)
  返回此列表中指定元素第一次出现的索引,如果此列表不包含元素,则返回-1。

	//返回此列表中指定元素第一次出现的索引,如果此列表不包含元素,则返回-1。public int indexOf(Object o) {
    int index = 0;
    if (o == null) {//如果查找的元素为null(LinkedList可以允许null值)
        for (Node<E> x = first; x != null; x = x.next) {//从头结点开始不断向下一个节点进行遍历
            if (x.item == null)
                return index;
            index++;
        }
    } else {//如果查找的元素不为null
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item))
                return index;
            index++;
        }
    }
    return -1;
}

8、遍历集合

①、普通 for 循环

LinkedList<String> linkedList = new LinkedList<>();
linkedList.add("A");
linkedList.add("B");
linkedList.add("C");
linkedList.add("D");
for(int i = 0 ; i < linkedList.size() ; i++){
    System.out.print(linkedList.get(i)+" ");//A B C D
}

代码很简单,我们就利用 LinkedList 的 get(int index) 方法,遍历出所有的元素。

但是需要注意的是, get(int index) 方法每次都要遍历该索引之前的所有元素,这句话这么理解:

比如上面的一个 LinkedList 集合,我放入了 A,B,C,D是个元素。总共需要四次遍历:

第一次遍历打印 A:只需遍历一次。

第二次遍历打印 B:需要先找到 A,然后再找到 B 打印。

第三次遍历打印 C:需要先找到 A,然后找到 B,最后找到 C 打印。

第四次遍历打印 D:需要先找到 A,然后找到 B,然后找到 C,最后找到 D。

这样如果集合元素很多,越查找到后面(当然此处的get方法进行了优化,查找前半部分从前面开始遍历,查找后半部分从后面开始遍历,但是需要的时间还是很多)花费的时间越多。那么如何改进呢?

②、迭代器

 LinkedList<String> linkedList = new LinkedList<>();
 linkedList.add("A");
 linkedList.add("B");
 linkedList.add("C");
 linkedList.add("D");
  
  
 Iterator<String> listIt = linkedList.listIterator();
 while(listIt.hasNext()){
     System.out.print(listIt.next()+" ");//A B C D
 }
 
 //通过适配器模式实现的接口,作用是倒叙打印链表
 Iterator<String> it = linkedList.descendingIterator();
 while(it.hasNext()){
     System.out.print(it.next()+" ");//D C B A
 }

在 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();

        lastReturned = next;
        next = next.next;
        nextIndex++;
        return lastReturned.item;
    }

    public boolean hasPrevious() {
        return nextIndex > 0;
    }

    public E previous() {
        checkForComodification();
        if (!hasPrevious())
            throw new NoSuchElementException();

        lastReturned = next = (next == null) ? last : next.prev;
        nextIndex--;
        return lastReturned.item;
    }

    public int nextIndex() {
        return nextIndex;
    }

    public int previousIndex() {
        return nextIndex - 1;
    }

    public void remove() {
        checkForComodification();
        if (lastReturned == null)
            throw new IllegalStateException();

        Node<E> lastNext = lastReturned.next;
        unlink(lastReturned);
        if (next == lastReturned)
            next = lastNext;
        else
            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++;
    }

    public void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        while (modCount == expectedModCount && nextIndex < size) {
            action.accept(next.item);
            lastReturned = next;
            next = next.next;
            nextIndex++;
        }
        checkForComodification();
    }

    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}

这里需要重点注意的是 modCount 字段,前面我们在增加和删除元素的时候,都会进行自增操作 modCount,这是因为如果想一边迭代,一边用集合自带的方法进行删除或者新增操作,都会抛出异常。(使用迭代器的增删方法不会抛异常)

final void checkForComodification() {
    if (modCount != expectedModCount)
        throw new ConcurrentModificationException();
}

比如:

  LinkedList<String> linkedList = new LinkedList<>();
  linkedList.add("A");
  linkedList.add("B");
  linkedList.add("C");
  linkedList.add("D");
  
  
  Iterator<String> listIt = linkedList.listIterator();
  while(listIt.hasNext()){
     System.out.print(listIt.next()+" ");//A B C D
     //linkedList.remove();//此处会抛出异常
     listIt.remove();//这样可以进行删除操作
 }

迭代器的另一种形式就是使用 foreach 循环,底层实现也是使用的迭代器,这里我们就不做介绍了。

LinkedList<String> linkedList = new LinkedList<>();
linkedList.add("A");
linkedList.add("B");
linkedList.add("C");
linkedList.add("D");
for(String str : linkedList){
    System.out.print(str + "");
}

9、迭代器和for循环效率差异

  LinkedList<Integer> linkedList = new LinkedList<>();
  for(int i = 0 ; i < 10000 ; i++){//向链表中添加一万个元素
      linkedList.add(i);
  }
  long beginTimeFor = System.currentTimeMillis();
  for(int i = 0 ; i < 10000 ; i++){
      System.out.print(linkedList.get(i));
  }
  long endTimeFor = System.currentTimeMillis();
 System.out.println("使用普通for循环遍历10000个元素需要的时间:"+ (endTimeFor - beginTimeFor));
 
 
 long beginTimeIte = System.currentTimeMillis();
 Iterator<Integer> it = linkedList.listIterator();
 while(it.hasNext()){
     System.out.print(it.next()+" ");
 }
 long endTimeIte = System.currentTimeMillis();
 System.out.println("使用迭代器遍历10000个元素需要的时间:"+ (endTimeIte - beginTimeIte));

打印结果为:
在这里插入图片描述
  一万个元素两者之间都相差一倍多的时间,如果是十万,百万个元素,那么两者之间相差的速度会越来越大。
  普通for循环,每次遍历一个索引的元素之前,都要访问之间所有的索引。
  迭代器:每次访问一个元素后,都会用游标记录当前访问元素的位置,遍历一个元素,记录一个位置。
  
参考文档:https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html#

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值