• 0

  • 3

动手编写-链表(Java实现)

1星期前

前言

在前面的实现的动手写个Java动态数组里,虽然对于用户而言,看是实现了动态扩容的功能,实际上,只是依托底层写的方法ensureCapacity在数组容量不足的时候,对重新申请一个原数组1.5倍容量的新数组,再将原有数组中存放的元素复制到新数组来,数组指针指向新数组,从根本上来说,这并不是真正的动态。

同时,数组的拷贝,以及数组申请的空间并未全部存储元素,会降低效率,也会造成内存空间的浪费,但这对于链表来说,并不是个问题,链表是做到了用多少内存就申请多少内存空间,这才是真正的动态数据结构。

概念

什么是链表?

链表是一种链式存储的线性表,所有元素的内存地址不一定是连续的

链表的结构

对链表而言,数据是存储在“节点”(Node)中的,可以使用一个数据域来存储数据,这里我称为 element;然后节点中还有一个用来指向下一个节点位置的节点域,一般称为 next。而对于链表的结尾,一般是以 NULL 作为结尾,所以链表中的最后一个节点的节点域 next 指向的是 NULL,图示链表结构:

在这里插入图片描述

链表的设计

/**
  * 定义链表第一结点,指向链表头一个元素
  */
private Node<E> first;

/**
  * 定义结点类Node,包含元素和指向下一个结点的地址引用
  * @param <E>
  */
private static class Node<E>{
    E element;
    Node<E> next;

    public Node(E element, Node<E> next) {
        this.element = element;
        this.next = next;
    }
}
复制代码

Node类是链表中节点的定义,first节点,size并不是存储链表元素,而是用于存储链表的元素数量,在上一节动手实现Java动态数组的时候说到了,链表的大部分接口和动态数组是一致的,Java语言长久不衰的原因有一点就是使用Java这种静态编译型的语言能够写出可维护性高的代码,提倡OCP原则,面向接口编程,面向抽象编程。

在这里把链表和动态数组是一致的方法及属性抽取成List接口和AbstractList抽象类,画一下类图关系:

在这里插入图片描述

List接口中定义的属性与方法

1、属性:

  • int ELEMENT_NOT_FOUND = -1; —— 查无元素的返回标志

2、接口方法:

  • int size(); —— 查询当前链表元素的数量
  • boolean isEmpty(); —— 判断链表是否为空
  • E set(int index, E element); —— 设置index位置的元素
  • E get(int index); —— 获取index位置的元素
  • boolean contains(E element); —— 是否包含element元素
  • int indexOf(E element); —— 查看元素的索引
  • void add(E element); —— 添加元素到尾部
  • void add(int index, E element);—— 在index位置插入一个元素
  • E remove(int index); —— 删除index位置的元素
  • public E remove(E element); —— 删除指定元素
  • void clear(); —— 清除所有元素

AbstractList抽象类定义的属性与方法

将不影响编码的共同方法,在抽象类AbstractList实现,其他方法放到链表类LinkedList或动态数组DynamicArray具体编码实现,这样做的好处就是,提高了代码的复用性和可维护性

1、属性:

  • protected int size; —— 查无元素的返回标志

2、抽象类方法:

  • int size(); —— 查询当前链表元素的数量
  • boolean isEmpty(); —— 判断链表是否为空
  • boolean contains(E element); —— 是否包含element元素
  • int indexOf(E element); —— 查看元素的索引
  • void add(E element); —— 添加元素到尾部
  • protected void outOfBounds(int index) —— 非法索引访问抛出异常
  • protected void rangeCheck(int index) —— 索引检查函数
  • protected void rangeCheckForAdd(int index) —— 添加元素的索引检查函数

LinkedList链表类定义的属性与方法

1、属性

  • private Node<E> first; —— 定义链表第一结点,指向链表头一个元素

2、方法

  • E set(int index, E element); —— 设置index位置的元素
  • E get(int index); —— 获取index位置的元素
  • int indexOf(E element); —— 查看元素的索引
  • void add(int index, E element);—— 在index位置插入一个元素
  • E remove(int index); —— 删除index位置的元素
  • public E remove(E element); —— 删除指定元素
  • void clear(); —— 清除所有元素
  • private Node<E> node(int index) —— 获取index位置对应的结点对象

完成设计后,是具体的方法编码实现,一些简单的方法在这里就不作解释了,注释已经很清楚了,这里讲一些重点的方法

链表初始化

定义在LinkedList 中的private Node<E> first; 以及抽象父类AbstractList中的protected int size;是组成链表的第一节点,在没有添加元素节点之前,它的值是这样的:

在这里插入图片描述

再看一下void add(int index, E element);方法,这是向指定索引添加元素的方法,我们往指定索引添加元素时,需要找到该索引前的节点,再修改指针指向,完成添加元素节点的操作,将该操作提取成private Node<E> node(int index)方法。

讲一下node方法吧,首先这里,我们要明白,first是一个地址引用,也就是链表第一节点,如果size0first指向的是null,如果size不为0,则指向的是链表头节点,来看看node的代码实现:

/**
  * 获取index位置对应的结点对象
  * @param index
  * @return
  */
private Node<E> node(int index){
    rangeCheck(index);

    Node<E> node = first;
    for (int i = 0; i < index; i++) {
        node = node.next;
    }
    return node;
}
复制代码

要查找index索引位置的节点,从first出发,需要next寻找index次,例如我们查找索引为2的节点,过程如下图:

在这里插入图片描述

讲完上面的方法,回到add方法,添加的过程是将新节点指向要插入的索引节点,修改索引前一节点的指向,将其指向新节点,然后size++,这里依据index = 0条件成立与否要划分两种情况,因为index = 0 ,前面是没有元素节点的,只有first节点地址引用,上代码,分析:

