Шаблон проектирования наблюдателя в Java
Паттерн наблюдателя — это один из паттернов поведенческого проектирования. Шаблон проектирования Observer полезен, когда вас интересует состояние объекта и вы хотите получать уведомления о любых изменениях. В шаблоне наблюдателя объект, который наблюдает за состоянием другого объекта, называется наблюдателем, а объект, за которым наблюдают, называется субъектом.
Шаблон проектирования наблюдателя
Определите зависимость «один ко многим» между объектами, чтобы при изменении состояния одного объекта все его зависимые объекты уведомлялись и обновлялись автоматически.
Субъект содержит список наблюдателей для уведомления о любых изменениях в его состоянии, поэтому он должен предоставлять методы, с помощью которых наблюдатели могут регистрироваться и отменять регистрацию. Субъект также содержит метод для уведомления всех наблюдателей о любых изменениях, и либо он может отправить обновление, уведомляя наблюдателя, либо может предоставить другой метод для получения обновления. У наблюдателя должен быть метод для установки объекта для наблюдения и другой метод, который будет использоваться субъектом для уведомления о любых обновлениях. Java предоставляет встроенную платформу для реализации шаблона Observer через класс java.util.Observable и интерфейс java.util.Observer. Однако он широко не используется, потому что реализация очень проста, и в большинстве случаев мы не хотим в конечном итоге расширять класс только для реализации шаблона Observer, поскольку Java не обеспечивает множественное наследование в классах. Служба сообщений Java (JMS) использует шаблон проектирования Observer вместе с шаблоном Mediator, чтобы позволить приложениям подписываться и публиковать данные в других приложениях. Фреймворки Модель-Представление-Контроллер (MVC) также используют шаблон Наблюдатель, где Модель — это Субъект, а Представления — это наблюдатели, которые могут регистрироваться для получения уведомлений о любых изменениях в модели.
Пример шаблона наблюдателя на Java
Для нашего примера Java-программы шаблона наблюдателя мы реализуем простую тему, и наблюдатели могут зарегистрироваться в этой теме. Всякий раз, когда какое-либо новое сообщение будет опубликовано в теме, все наблюдатели за регистрами будут уведомлены, и они смогут использовать это сообщение. Основываясь на требованиях субъекта, вот базовый интерфейс субъекта, который определяет методы контракта, которые должны быть реализованы любым конкретным субъектом.
package com.journaldev.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.journaldev.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.journaldev.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();
}
}
Реализация метода для регистрации и отмены регистрации наблюдателя очень проста. Дополнительным методом является postMessage(), который будет использоваться клиентским приложением для отправки сообщения String в тему. Обратите внимание на логическую переменную, которая отслеживает изменение состояния темы и используется для уведомления наблюдателей. Эта переменная необходима для того, чтобы если обновления не было и кто-то вызывает метод 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(), где он вызывает метод Subject getUpdate(), чтобы получить сообщение для потребления. Мы могли бы избежать этого вызова, передав сообщение в качестве аргумента методу update(). Вот простая тестовая программа для реализации нашей темы.
package com.journaldev.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 Observer
- java.util.EventListener в Swing
- javax.servlet.http.HttpSessionBindingListener
- javax.servlet.http.HttpSessionAttributeListener
Это все, что касается шаблона проектирования Observer в java, надеюсь, вам понравилось. Поделитесь своей любовью с комментариями и поделившись ею с другими.