小心Java中的Stack类

这个周末在用Java做迷宫程序时，想用栈来存储路径，这样的话，如果现位置没有通路了，比较好返回上一位置，探索上一位置的下一个方向。因为Java中有现成的Stack类，所以我想直接拿来用，但是却被它整的老惨了。为什么呢？

举个例子吧。如下代码：

public class TestOfStack {
    Stack<MyPoint> s = new Stack<MyPoint>();
    MyPoint myPoint = new MyPoint(0, 0);
    for (int i = 0; i < 10; i++) {
        s.push(myPoint);
        myPoint.x++;
        myPoint.y++;
    }

    class MyPoint {
        private int x;
        private int y;

        MyPoint() {
            this(0, 0);
        }

        MyPoint(int x, int y) {
            this.x = x;
            this.y = y;
        }
    }
}

MyPoint类是平面上的坐标，for循环中是想将坐标(0,0)、(1,1)…(9,9)压入栈s中，但是实际结果是：栈s中都是(9,9)。关键在于上面代码中红色部分。

首先，来看一下Stack类中push方法的实现：

     public E push(E item) { 
         addElement(item); 

         return item; 
     }

那么，来看addElement方法的实现，这个方法在Vector类中，因为Stack类是继承自Vector的。

  public synchronized void addElement(E obj) {
     modCount++;
     ensureCapacityHelper(elementCount + 1);
     elementData[elementCount++] = obj;
  }

关键在于elementData[elementCount++] = obj; 这是将对象obj直接复制给elementData的，即为深拷贝，这也就意味着将myPoint压入进栈s，实际上是将整个对象压入进了栈中。那么myPoint一改变，栈中的数据也就会相应的改变。这也就说明了最终栈s中存储的是10个(9,9)的缘故。

那么怎么解决呢？可以使用对象组，将每个对象单独的压入进栈，不要轻易改动对象的内容。或者在MyPiont类中添加如下构造方法：

        MyPoint(MyPoint p) {
            this.x = p.x;
            this.y = p.y;
        }

然后将for循环改为

      for (int i = 0; i < 10; i++) {
         MyPoint temp = new MyPoint(myPoint);
         s.push(temp);
         myPoint.x++;
         myPoint.y++;
      }

注意，MyPoint temp = new MyPoint(myPoint); 不能写为MyPoint temp = myPoint;  必须new一个新的对象。这样myPoint的改变不会影响栈中的内容，因为栈中存储的是temp对象，temp和myPoint是不同的对象，仅仅是其值相同而已。

---

最终，我没有使用Java中的Stack类，而是自己写了个简单的Stack类，以MyPoint类为例：

    class MyStack {
        private MyPoint[] elements;
        private int size;
        
        public MyStack(){
            this(10);
        }
        
        public MyStack(int capacity) {
            elements = new MyPoint[capacity];
        }
        
        public MyPoint push(MyPoint value) {
            if (size >= elements.length) {
                MyPoint[] temp = new MyPoint[elements.length*2];
                System.arraycopy(elements,0,temp,0,elements.length);
                elements = temp;
            }

           // 注意此句，不能写成return elements[size++] = value; 
           return elements[size++] = new MyPoint(value);     
        }
       
        public MyPoint pop() {
            return elements[--size];
        }
        
        public MyPoint peek() {
            return elements[size-1];
        }
        
        public boolean empty() {
            return size == 0;
        }
        
        public int getSize(){
            return size;
        }
    }

  ~~~The end~~~

 @ 25th.Oct.2010