JavaでのObserverデザインパターン

2年 ago

芽依, 雨夜

3 minutes

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

Observerデザインパターン

GoFによれば、オブザーバーデザインパターンの意図は次の通りです：

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

主題は、その状態の変化を通知するための観察者のリストを含んでいるため、観察者が自分自身を登録および登録解除するためのメソッドを提供する必要があります。主題にはまた、変更の通知をオブザーバーに送信しながら更新を提供するか、または更新を取得する別のメソッドを提供するメソッドも含まれています。Javaは、java.util.Observableクラスとjava.util.Observerインターフェースを通じてObserverパターンを実装するための組み込みのプラットフォームを提供しています。ただし、実装が非常にシンプルなため、多くの場合、Javaではクラスの拡張のためだけにObserverパターンを実装したくありません。Java Message Service（JMS）では、ObserverデザインパターンとMediatorパターンを使用して、アプリケーションが他のアプリケーションにデータを購読および公開することができます。Model-View-Controller（MVC）フレームワークでは、モデルが主題であり、ビューがモデルの変更に通知されるために登録できるオブザーバーです。

オブザーバーパターンのJavaの例を示す。

私たちのオブザーバーパターンのJavaプログラムの例では、シンプルなトピックを実装し、オブザーバーはこのトピックに登録することができます。トピックに新しいメッセージが投稿されるたびに、登録されたオブザーバー全員に通知され、メッセージを受け取ることができます。Subjectの要件に基づいて、具体的なSubjectが実装する契約メソッドを定義する基本的なSubjectインターフェースがあります。

package com.scdev.design.observer;

public interface Subject {

	//methods to register and unregister observers
	public void register(Observer obj);
	public void unregister(Observer obj);
	
	//method to notify observers of change
	public void notifyObservers();
	
	//method to get updates from subject
	public Object getUpdate(Observer obj);
	
}

次に、私たちはオブザーバーのための契約を作成します。オブザーバーにサブジェクトをアタッチするためのメソッドと、サブジェクトが変更を通知するために使用する別のメソッドがあります。

package com.scdev.design.observer;

public interface Observer {
	
	//method to update the observer, used by subject
	public void update();
	
	//attach with subject to observe
	public void setSubject(Subject sub);
}

今や契約は完了していますので、具体的な実施に進みましょう。

package com.scdev.design.observer;

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

public class MyTopic implements Subject {

	private List<Observer> 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<Observer> observersLocal = null;
		//synchronization is used to make sure any observer registered after message is received is not notified
		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;
	}
	
	//method to post message to the topic
	public void postMessage(String msg){
		System.out.println("Message Posted to Topic:"+msg);
		this.message=msg;
		this.changed=true;
		notifyObservers();
	}

}

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

package com.scdev.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（）メソッドの実装に注目してください。このメソッドでは、SubjectのgetUpdate（）メソッドを呼び出してメッセージを取得し、消費しています。この呼び出しを回避するために、メッセージを引数としてupdate（）メソッドに渡すことができます。以下に、私たちのトピックの実装を消費するための簡単なテストプログラムを示します。

package com.scdev.design.observer;

public class ObserverPatternTest {

	public static void main(String[] args) {
		//create subject
		MyTopic topic = new MyTopic();
		
		//create observers
		Observer obj1 = new MyTopicSubscriber("Obj1");
		Observer obj2 = new MyTopicSubscriber("Obj2");
		Observer obj3 = new MyTopicSubscriber("Obj3");
		
		//register observers to the subject
		topic.register(obj1);
		topic.register(obj2);
		topic.register(obj3);
		
		//attach observer to subject
		obj1.setSubject(topic);
		obj2.setSubject(topic);
		obj3.setSubject(topic);
		
		//check if any update is available
		obj1.update();
		
		//now send message to subject
		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のオブザーバーパターンのクラス図

オブザーバーデザインパターンは、パブリッシュ-サブスクライブパターンとも呼ばれています。いくつかの実装例は次の通りです。

java.util.EventListener in Swing
javax.servlet.http.HttpSessionBindingListener
javax.servlet.http.HttpSessionAttributeListener

これでJavaのObserverデザインパターンについての説明は終わりです。お気に入りになりましたか。感想や他の人と共有することで愛を共有してください。