LinkedList源码分析和手写

411 阅读8分钟

LinkedList和双端链表(队列Queue)

一、LinkedList的结构特征

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

AbstractSequentialList

继承于 AbstractSequentialList ,本质上面与继承 AbstractList 没有什么区别,AbstractSequentialList 完善了 AbstractList 中没有实现的方法。

Serializable

序列化:将对象状态转换为可保持或传输的格式的过程。与序列化相对的是反序列化,它将流转换为对象。这两个过程结合起来,可以轻松地存储和传输数据,在Java中的这个Serializable接口其实是给jvm看的,通知jvm,我不对这个类做序列化了,你(jvm)帮我序列化就好了。如果我们没有自己声明一个serialVersionUID变量,接口会默认生成一个serialVersionUID,默认的serialVersinUID对于class的细节非常敏感,反序列化时可能会导致InvalidClassException这个异常(每次序列化都会重新计算该值)

Serializable:成员变量 Node 使用 transient 修饰,通过重写read/writeObject 方法实现序列化。

Cloneable

支持拷贝:实现Cloneable接口,重写clone方法、方法内容默认调用父类的clone方法。

浅拷贝

​ 基础类型的变量拷贝之后是独立的,不会随着源变量变动而变

​ String类型拷贝之后也是独立的

​ 引用类型拷贝的是引用地址,拷贝前后的变量引用同一个堆中的对象

public Object clone() throws CloneNotSupportedException {
    User user = (User) super.clone();
    return user;
}
深拷贝

​ 变量的所有引用类型变量(除了String)都需要实现Cloneable(数组可以直接调用clone方法),clone方法中,引用类型需要各自调用clone,重新赋值

public Object clone() throws CloneNotSupportedException {
    User user = (User) super.clone();
    user.setName(this.name.clone());
    return user;
}

java的传参,基本类型和引用类型传参

java在方法传递参数时,是将变量复制一份,然后传入方法体去执行。复制的是栈中的内容

所以基本类型是复制的变量名和值,值变了不影响源变量

引用类型复制的是变量名和值(引用地址),对象变了,会影响源变量(引用地址是一样的)

String:是不可变对象,重新赋值时,会在常量表新生成字符串(如果已有,直接取他的引用地址),将新字符串的引用地址赋值给栈中的新变量,因此源变量不会受影响

Deque

Deque:实现了Collection 大家庭中的队列接口,说明他拥有作为双端队列的功能。

LinkedList与ArrayList最大的区别就是LinkedList中实现了Collection中的 Queue(Deque)接口 拥有作为双端队列的功能

二、LinkedList的属性特征

基本属性

链表没有长度限制,他的内存地址不需要分配固定长度进行存储,只需要记录下一个节点的存储地址即可完成整个链表的连续。

//当前有多少个结点,元素个数
transient int size = 0;
//第一个结点
transient Node<E> first;
//最后一个结点
transient Node<E> last;
//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 在1.6 版本以及之前,只通过一个 header 头指针保存队列头和尾。这种操作可以说很有深度,但是从代码阅读性来说,却加深了阅读代码的难度。因此在后续的JDK 更新中,将头节点和尾节点 区分开了。节点类也更名为 Node。

为什么Node这个类是静态的?答案是:这跟内存泄露有关,Node类是在LinkedList类中的,也就是一个内部类,若不使用static修饰,那么Node就是一个普通的内部类,在java中,一个普通内部类在实例化之后,默认会持有外部类的引用,这就有可能造成内存泄露。但使用static修饰过的内部类(称为静态内部类),就不会有这种问题

构造器

public LinkedList() {
}
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);//操作次数只会记录一次   设置前驱后继
}

添加元素

public boolean add(E e) {
     linkLast(e);
     return true;
 }
