Наблюдатель (Observer) – шаблон проектирования в Java

Шаблон Наблюдатель – один из паттернов поведения. Шаблон наблюдения полезен, когда вас интересует состояние объекта, и вы хотите получать уведомления при любом изменении. В шаблоне наблюдения объекты, следящие за состоянием другого объекта, называются Наблюдатели, а объект, за которым ведется наблюдение, называется Субъект.

Шаблон Проектирования Наблюдатель

Согласно GoF, намерение шаблона наблюдателя таково:

Установить зависимость “один ко многим” между объектами, чтобы при изменении состояния одного объекта все его зависимые объекты автоматически получали уведомления и обновлялись.

Тема содержит список наблюдателей, которых нужно уведомлять об изменении ее состояния, поэтому она должна предоставлять методы, с помощью которых наблюдатели могут регистрировать и отменять свою регистрацию. Тема также содержит метод для уведомления всех наблюдателей об изменении, и либо она может отправлять обновление во время уведомления наблюдателя, либо она может предоставить другой метод для получения обновления. Наблюдатель должен иметь метод для установки объекта для наблюдения и еще один метод, который будет использоваться Темой для уведомления их об изменениях. Java предоставляет встроенную платформу для реализации шаблона Наблюдатель через класс java.util.Observable и интерфейс java.util.Observer. Однако его редко используют, потому что реализация действительно проста, и большую часть времени мы не хотим расширять класс только для реализации шаблона Наблюдатель, так как Java не предоставляет множественное наследование в классах. Java Message Service (JMS) использует шаблон проектирования Наблюдатель вместе с шаблоном посредника, чтобы позволить приложениям подписываться и публиковать данные для других приложений. Фреймворки Model-View-Controller (MVC) также используют шаблон Наблюдатель, где Модель является Темой, а Представления являются наблюдателями, которые могут регистрироваться, чтобы получать уведомления об изменениях в модели.

Пример шаблона Наблюдатель на Java

Для нашего примера программы на языке Java, использующего шаблон Observer, мы реализуем простую тему, к которой могут подписываться наблюдатели. Когда к теме будет добавлено новое сообщение, все зарегистрированные наблюдатели будут уведомлены и смогут потребить сообщение. На основе требований к Subject, вот базовый интерфейс Subject, который определяет методы контракта, которые должны быть реализованы любым конкретным subject.

package com.journaldev.design.observer;

public interface Subject {

	//методы для регистрации и отмены регистрации наблюдателей
	public void register(Observer obj);
	public void unregister(Observer obj);
	
	//метод для уведомления наблюдателей об изменении
	public void notifyObservers();
	
	//метод для получения обновлений от subject
	public Object getUpdate(Observer obj);
	
}

Далее мы создадим контракт для Observer, в котором будет метод для присоединения Subject к наблюдателю и еще один метод, который будет использоваться Subject для уведомления об изменениях.

package com.journaldev.design.observer;

public interface Observer {
	
	//метод для обновления наблюдателя, используемый subject
	public void update();
	
	//присоединение к subject для наблюдения
	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(), чтобы убедиться, что уведомление отправляется только наблюдателям, зарегистрированным до публикации сообщения в тему. Вот реализация наблюдателей, которые будут следить за объектом.

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() объекта Subject для получения сообщения на обработку. Мы могли бы избежать этого вызова, передав сообщение в качестве аргумента методу 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

Паттерн проектирования наблюдателя также называется паттерном издатель-подписчик. Некоторые из его реализаций:

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

Это все, что касается паттерна проектирования наблюдателя в Java. Надеюсь, вам понравилось. Поделитесь своей любовью комментариями и распространением информации с другими.