Коллекция JAVA: анализ исходного кода LinkedList

Node.js Java задняя часть исходный код

LinkedList

В дополнение к наиболее часто используемому ArrayList в списке, LinkedList также более распространен, и реализация этих двух списков различна Конкретную реализацию легко понять, просмотрев исходный код (следующий исходный код взят из jdk1.8.0). _20)

структура наследования

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

LinkedList наследует AbstractSequentialList и реализует интерфейс List, интерфейс Deque и интерфейс java.io.Serializable.Из его механизма наследования видно, что это реализация очереди.

Переменные-члены

  • размер
    transient int size = 0;

  • первый узел
    transient Node<E> first;

  • последний узел
    transient Node<E> last;

Структура узла

Узел хранит текущий элемент, предыдущий узел и следующий узел.

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 имеет конструктор нулевого параметра и конструктор параметра коллекции.

public LinkedList() {
}

public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);  //把集合中所有节点添加到list中
}

public boolean addAll(Collection<? extends E> c) {
    return addAll(size, c);
}

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;
    if (index == size) {    //把集合c插入到最后面
        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节点是最后一个插入的节点
        last = pred;
    } else {
        pred.next = succ;
        succ.prev = pred;
    }

    size += numNew;     //list大小加上增加集合的元素数量
    modCount++;         //修改次数加1
    return true;
}