/**
 * 在index位置插入一个元素
 *
 * @param index
 * @param element
 */
@Override
public void add(int index, E element) {
    rangeCheckForAdd(index);

    if (index == 0){
        first = new Node<>(element,first);
    }else {
        Node<E> prev = node(index - 1);
        prev.next = new Node<>(element,prev.next);
    }
    size++;
}
复制代码

如果index != 0,就很好理解了,先是Node<E> prev = node(index - 1);,找到索引位置的前一节点,然后修改指针指向,prev.next = new Node<>(element,prev.next);,画图解释:

在这里插入图片描述

当然index = 0 ,也是很好理解的,这里以size = 0,index = 0 为例,画图演示:

在这里插入图片描述

删除节点,和添加的原理是差不多的,这里就不画图解说了。看完上面对于几个重点方法的分析后,相信对于上面链表的结构就不会带有疑惑了

完整代码

List接口

public interface List<E> {

    //查无元素的返回标志
    int ELEMENT_NOT_FOUND = -1;

    /**
     * 元素的数量
     * @return
     */
    int size();

    /**
     * 是否为空
     * @return
     */
    boolean isEmpty();

    /**
     * 设置index位置的元素
     * @param index
     * @param element
     * @return 原来的元素ֵ
     */
    E set(int index, E element);

    /**
     * 获取index位置的元素
     * @param index
     * @return
     */
    E get(int index);

    /**
     * 是否包含某个元素
     * @param element
     * @return
     */
    boolean contains(E element);

    /**
     * 查看元素的索引
     * @param element
     * @return
     */
    int indexOf(E element);

    /**
     * 添加元素到尾部
     * @param element
     */
    void add(E element);


    /**
     * 在index位置插入一个元素
     * @param index
     * @param element
     */
    void add(int index, E element);

    /**
     * 删除index位置的元素
     * @param index
     * @return
     */
    E remove(int index);

    /**
     * 删除指定元素
     * @param element
     * @return
     */
    public E remove(E element);

    /**
     * 清除所有元素
     */
    void clear();
}
复制代码

抽象父类设计

抽象父类AbstractList是对接口List的实现

public abstract class AbstractList<E> implements List<E>  {
    /**
     * 元素的数量
     */
    protected int size;

    /**
     * 元素的数量
     * @return
     */
    public int size() {
        return size;
    }

    /**
     * 是否为空
     * @return
     */
    public boolean isEmpty() {
        return size == 0;
    }

    /**
     * 是否包含某个元素
     * @param element
     * @return
     */
    public boolean contains(E element) {
        return indexOf(element) != ELEMENT_NOT_FOUND;
    }

    /**
     * 添加元素到尾部
     * @param element
     */
    public void add(E element) {
        add(size, element);
    }

    /**
     * 非法索引访问数组异常
     * @param index
     */
    protected void outOfBounds(int index) {
        throw new IndexOutOfBoundsException("Index:" + index + ", Size:" + size);
    }

    /**
     * 索引检查函数
     * @param index
     */
    protected void rangeCheck(int index) {
        if (index < 0 || index >= size) {
            outOfBounds(index);
        }
    }

    /**
     * 数组添加元素的索引检查函数
     * @param index
     */
    protected void rangeCheckForAdd(int index) {
        //index > size,元素可以添加在数组size位置,即数组尾部下一存储单元
        if (index < 0 || index > size) {
            outOfBounds(index);
        }
    }
}
复制代码

链表—LinkedList

public class LinkedList<E> extends AbstractList<E> {

    /**
     * 定义链表第一结点,指向链表头一个元素
     */
    private Node<E> first;

    /**
     * 定义结点类Node,包含元素和指向下一个结点的地址引用
     * @param <E>
     */
    private static class Node<E>{
        E element;
        Node<E> next;

        public Node(E element, Node<E> next) {
            this.element = element;
            this.next = next;
        }
    }

    /**
     * 设置index位置的元素
     *
     * @param index
     * @param element
     * @return 原来的元素ֵ
     */
    @Override
    public E set(int index, E element) {
        Node<E> node = node(index);
        E old = node.element;
        node.element = element;
        return old;
    }

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

    /**
     * 查看元素的索引
     *
     * @param element
     * @return
     */
    @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_NOT_FOUND;
    }

    /**
     * 在index位置插入一个元素
     *
     * @param index
     * @param element
     */
    @Override
    public void add(int index, E element) {
        rangeCheckForAdd(index);

        if (index == 0){
            first = new Node<>(element,first);
        }else {
            Node<E> prev = node(index - 1);
            prev.next = new Node<>(element,prev.next);
        }
        size++;
    }

    /**
     * 删除index位置的元素
     *
     * @param index
     * @return
     */
    @Override
    public E remove(int index) {
        rangeCheck(index);

        Node<E> node =first;
        if (index == 0){
            first = first.next;
        }else {
            Node<E> prev = node(index - 1);
            node = prev.next;
            prev.next = node.next;
        }
        size--;
        return node.element;
    }

    /**
     * 删除指定元素
     *
     * @param element
     * @return
     */
    @Override
    public E remove(E element) {
        return remove(indexOf(element));
    }

    /**
     * 清除所有元素
     */
    @Override
    public void clear() {
        size = 0;
        first =null;
    }

    /**
     * 获取index位置对应的结点对象
     * @param index
     * @return
     */
    private Node<E> node(int index){
        rangeCheck(index);

        Node<E> node = first;
        for (int i = 0; i < index; i++) {
            node = node.next;
        }
        return node;
    }

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

    @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();
    }
}
复制代码
免责声明:文章版权归原作者所有,其内容与观点不代表Unitimes立场,亦不构成任何投资意见或建议。

java

3

相关文章推荐

未登录头像

暂无评论