设计模式之观察者模式(Observer Pattern)

1.概念

定义对象之间的一种一对多依赖关系，使得每当一个对象状态发生改变时，其相关依赖对象皆得到通知并被自动更新。观察者模式是一种对象行为型模式。
观察者模式包含观察目标和观察者两类对象，一个目标可以有任意数目的与之相依赖的观察者，一旦观察目标的状态发生改变，所有的观察者都将得到通知。

2.角色

Subject（目标）：目标又称为主题，它是指被观察的对象。在目标中定义了一个观察者集合，一个观察目标可以接受任意数量的观察者来观察，它提供一系列方法来增加和删除观察者对象，同时它定义了通知方法notify()。目标类可以是接口，也可以是抽象类或具体类。

ConcreteSubject（具体目标）：具体目标是目标类的子类，通常它包含有经常发生改变的数据，当它的状态发生改变时，向它的各个观察者发出通知；同时它还实现了在目标类中定义的抽象业务逻辑方法（如果有的话）。如果无须扩展目标类，则具体目标类可以省略。

Observer（观察者）：观察者将对观察目标的改变做出反应，观察者一般定义为接口，该接口声明了更新数据的方法update()，因此又称为抽象观察者。

ConcreteObserver（具体观察者）：在具体观察者中维护一个指向具体目标对象的引用，它存储具体观察者的有关状态，这些状态需要和具体目标的状态保持一致；它实现了在抽象观察者Observer中定义的update()方法。通常在实现时，可以调用具体目标类的attach()方法将自己添加到目标类的集合中或通过detach()方法将自己从目标类的集合中删除。

3.代码实现

3.1 JDK中Observer和Observable的实现
Observer是一个接口，定义了update方法，

public interface Observer {
    void update(Observable o, Object arg);
}

Observer是观察者角色，当目标发生变化时，调用观察者的update方法。
Observable类是目标类，其内部维护了一个观察者的集合Vector,并提供了向集合中添加观察者和删除观察者的方法，除此之外，Observable中的notify方法，就是循环遍历Vector中的观察者，并调用观察者update方法的过程。以此来实现发布-订阅效果。Observable类中的方法是线程安全的。源码如下:

public class Observable {
    private boolean changed = false;
    private Vector<Observer> obs = new Vector();

    public Observable() {
    }
    // 用于注册新的观察者对象到向量中
    public synchronized void addObserver(Observer var1) {
        if (var1 == null) {
            throw new NullPointerException();
        } else {
            if (!this.obs.contains(var1)) {
                this.obs.addElement(var1);
            }

        }
    }
    // 用于删除向量中的某一个观察者对象
    public synchronized void deleteObserver(Observer var1) {
        this.obs.removeElement(var1);
    }

    public void notifyObservers() {
        this.notifyObservers((Object)null);
    }
    // 通知方法，用于在方法内部循环调用向量中每一个观察者的update()方法
    public void notifyObservers(Object var1) {
        Object[] var2;
        synchronized(this) {
            if (!this.changed) {
                return;
            }

            var2 = this.obs.toArray();
            this.clearChanged();
        }

        for(int var3 = var2.length - 1; var3 >= 0; --var3) {
            ((Observer)var2[var3]).update(this, var1);
        }

    }
    // 用于清空向量，即删除向量中所有观察者对象
    public synchronized void deleteObservers() {
        this.obs.removeAllElements();
    }
    // 该方法被调用后会设置一个boolean类型的内部标记变量changed的值为true，表示观察目标对象的状态发生了变化
    protected synchronized void setChanged() {
        this.changed = true;
    }
    // 用于将changed变量的值设为false，表示对象状态不再发生改变或者已经通知了所有的观察者对象，调用了它们的update()方法
    protected synchronized void clearChanged() {
        this.changed = false;
    }
    // 返回对象状态是否改变
    public synchronized boolean hasChanged() {
        return this.changed;
    }
    // 返回向量中观察者的数量
    public synchronized int countObservers() {
        return this.obs.size();
    }
}

我们在使用Observer和Observable时，让我们自定义的目标类继承Observable，直接调用Observable类的方法即可满足目标类的操作。自定义观察者实现Observer接口，实现update方法，做具体的观察者的业务逻辑。
我们以微信接收公众号为例，使用Observer类库，实现给订阅该公众号的微信发布消息功能。
首先，我们定义具体观察者，就是个人的微信号，JDK提供了Observer接口，这个接口就是观察者，所以实现这个接口，就是具体观察者，

/*观察者，观察公众号是否发布文章。实现Observer接口的update方法，就是成为了一个观察者。在业务逻辑处将
*观察者加入目标类集合中，便可以通知该观察者了
 */
public class UserWechat implements Observer {
    String username;

    public UserWechat(String username){
        this.username=username;
    }

    /**
     *
     * @param o
     * @param arg 这个参数是观察者传入的参数，根据这个参数，可以判断是哪个目标类发出的通知，因为一个
     *            观察者可以观察多个目标，只要加入不同的目标类里即可，而update方法，只用实现一次。所以在
     *            update方法里，根据传参的不同，来判断不同目标类的调用。
     */
    @Override
    public void update(Observable o, Object arg) {
        System.out.println(this.username+"接收到了公众号消息");

    }
}