//目标节点创建后寻找前驱节点, 前驱节点存在就修改前驱节点的后继,指向目标节点
void linkLast(E e) {
    final Node<E> l = last;//获取这个list对象内部的Node类型成员last,即末位节点,以该节点作为新插入元素的前驱节点
    final Node<E> newNode = new Node<>(l, e, null);//创建新节点
    last = newNode;//把新节点作为该list对象的最后一个节点
    if (l == null)//处理原先的末位节点,如果这个list本来就是一个空的链表
        first = newNode;//把新节点作为首节点
    else
        l.next = newNode;//如果链表内部已经有元素,把原来的末位节点的后继指向新节点,完成链表修改
    size++;//修改当前list的size,
    modCount++;//并记录该list对象被执行修改的次数
}
public void add(int index, E element) {
    checkPositionIndex(index);//检查下标的合法性
    if (index == size)//插入位置是末位,那还是上面末位添加的逻辑
        linkLast(element);
    else
        linkBefore(element, node(index));
}
private void checkPositionIndex(int index) {
    if (!isPositionIndex(index))
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
private boolean isPositionIndex(int index) {
    return index >= 0 && index <= size;
}
Node<E> node(int index) {
    if (index < (size >> 1)) {//二分查找   index离哪端更近 就从哪端开始找
        Node<E> x = first;
        for (int i = 0; i < index; i++)
            x = x.next;//找到index位置的元素
        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) {
    final Node<E> pred = succ.prev;//原位置节点的前驱pred
    final Node<E> newNode = new Node<>(pred, e, succ);//创建新节点,设置新节点其前驱为原位置节点的前驱pred,其后继为原位置节点succ
    succ.prev = newNode;//将新节点设置到原位置节点的前驱
    if (pred == null)//前驱如果为空,空链表,则新节点设置为first
        first = newNode;
    else
        pred.next = newNode;//将新节点设置到前驱节点的后继
    size++;//修改当前list的size
    modCount++;//记录该list对象被执行修改的次数。
}
public boolean addAll(int index, Collection<? extends E> c) {
    checkPositionIndex(index);
    //将集合转化为数组
    Object[] a = c.toArray();
    int numNew = a.length;
    if (numNew == 0)
        return false;
    Node<E> pred, succ;
    //获取插入节点的前节点(prev)和尾节点(next)
    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;
    }
    //将 Collection 的链表插入 LinkedList 中。
    if (succ == null) {
        last = pred;
    } else {
        pred.next = succ;
        succ.prev = pred;
    }
    size += numNew;
    modCount++;
    return true;
}

final修饰,不希望在运行时对变量做重新赋值

LinkedList 在插入数据优于ArrayList ,主要是因为他只需要修改指针的指向即可,而不需要将整个数组的数据进行转移。而LinkedList 由于没有实现 RandomAccess,或者说不支持索引搜索的原因,他在查找元素这一操作,需要消耗比较多的时间进行操作(n/2)。

listIterator迭代器

我们在使用List,Set的时候,为了实现对其数据的遍历,我们经常使用到了Iterator(跌代器)。 使用跌代器,你不需要干涉其遍历的过程,只需要每次取出一个你想要的数据进行处理就可以了。但是在使用的时候也是有不同的。 List和Set都有iterator()来取得其迭代器。对List来说,你也可以通过listIterator()取得其迭代器,两种迭代器在有些时候是不能通用的,Iterator和ListIterator主要区别在以下方面:

  1. ListIterator有add()方法,可以向List中添加对象,而Iterator不能

  2. ListIterator和Iterator都有hasNext()和next()方法,可以实现顺序向后遍历,但是ListIterator有hasPrevious()和previous()方法,可以实现逆向(顺序向前)遍历。Iterator就不可以。

  3. ListIterator可以定位当前的索引位置,nextIndex()和previousIndex()可以实现。Iterator没有此功能。

  4. 都可实现删除对象,但是ListIterator可以实现对象的修改,set()方法可以实现。Iierator仅能遍历,不能修改。 因为ListIterator的这些功能,可以实现对LinkedList等List数据结构的操作。 其实,数组对象也可以用迭代器来实现。 org.apache.commons.collections.iterators.ArrayIterator就可以实现此功能。 一般情况下,我们使用Iterator就可以了,如果你需要进行记录的前后反复检索的话,你就可以使用ListIterator来扩展你的功能,(有点象JDBC中的滚动结果集)。 ListIterator是一个双向迭代器。ListIterator没有当前元素,它的当前游标是位于调用next()和previsous()返回的元素之间。不过下面举的例子有点问题:下面的例子是n+1个元素。如果有n个元素,那么游标索引就是0...n共n+1个。 注意:romove和set方法不是针对当前游标的操作,而是针对最后一次的next()或者previous()调用

删除元素

1、AbstractSequentialList的remove

public E remove(int index) {
    checkElementIndex(index);
    //node(index)找到index位置的元素
    return unlink(node(index));
}
//remove(Object o)这个删除元素的方法的形参o是数据本身,而不是LinkedList集合中的元素(节点),所以需要先通过节点遍历的方式,找到o数据对应的元素,然后再调用unlink(Node x)方法将其删除
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) {
    //x的数据域element
    final E element = x.item;
    //x的下一个结点
    final Node<E> next = x.next;
    //x的上一个结点
    final Node<E> prev = x.prev;
    //如果x的上一个结点是空结点的话,那么说明x是头结点
    if (prev == null) {
        first = next;
    } else {
        prev.next = next;//将x的前后节点相连   双向链表
        x.prev = null;//x的属性置空
    }
    //如果x的下一个结点是空结点的话,那么说明x是尾结点
    if (next == null) {
        last = prev;
    } else {
        next.prev = prev;//将x的前后节点相连   双向链表
        x.next = null;
    }
    x.item = null;//指向null  方便GC回收
    size--;
    modCount++;
    return element;
}

