Stack 源码解析

1、简述

• 在说 Stack 之前，咱们先来聊聊栈和队列，什么叫栈？什么叫队列？
• 通俗来讲，栈就是先进后出，队列是先进先出。
• Stack 就是基于栈的思想实现的一个后进先出（last in first out，LIFO）的堆栈。
• 继承于 Vector，并在在 Vector 类的基础上扩展5个方法而来。

2、分析

• 由于 Stack 源码较小，主要功能都在 Voctor 类以及实现，所以咱们直接看源码。

public class Stack<E> extends Vector<E> {

    /**
     * 序列化唯一表示 UID
     */
    private static final long serialVersionUID = 1224463164541339165L;

    /**
     * 无参构造函数
     * 创建一个空的栈
     */
    public Stack() { }

    /**
     * 将一个元素添加到栈顶，线程安全
     *
     * @param item 元素
     * @return
     */
    public E push(E item) {
        addElement(item);
        return item;
    }

    /**
     * 移除栈顶的元素，并且返回该元素，线程安全
     *
     * @return 返回将要移除栈顶的元素
     */
    public synchronized E pop() {
        E obj;
        int len = size();

        obj = peek();
        removeElementAt(len - 1);

        return obj;
    }

    /**
     * 查看栈顶的元素，但是不把其移除栈顶，线程安全
     *
     * @return 返回查看的栈顶元素
     */
    public synchronized E peek() {
        // 获取栈内元素长度
        int len = size();
        
        // 等于0代表是一个空栈
        if (len == 0)
            throw new EmptyStackException();
        return elementAt(len - 1);
    }

    /**
     * 判断当前栈是否为空
     *
     * @return true代表为空，false代表不为空
     */
    public boolean empty() {
        return size() == 0;
    }

    /**
     * 获取当前元素在栈中的索引坐标，线程安全
     *
     * @param o 将查找的元素
     * @return 返回-1则代表该栈中不包含当前元素，否则返回其对应的索引位置
     */
    public synchronized int search(Object o) {
        // 获取元素 o 的索引位置
        int i = lastIndexOf(o);
        
        // 大于等于0代表有这个元素，并且返回其在栈内的索引位置
        // 注意i是底层数组的索引位置，size-i 是栈的索引位置
        if (i >= 0) {
            return size() - i;
        }
        return -1;
    }
}