从设计源码入手分析LinkedList

链表（Linked List)是一种链式存储的线性表，所有元素的内存地址不一定是连续的。

动态数组有个明显的缺点------>可能浪费大量存储空间，而链表能够做到用到多少就申请多少内存。

这里我通过设计源码，以单链表为例，然后扩展为双向链表，再扩展为循环双向链表，循序渐进，分析LinkedList的本质，大家和我一起来往下分析吧。（注意：官方LinkedList源码是非循环的）

官方设定了一个List接口继承Collection接口，这里我们也设定一个接口为List，但不继承Collection。

public interface List<E> extends Collection<E>//官方接口是这样设计的

链表的大部分接口和动态数组一致，List则是ArrayList和LinkedList的公共接口（这是因为之前我曾模仿官方设计过ArrayList源码，在此就不用LinkedList实现List接口了，方便以后扩展其它集合)，方法类型默认为public。（推荐看下我这篇从设计源码入手分析动态数组再来看此文更好理解：https://blog.youkuaiyun.com/boyas/article/details/117829733

public interface List<E> {
    static final int ELEMENT_NOTFOUND = -1;
    void clear();//清除所有元素
    int size();//元素的数量
    boolean isEmpty();//是否为空
    boolean contains(E element);//是否包含某个元素
    void add(E element);//添加元素到尾部
    E get(int index);//获取Index位置的元素
    E set(int index,E element);//设置index位置的元素
    void add(int index,E element);//在Index位置插入一个元素
    E remove(int index);//删除index位置的元素
    int indexOf(E element);//查看元素的索引
}

下面我们来抽象一个线性表AbstractList为ArrayList和LinkedList的父类，并且实现List接口，这里抽取公共代码。

public abstract class AbstractList<E> implements List<E> {
    protected int size;
    //下标越界抛出的异常
    protected void outOfBounds(int index){
        throw new IndexOutOfBoundsException("Index:"+index+"Size:"+size);
    }
    //检查下标越界(不可访问或删除size位置）
    protected void rangeCheck(int index){
        if (index<0||index>=size){
            outOfBounds(index);
        }
    }
    //检查add()的下标越界(可以在size位置添加元素)
    protected void  rangeCheckForAdd(int index){
        if (index<0||index>size){
            outOfBounds(index);
        }
    }

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

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

    @Override
    public void add(E element) {
        add(size,element);
    }
    @Override
    public boolean contains(E element) {
        return indexOf(element) != ELEMENT_NOTFOUND;
    }
}

这里可能有同学就有疑问了，前面List接口那么多方法，到AbstractList类里怎么就这么点方法呢？不是说子类实现接口就要重写接口中的所有方法吗？

注意：这里我普及一下，在java中，子类是非抽象类，则必须实现接口中的所有方法，子类是抽象类，则可以不实现接口中的所有方法，因为抽象类中允许有抽象方法存在。

接下来我们进入设计LinkedList源码阶段，在这里我们设计一个内部静态类Node（节点类，节点对象只用在内部）。

public class LinkedList<E> extends AbstractList<E> {
    private Node<E> first;
    private static class Node<E>{
        E element;//每个节点存储一个元素
        Node<E> next;//指向下一个节点
        public Node(E element,Node<E> next){
            this.element=element;
            this.next=next;
        }
    }
  }

剩下的其它方法实现与ArrayList是不一样的，我们来看看clear()方法，clear是清空的意思，清空链表（注意此时是单链表）首先size要等于0，其次要将内存销毁，将first等于null就行了。这里可能有同学又有疑问，next是否需要设置为null？（也就是节点之间的那根线是否要断掉）

答案是不需要的。只需要将first置为null，剩下的对象节点依次会挂。

@Override
    public void clear() {
        size = 0;
        first = null;//next没必要设为为null
    }

接下来我们实现add(int index, E element)方法，另外一个add()方法已经放父类里去了，这里我们只需实现这个add()方法即可。在编写链表过程中，要注意边界测试，比如index为0，size-1,size时，这里我们只需考虑index为0，当传入索引为0时，新节点指向first，first指针指向新节点。如果传入的索引不为0，那我们只需要找到这个索引的前一个节点即可，这里我们设置一个方法Node node(int index)获取该位置的对应的节点。当这个方法写好后，我们可以顺便把E get(int index)和E set(int index,E element)两个方法写掉。

 @Override
    public E get(int index) {//获取某个位置对应的元素
        return node(index).element;
    }

    @Override
    public E set(int index, E element) {
        Node<E> node = node(index);
        E old = node.element;//把之前的元素保存在old
        node.element = element;//覆盖
        return old;
    }
    
@Override
    public void add(int index, E element) {//在index位置插入一个元素
        if(index == 0){//添加到0位置
            first = new Node<>(element,first);
        }else {
            Node<E> prev = node(index-1);//获取上一个节点
            prev.next = new Node<>(element,prev.next);//插入一个节点
        }
        size++;//链表长度+1
    }
    private Node<E> node(int index){//获取某个位置对应的节点
        rangeCheck(index);//检查索引
        Node<E> node = first;
        for (int i = 0; i < index ; i++) {//遍历节点
            node = node.next;
        }
        return node;
    }

接下来我们看下删除元素-remove(int index)方法，删除和添加方法很像，当传入索引不为0时，index前面一个节点指向index后面一个节点，将index覆盖掉即可，当传入索引为0时，只需要将first指向first.next即可，是不是很简单呢！

 @Override
    public E remove(int index) {
        Node<E> node = first;//保存删除的元素
        if (index == 0){//删除0位置的元素
            first = first.next;
        }else{
            Node<E> prev= node(index-1);
            node = prev.next;
            prev.next=node.next;
        }
        size--;//链表长度减一
        return node.element;
    }

接下来我们看下indexOf(E element)这个方法，这个和ArrayList的indexOf()方法很像。

@Override
    public int indexOf(E element) {
        if(element == null){
            Node<E> node = first;
            for (int i = 0; i <size ; i++) {//遍历节点
                if (node.element == null) return i;
                node = node.next;
            }
        }else{
            Node<E> node = first;
            for (int i = 0; i < size; i++) {
                if(element.equals(node.element)) return i ;
                node = node.next;
            }
        }
        return ELEMENT_NOTFOUND;
    }

接下来我们需要打印链表，写个toString()方法，这个没啥好讲的，唯一注意的是for循环这里可以换成while循环如while(node!=null)也行。

@Override
    public String toString() {
        StringBuilder string = new StringBuilder();
        string.append("size=").append(size).append(",[");
        Node<E> node = first;
        for (int i = 0; i < size; i++) {
            if (i!=0){
                string.append(",");
            }
            string.append(node.element);
            node = node.next;
        }
        string.append("]");
        return string.toString();
    }
}

测试，给定数据如下，最终结果应是10,30,40。

public class Main {
    public static void main(String[] args) {
        List<Integer> list = new LinkedList<>();//单链表
        list.add(20);
        list.add(0,10);
        list.add(30);
        list.add(list.size(),40);
        list.remove(1);
        System.out.println(list);
    }
}