2、Deque 中的Remove

//将first 节点的next 设置为新的头节点,然后将 f 清空。 removeLast 操作也类似。
private E unlinkFirst(Node<E> f) {
    final E element = f.item;
    //获取到头结点的下一个结点           
    final Node<E> next = f.next;
    f.item = null;
    f.next = null; // 方便 GC
    //头指针指向的是头结点的下一个结点
    first = next;
    //如果next为空,说明这个链表只有一个结点
    if (next == null)
        last = null;
    else
        next.prev = null;
    size--;
    modCount++;
    return element;
}

双端链表(队列Queue)

java中队列的实现就是LinkedList: 我们之所以说LinkedList 为双端链表,是因为他实现了Deque 接口;我们知道,队列是先进先出的,添加元素只能从队尾添加,删除元素只能从队头删除,Queue中的方法就体现了这种特性。 支持队列的一些操作,我们来看一下有哪些方法实现:

  • pop()是栈结构的实现类的方法,返回的是栈顶元素,并且将栈顶元素删除
  • poll()是队列的数据结构,获取对头元素并且删除队头元素
  • push()是栈结构的实现类的方法,把元素压入到栈中
  • peek()获取队头元素 ,但是不删除队列的头元素
  • offer()添加队尾元素

可以看到Deque 中提供的方法主要有上述的几个方法,接下来我们来看看在LinkedList 中是如何实现这些方法的。

1.1、队列的增

offer()添加队尾元素

public boolean offer(E e) {
    return add(e);
}

具体的实现就是在尾部添加一个元素

1.2、队列的删

poll()是队列的数据结构,获取对头元素并且删除队头元素

public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

具体的实现前面已经讲过,删除的是队列头部的元素

1.3、队列的查

peek()获取队头元素 ,但是不删除队列的头元素

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

1.4、栈的增

push()是栈结构的实现类的方法,把元素压入到栈中

push() 方法的底层实现,其实就是调用了 addFirst(Object o)

public void push(E e) {
    addFirst(e);
}

1.5、栈的删

pop()是栈结构的实现类的方法,返回的是栈顶元素,并且将栈顶元素删除

public E pop() {
    return removeFirst();
}
public E removeFirst() {
    final Node f = first;
    if (f == null)
    throw new NoSuchElementException();
    return unlinkFirst(f);
}

三、手写LinkedList源码

List接口

package com.xuchang.ds.list;

public interface List<E> {
	
	//返回线性表的大小
	public int getSize();

	//判断线性表中是否为空
	public boolean isEmpty();

	//判断线性表中是否包含元素o
	boolean contains(E o);
	
	//在线性表中查找元素o,若成功找到,返回其位置index;否则,返回-1
	public int indexOf(E e);

	//获取线性表中 位置为index的元素
	public E get(int index);