然后，我们定义目标类，JDK的Observable是提供给我们的目标类，我们继承这个类，做一些自定义操作，即可完成自定义的目标类，这里的目标类就是微信公共号，其发布文章，就通知与它绑定的观察者，执行update方法,

//目标类
public class WechatGZH extends Observable {
    //发布文章，去通知观察者们
    public void publishArticle(){
        System.out.println("公众号发布了文章");
        this.setChanged();//固定用法，通过读notifyObservers()方法源码可以知道，不改变这个状态，直接return了，不会走观察者的update方法
        this.notifyObservers();
    }
}

我们在业务逻辑中，就可以创建观察者类，目标类，并将观察者加入目标类中，

public class Demo {
    public static void main(String[] args) {
        WechatGZH gzh=new WechatGZH();
        //绑定观察者
        UserWechat u1=new UserWechat("张三");
        UserWechat u2=new UserWechat("李四");
        UserWechat u3=new UserWechat("王五");
        gzh.addObserver(u1);
        gzh.addObserver(u2);
        gzh.addObserver(u3);
        gzh.publishArticle();
    }
}

这样，就实现了观察者模式订阅-发布公众号通知的业务，

由此我们可以看出，在JDK中使用观察者模式，我们只需定义观察者的update方法，并将观察者加入到目标类里即可。目标类对观察者的维护和通知，都由JDK为我们提供好了，我们无需再定义这些操作。

3.2JDK中事件处理机制
JDK提供了事件处理机制，它的实现，也是应用了观察者模式。我们看其角色:
Source：事件源，即触发事件的对象；就是目标类角色。这个需要程序员自己定义。
EventObject：事件对象，即带有 Source 信息的事件对象，是对Source的包装；这个角色是在事件处理机制中的单独角色，在观察者模式中没有此角色。其实就是业务的封装。
Eventlistener：事件监听器，对该事件的处理。就是观察者角色。

JDK给我们提供的是EventObject类和Eventlistener接口，EventObject是事件对象，Eventlistener是监听器，我们看Eventlistener的源码可知，里面什么也没有，就是一个空接口。
所以，在JDK的事件机制中，并没有给我们提供好目标类。所以，需要我们手动的实现目标类中的监听者集合，并提供维护监听者集合的方法，同时，需要手动的遍历监听者，去调用监听者的方法。这是和Observer中不同的地方。
EventObject是事件对象，JDK为什么会提供这个类呢，它看起来和观察者模式并没有直接的关系。这个类是用来连接事件源和监听器之间的枢纽。我们创建事件类继承EventObject类后，需要定义有参构造，这个有参构造就是传入的事件源类。EventObject有getSource()方法，可以获得这个事件源。那么，在监听器中，我们定义方法时，就可以以EventObject为参数，去获得参数的事件源。那为什么在监听器方法里，不直接使用事件源类为参数呢？因为这样的话，那监听器就只能监听这一个事件源了，而以EventObject为参数，则可以监听多个事件源。我们以getSource的返回值类型为路由，可以判断不同的事件源。
下面，我们以代码的形式体现java事件处理机制。
首先，定义事件对象，该对象用于监听器获取事件源。

/**
 * 事件类，参数source起路由作用，判断事件来源。source就是事件源
 */
public class EventClassOne extends EventObject {
    /**
     * Constructs a prototypical Event.
     *
     * @param source The object on which the Event initially occurred.
     * @throws IllegalArgumentException if source is null.
     */
    public EventClassOne(Object source) {
        super(source);
    }
}

然后，我们定义监听器，需要实现EventListener接口,还要定义监听事件后的方法，用于事件发生后，在事件源调用

class MyEventListener implements EventListener{
	/*EventListener是与EventObject同级的最原始的监听器，当然里面什么方法都没有*/
	public void onMyEvent(EventObject e){
		/*如果该类与EventObject实例处于同一个类中，可以直接使用==判断事件来源*/
		if(e.getSource() instanceof EventSource){
			/*事件来源于OtherSource时要处理的业务*/
			EventSource tempSrc=(EventSource)e.getSource();
			System.out.println("收到来自"+tempSrc.getActioner()+"的事件!");
		}
		/*else if(e.getSource() instanceof OtherSource){
			System.out.println("事件来源于OtherSource时要处理的业务");
		}*/
	}
}

最后，我们定义事件源，在事件源中，我们需要管理监听者，还需要定义方法，通知监听者。

class EventSource{
	private String who;
	Vector listeners=new Vector();   
	public EventSource(String who){
		this.who=who;
	}
	public String getActioner(){
		return who;
	}
    public void addMyEventListener(MyEventListener listener){
    	listeners.add(listener);
    }
    /*设定say方法能被MyEventListener对象监听到*/
    public void say(String words){
    	System.out.println(this.getActioner()+"说："+words);
    	for(int i=0;i<listeners.size();i++){
    		MyEventListener listener=(MyEventListener) listeners.elementAt(i);
    		/*发布事件。当然应该事先规划say方法事件能发布给哪些事件监听器。*/
    		listener.onMyEvent(new EventClassOne(this));
    	}
    }
}

下面我们来使用这个事件模式

public class Main{
	public static MyEventListener listener = null;
	public static void main(String[] args){
	
		listener = new MyEventListener();
		EventSource 小白 = new EventSource("小白");
		小白.addMyEventListener(listener);
		小白.say("今天天气不错");
		小白.say("适合出去走走");
	}
}