private void checkPositionIndex(int index) {
    if (!isPositionIndex(index))
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
private boolean isPositionIndex(int index) {
    return index >= 0 && index <= size;     //比较index在0到size之间
}

/**
*   获取下标为index的节点
*/
Node<E> node(int index) {
    // assert isElementIndex(index);

    if (index < (size >> 1)) {      //如果index在前半部分，则从前循环
        Node<E> x = first;
        for (int i = 0; i < index; i++)
            x = x.next;
        return x;
    } else {                        //如果index在后半部分，则从后循环
        Node<E> x = last;
        for (int i = size - 1; i > index; i--)
            x = x.prev;
        return x;
    }
}

основной метод

  • добавить метод
    • add(E e), метод параметра, добавленный в конец списка по умолчанию
    public boolean add(E e) {
        linkLast(e);
        return true;
    }
    void linkLast(E e) {
        final Node<E> l = last;
        final Node<E> newNode = new Node<>(l, e, null);     //新建node节点，pre指向list中的last节点
        last = newNode;
        if (l == null)          //如果list为空，新增节点赋值给first
            first = newNode;
        else
            l.next = newNode;   //如果不为空，list中的last指向新增节点，完成新增节点动作
        size++;
        modCount++;
    }
    • add(int index, E element), добавить элемент element в позицию индекса нижнего индекса
    public void add(int index, E element) {
        checkPositionIndex(index);

        if (index == size)  //如果index等于size，添加到list最后面
            linkLast(element);
        else
            linkBefore(element, node(index));
    }
    
    void linkBefore(E e, Node<E> succ) {
        // assert succ != null;
        final Node<E> pred = succ.prev;
        final Node<E> newNode = new Node<>(pred, e, succ);  //插入到当前index上的节点和它的pred节点中间
        succ.prev = newNode;
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        size++;
        modCount++;
    }
  • Существует также метод add для добавления набора, который был представлен выше, а также методы addFirst(E e) и addLast(E e) реализованного интерфейса Deque.
    • addAll(Collection<? extends E> c)
    • addAll(int index, Collection<? extends E> c)
    • addFirst(E e) linkFirst插入到最前面
    • addLast(E e) 和add(E e)一样 
    private void linkFirst(E e) {
        final Node<E> f = first;
        final Node<E> newNode = new Node<>(null, e, f);
        first = newNode;
        if (f == null)
            last = newNode;
        else
            f.prev = newNode;
        size++;
        modCount++;
    }
  • получить метод
    • get(int index) //Получить элемент по индексу индекса
    • getFirst() //Получить первый элемент (значение первого узла)
    • getLast() //Получить последний элемент (значение последнего узла)
    public E get(int index) {
        checkElementIndex(index);
        return node(index).item;    //node(index)获取下标index的node节点
    }

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

public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }
  • метод удаления
    • remove()删除第一个元素，直接调用的removeFirst()方法
    • remove(int index)删除下标index上的元素，如果下边越界，会抛IndexOutOfBoundsException异常
    • remove(Object o)删除第一个匹配到的元素o
    • removeFirst()删除第一个元素（如果list为空，会抛出NoSuchElementException异常）
    • removeFirstOccurrence(Object o)直接调用remove(o)
    • removeLast()删除最后一个元素（如果list为空，会抛出NoSuchElementException异常）
    • removeLastOccurrence(Object o)删除最后一个匹配到的元素 
    public E remove() {
        return removeFirst();
    }
    public E removeFirst() {
        final Node<E> f = first;
        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;
        f.item = null;
        f.next = null; // 断开删除节点的连接，帮助垃圾回收
        first = next;
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }
    
    public E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index)); //删除下标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节点，即删除当前节点
            first = next;
        } else {
            prev.next = next;   //否则，前一个节点的next指向下一个节点
            x.prev = null;
        }

        if (next == null) { //如果是尾节点，last指向前一个节点，即删除当前节点
            last = prev;
        } else {
            next.prev = prev;   //否则，下一个节点的prev指向前一个节点
            x.next = null;
        }

        x.item = null;
        size--;
        modCount++;
        return element;
    }
    
    /**
    * 删除list中最前面的元素o（如果存在），从first节点往后循环查找
    * null的equals方法总是返回false，所以需要分开判断
    */
    public boolean remove(Object o) {
        if (o == null) {
            for (Node<E> x = first; x != null; x = x.next) {    //从first节点往后循环，删除第一个匹配的元素，结束循环
                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;
    }
    
    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }
    
    public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }
    
    public boolean removeLastOccurrence(Object o) { //删除list中最后面的元素o（如果存在），从last节点往前循环查找即可
        if (o == null) {
            for (Node<E> x = last; x != null; x = x.prev) {
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            for (Node<E> x = last; x != null; x = x.prev) {
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }
  • метод peek, возвращает первый элемент в списке, не удаляет, если список пуст, возвращает null
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }
  • Метод poll возвращает первый элемент в списке и удаляет его,Если список пуст, вернуть null 
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }
    • peekFirst(), то же, что peek()
    • peekLast(), возвращает последний элемент, не удаляет
    • pollFirst(), то же, что и poll()
    • pollLast(), возвращает последний элемент и удаляет его

  • метод push(E e), добавить элементы,

    public void push(E e) {
        addFirst(e);
    }
  • Метод pop() удаляет первый элемент в списке,Если список пуст, бросить NoSuchElementException 
    public E pop() {
        return removeFirst();
    }
  • метод clear() для удаления всех элементов в списке
    public void clear() {
        for (Node<E> x = first; x != null; ) {  //循环list，把item、next、prev赋值为null，帮助垃圾回收
            Node<E> next = x.next;
            x.item = null;
            x.next = null;
            x.prev = null;
            x = next;
        }
        first = last = null;
        size = 0;
        modCount++;
    }
  • метод clone(), скопируйте идентичный список
    public Object clone() {
        LinkedList<E> clone = superClone();

        // 初始化list的状态
        clone.first = clone.last = null;
        clone.size = 0;
        clone.modCount = 0;

        // 把原list中的元素复制到新list中
        for (Node<E> x = first; x != null; x = x.next)
            clone.add(x.item);

        return clone;
    }
    
    private LinkedList<E> superClone() {
        try {
            return (LinkedList<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }
    }
  • содержит (Object o) метод, чтобы определить, содержится ли элемент o в списке
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }
  • Метод Indexof (Object O), возвращаемый элемент или индекс
    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;
    }
  • Метод 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;
    }
  • метод size, возвращает размер списка
    public int size() {
        return size;
    }
  • метод toArray(), который копирует элементы списка в новый массив и возвращает массив
    public Object[] toArray() {
        Object[] result = new Object[size];
        int i = 0;
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;
        return result;
    }
  • toArray(T[] a) скопировать элементы списка в указанный массив
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            a = (T[])java.lang.reflect.Array.newInstance(
                                a.getClass().getComponentType(), size);
        int i = 0;
        Object[] result = a;
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;

        if (a.length > size)
            a[size] = null;

        return a;
    }

ListIteratorIterator

  • listIterator(int index)
    public ListIterator<E> listIterator(int index) {
        checkPositionIndex(index);
        return new ListItr(index);
    }

Итератор в LinkedList относительно прост, он использует переменные next, nextIndex и lastReturned для пометки.

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

Суммировать

  • ArrayList реализован как массив, а LinkedList реализован как связанный список.
  • Исходный код LinkedList относительно прост, и легко понять его структуру хранения, предоставляемые методы и реализацию.
Категории