	//将线性表中 位置为index的元素设置为e
	public void set(int index, E e);

	//在线性表中位置为index处添加元素e
	public void add(int index, E e);

	//删除并返回线性表中位置为index的元素
	public E remove(int index);
}

LinkedList

package com.xuchang.ds.list;

/**
 * LinkedList 的源码
 * @param <E>
 */
public class LinkedList<E> implements List<E> {

    private class Node {
        private E data; //数据域
        private Node next; //指向下一个节点Node

        public Node(E data, Node next) {
            this.data = data;
            this.next = next;
        }

        public Node(E data) {
            this(data, null);
        }
    }

    private Node head;

    private int size;


    public LinkedList() {
        head = null;
        size = 0;
    }

    @Override
    public int getSize() {
        return size;
    }

    @Override
    public boolean isEmpty() {
        return size == 0;
    }

    @Override
    public boolean contains(E o) {
        Node p = head;
        while(p  != null) {
            if(p.data.equals(o)){
                return true;
            }

            p = p.next;
        }
        return false;
    }

    @Override
    public int indexOf(E e) {
        int result = -1;
        Node p = head;
        int i = 0;
        while(p != null) {
            if(p.data.equals(e)) {
                result = i;
                break;
            }

            p = p.next;
            i++;
        }

        return result;
    }

    @Override
    public E get(int index) {
        if(index < 0 || index >= size) {
            throw new IllegalArgumentException("数组下标越界...");
        }

        Node p = head;
        for(int i=0; i<index; i++){
            p = p.next;
        }

        return p.data;
    }

    @Override
    public void set(int index, E e) {
        if(index < 0 || index >= size) {
            throw new IllegalArgumentException("数组下标越界...");
        }

        Node p = head;
        for(int i=0; i<index; i++) {
            p = p.next;
        }

        p.data = e;

    }

    @Override
    public void add(int index, E e) {
        if(index < 0 || index > size) {
            throw new IllegalArgumentException("数据下标越界...");
        }

        if(index == 0) {
            addFirst(e);
        }else if(index == size){
            addLast(e);
        } else {
            Node prev = head;
            for(int i=0; i<index; i++) {
                prev = prev.next;
            }

            Node node = new Node(e, prev.next);
            prev.next = node;

            size++;
        }
    }

    private void addFirst(E e) {
        Node node = new Node(e, head);
        head = node;

        size++;
    }

    private void addLast(E e) {
        Node node = new Node(e, null);

        if(head == null) {
            head = node;
        }else {
            Node prev = head;

            while(prev.next != null) {
                prev = prev.next;
            }

            prev.next = node;
        }

        size++;
    }

    @Override
    public E remove(int index) {
        if(index < 0 || index >= size) {
            throw new IllegalArgumentException("数据下标越界...");
        }

        if(index == 0) {
            return removeFirst();
        }else if (index == size - 1) {
            return removeLast();
        }else {
            Node prev = head;
            for(int i=0; i<index-1; i++) {
                prev = prev.next;
            }

            Node tmp = prev.next;
            prev.next = tmp.next;
            tmp.next = null;
            size --;

            return tmp.data;

        }
    }

    private E removeFirst() {
        if(head == null){
            return null;
        }

        E ret = head.data;
        head = head.next;

        size--;

        return ret;
    }

    private E removeLast() {
        if(head == null) {
            return null;
        }

        E ret;

        if(head.next == null) {
            ret = head.data;
            head = null;
        }else {
            Node prev = head;

            while(prev.next.next != null) {
                prev = prev.next;
            }

            ret = prev.next.data;
            prev.next = null;
        }

        size--;

        return ret;
    }

    public static void main(String[] args) {
        List<Integer> list = new LinkedList<Integer>();

        for(int i=0; i<10; i++) {
            list.add(i, i);
        }

        for(int i=0; i<list.getSize(); i++) {
            System.out.println("The " + i + "th element is: " + list.get(i));
        }

        for(int i=0; i<5; i+=2) {
            list.remove(i);
        }

        for(int i=0; i<list.getSize(); i++) {
            System.out.println("After removing, The " + i + "th element is: " + list.get(i));
        }
    }
}