JDK自帶的Observable和Observer實現觀察者模式

觀察者模式是Java非常重要的一個設計模式。對於觀察者模式，JDK已經為我們提供了對應的接口和類。

分別是觀察者Observer，觀察者也成為訂閱者Subscribe，

JDK代碼為：

package java.util;

/**
 * A class can implement the <code>Observer</code> interface when it
 * wants to be informed of changes in observable objects.
 *
 * @author  Chris Warth
 * @see     java.util.Observable
 * @since   JDK1.0
 */
public interface Observer {
    /**
     * This method is called whenever the observed object is changed. An
     * application calls an <tt>Observable</tt> object's
     * <code>notifyObservers</code> method to have all the object's
     * observers notified of the change.
     *
     * @param   o     the observable object.
     * @param   arg   an argument passed to the <code>notifyObservers</code>
     *                 method.
     */
    void update(Observable o, Object arg);
}

Observer是一個接口，只是一個方法update用於接收通知者的通知並做出相應，具體的邏輯肯定是需要開發者自己實現的了。

被觀察者（或通知者（Publish，發布者）），JDK的源碼如下：

package java.util;

public class Observable {
    private boolean changed = false;

    private Vector obs;

    /** Construct an Observable with zero Observers. */

    public Observable() {
        obs = new Vector();
    }

    /**
     * 添加一個觀察者（訂閱者），已經存在則不再重復添加
     * 支持多線程*/
    public synchronized void addObserver(Observer o) {
        if (o == null)
            throw new NullPointerException();
        if (!obs.contains(o)) {
            obs.addElement(o);
        }
    }

    /**
     * 刪除一個觀察者（訂閱者Subscribe）
     * 支持多線程*/
    public synchronized void deleteObserver(Observer o) {
        obs.removeElement(o);
    }

    /**
     * 通知觀察者（訂閱者Subscribe）*/
    public void notifyObservers() {
        notifyObservers(null);
    }

    /**
     * 通知觀察者（訂閱者Subscribe），帶參數*/
    public void notifyObservers(Object arg) {

        Object[] arrLocal;

        synchronized (this) {
            if (!changed)
                return;
            arrLocal = obs.toArray();
            clearChanged();
        }

        for (int i = arrLocal.length-1; i>=0; i--)
            ((Observer)arrLocal[i]).update(this, arg);
    }

    /**
     * 刪除所有觀察者（訂閱者Subscribe）
     */
    public synchronized void deleteObservers() {
        obs.removeAllElements();
    }

    /**
     * 設置變更
     */
    protected synchronized void setChanged() {
        changed = true;
    }

    /**
     * 清除變更*/
    protected synchronized void clearChanged() {
        changed = false;
    }

    /**
     * 獲取變更標識
*/
    public synchronized boolean hasChanged() {
        return changed;
    }

    /**
     * 獲得觀察者數（訂閱者數Subscribe）*/
    public synchronized int countObservers() {
        return obs.size();
    }
}

Java源碼考慮比較周到的。首先，使用Vector，Vector相比於ArrayList來說，它是線程安全的。其次，在添加和刪除觀察者時對兩個方法使用了synchronized關鍵字，

這都是在為多線程考慮。確實Java源碼並不是那么可怕，它同樣也是由一些最簡單最基礎的組合而來。

 

下面看兩個實例

實例一

NumObserable是一個被觀察者，當它的成員變量data的數值發生變化時，會通知所有的觀察者。

NumObserable.java

/**
 * 被觀察者*/
public class NumObservable extends Observable {
    
    private int data = 0;
 
    public int getData() {
       return data;
    }
 
    public void setData(int i) {
       data = i;
       setChanged();
       notifyObservers();
    }
}

NumObserver是觀察者。當它的被觀察者(NumObserable)執行了notifyObservers()后，它會執行uodate()方法。

NumObserver.java

public class NumObserver implements Observer {

    @Override
    public void update(Observable o, Object arg) {

        NumsObservable myObserable = (NumsObservable) o;
        System.out.println("Data has changed to " + myObserable.getData());

    }

}

測試類SingleTest，在這里將觀察者加入到被觀察者的觀察列表中。

SingleTest.java

public class SingleTest {

    /**
     * @param args
     */
    public static void main(String[] args) {

        NumObservable number = new NumObservable();
        number.addObserver(new NumObserver());
        number.setData(1);
        number.setData(2);
        number.setData(3);

    }

}

結果：

Data has changed to 1

 Data has changed to 2

 Data has changed to 3

實例二

這個實例中，還是對data進行觀察，擁有兩個觀察者，分別觀察奇數和偶數的變化，通過notifyObservers(arg)中的參數arg來識別通知信息。

被觀察者NumsObservable.java

public class NumsObservable extends Observable {
    
    public final static Integer ODD = 1;
    public final static Integer EVEN = 2;
    private int data = 0;
 
    public int getData() {
       return data;
    }
 
    public void setData(int i) {
       data = i;
       Integer flag = EVEN;
       if ((data & 0x0001) == 1)
           flag = ODD;
       setChanged();
       notifyObservers(flag);
    }

}

奇數觀察者OddObserver.java

 

public class OddObserver implements Observer {

    @Override
    public void update(Observable o, Object arg) {
        if (arg == NumsObservable.ODD) {
            NumsObservable myObserable = (NumsObservable) o;
            System.out.println("OddObserver:Data has changed to "
                    + myObserable.getData());
        }
    }

}

 

偶數觀察者EvenObserver.java

 

public class EvenObserver implements Observer {

    @Override
    public void update(Observable o, Object arg) {
        if (arg == NumsObservable.EVEN) {
            NumsObservable myObserable = (NumsObservable) o;
            System.out.println("EvenObserver:Data has changed to "
                    + myObserable.getData());
        }

    }

}

 

測試類MultiTest.java

 

public class MultiTest {

    /**
     * @param args
     */
    public static void main(String[] args) {

        NumsObservable number = new NumsObservable();
        number.addObserver(new OddObserver());
        number.addObserver(new EvenObserver());
        number.setData(1);
        number.setData(2);
        number.setData(3);

    }

}

結果：

OddObserver:Data has changed to 1

EvenObserver:Data has changed to 2

OddObserver:Data has changed to 3