JavaのObserverデザインパターン

オブザーバーパターンは、行動設計パターンの1つです。オブザーバーパターンは、オブジェクトの状態に興味があり、変更があるたびに通知を受け取りたい場合に役立ちます。オブザーバーパターンでは、他のオブジェクトの状態を監視するオブジェクトがオブザーバーと呼ばれ、監視されているオブジェクトがサブジェクトと呼ばれます。

オブザーバーデザインパターン

GoFによると、オブザーバーデザインパターンの意図は、

オブジェクト間の1対多の依存関係を定義し、1つのオブジェクトが状態を変更すると、そのすべての依存オブジェクトが自動的に通知および更新されるようにすることです。

サブジェクトには、その状態の変更を通知するためのオブザーバーのリストが含まれているため、オブザーバーが自分自身を登録および登録解除する方法を提供する必要があります。サブジェクトには、変更を通知するためのすべてのオブザーバーに通知するメソッドも含まれており、通知中に更新を送信するか、更新を取得する別のメソッドを提供することができます。オブザーバーには、監視するオブジェクトを設定するメソッドと、サブジェクトが更新を通知するために使用する別のメソッドが必要です。Javaは、java.util.Observableクラスとjava.util.Observerインターフェイスを介してオブザーバーパターンを実装するための組み込みプラットフォームを提供しています。ただし、実装が非常に単純であり、Javaはクラスでの多重継承を提供しないため、オブザーバーパターンを実装するためにクラスを拡張することが望ましくない場合がほとんどです。Java Message Service（JMS）は、アプリケーションが他のアプリケーションにデータを購読および公開できるようにするために、オブザーバーデザインパターンとMediatorパターンを使用しています。モデル-ビュー-コントローラー（MVC）フレームワークもオブザーバーパターンを使用しており、モデルがサブジェクトであり、ビューがモデルの変更を通知するために登録できるオブザーバーです。

ObserverパターンのJavaの例

観察者パターンのJavaプログラム例について、シンプルなトピックと観察者を実装します。観察者はこのトピックに登録できます。トピックに新しいメッセージが投稿されるたびに、登録された観察者全員に通知され、メッセージを消費できます。Subjectの要件に基づいて、任意の具体的なSubjectによって実装される契約メソッドを定義するベースのSubjectインタフェースがここにあります。

package com.journaldev.design.observer;

public interface Subject {

	//観察者を登録および登録解除するためのメソッド
	public void register(Observer obj);
	public void unregister(Observer obj);
	
	//変更を観察者に通知するためのメソッド
	public void notifyObservers();
	
	//サブジェクトからの更新を取得するメソッド
	public Object getUpdate(Observer obj);
	
}

次に、Observerの契約を作成します。ObserverをSubjectにアタッチするためのメソッドと、変更を通知するためにSubjectが使用する別のメソッドがあります。

package com.journaldev.design.observer;

public interface Observer {
	
	//サブジェクトによって使用されるオブザーバーを更新するメソッド
	public void update();
	
	//観察するためにサブジェクトにアタッチする
	public void setSubject(Subject sub);
}

これで契約が整いましたので、トピックの具体的な実装に進みましょう。

package com.journaldev.design.observer;

import java.util.ArrayList;
import java.util.List;

public class MyTopic implements Subject {

	private List observers;
	private String message;
	private boolean changed;
	private final Object MUTEX= new Object();
	
	public MyTopic(){
		this.observers=new ArrayList<>();
	}
	@Override
	public void register(Observer obj) {
		if(obj == null) throw new NullPointerException("Null Observer");
		synchronized (MUTEX) {
		if(!observers.contains(obj)) observers.add(obj);
		}
	}

	@Override
	public void unregister(Observer obj) {
		synchronized (MUTEX) {
		observers.remove(obj);
		}
	}

	@Override
	public void notifyObservers() {
		List observersLocal = null;
		//メッセージが受信された後に登録された観察者に通知されないように同期が使用されます
		synchronized (MUTEX) {
			if (!changed)
				return;
			observersLocal = new ArrayList<>(this.observers);
			this.changed=false;
		}
		for (Observer obj : observersLocal) {
			obj.update();
		}

	}

	@Override
	public Object getUpdate(Observer obj) {
		return this.message;
	}
	
	//トピックにメッセージを投稿するためのメソッド
	public void postMessage(String msg){
		System.out.println("Message Posted to Topic:"+msg);
		this.message=msg;
		this.changed=true;
		notifyObservers();
	}

}

メソッドの実装には、オブザーバーを登録および解除するための非常にシンプルな手順があります。追加のメソッドはpostMessage()であり、これはクライアントアプリケーションがトピックに文字列メッセージを投稿するために使用されます。トピックの状態の変化を追跡するためのブール変数に注目してください。この変数は、更新がない場合にnotifyObservers()メソッドを呼び出すと、観察者に誤った通知を送信しないようにするために必要です。また、notifyObservers()メソッドでsynchronizationの使用にも注目してください。これにより、メッセージがトピックに公開される前に登録された観察者にのみ通知が送信されるようになります。サブジェクトを監視するオブザーバーの実装も以下になります。

package com.journaldev.design.observer;

public class MyTopicSubscriber implements Observer {
	
	private String name;
	private Subject topic;
	
	public MyTopicSubscriber(String nm){
		this.name=nm;
	}
	@Override
	public void update() {
		String msg = (String) topic.getUpdate(this);
		if(msg == null){
			System.out.println(name+":: No new message");
		}else
		System.out.println(name+":: Consuming message::"+msg);
	}

	@Override
	public void setSubject(Subject sub) {
		this.topic=sub;
	}

}

update()メソッドの実装に注目してください。これはサブジェクトのgetUpdate()メソッドを呼び出してメッセージを消費しています。メッセージをupdate()メソッドの引数として渡すことで、この呼び出しを回避できました。以下は、トピックの実装を消費するための単純なテストプログラムです。

package com.journaldev.design.observer;

public class ObserverPatternTest {

	public static void main(String[] args) {
		//サブジェクトの作成
		MyTopic topic = new MyTopic();
		
		//オブザーバーの作成
		Observer obj1 = new MyTopicSubscriber("Obj1");
		Observer obj2 = new MyTopicSubscriber("Obj2");
		Observer obj3 = new MyTopicSubscriber("Obj3");
		
		//サブジェクトにオブザーバーを登録
		topic.register(obj1);
		topic.register(obj2);
		topic.register(obj3);
		
		//サブジェクトにオブザーバーをアタッチ
		obj1.setSubject(topic);
		obj2.setSubject(topic);
		obj3.setSubject(topic);
		
		//更新があるかどうかを確認
		obj1.update();
		
		//今、サブジェクトにメッセージを送信
		topic.postMessage("New Message");
	}

}

上記のプログラムを実行すると、以下の出力が得られます。

Obj1:: No new message
Message Posted to Topic:New Message
Obj1:: Consuming message::New Message
Obj2:: Consuming message::New Message
Obj3:: Consuming message::New Message

Java Observer Pattern Class Diagram

オブザーバーデザインパターンは、発行-購読パターンとも呼ばれます。その実装のいくつかは、

• Swingのjava.util.EventListener
• javax.servlet.http.HttpSessionBindingListener
• javax.servlet.http.HttpSessionAttributeListener

これがJavaでのObserverデザインパターンのすべてです。気に入っていただければ幸いです。コメントや他の人と共有して愛を分かち合ってください。