Padrão de Projeto Observer em Java

Padrão Observer é um dos padrões de design comportamental. O padrão de design Observer é útil quando você está interessado no estado de um objeto e deseja ser notificado sempre que houver alguma mudança. No padrão Observer, o objeto que observa o estado de outro objeto é chamado de Observador e o objeto que está sendo observado é chamado de Assunto.

Padrão de Design Observer

De acordo com GoF, o objetivo do padrão de design Observer é;

Definir uma dependência de um-para-muitos entre objetos para que, quando um objeto muda de estado, todos os seus dependentes sejam notificados e atualizados automaticamente.

O Assunto contém uma lista de observadores a serem notificados sobre qualquer mudança em seu estado, portanto, ele deve fornecer métodos pelos quais os observadores possam se registrar e cancelar o registro. O Assunto também contém um método para notificar todos os observadores sobre qualquer mudança e, ou ele pode enviar a atualização ao notificar o observador, ou pode fornecer outro método para obter a atualização. O Observador deve ter um método para definir o objeto a ser observado e outro método que será usado pelo Assunto para notificá-los sobre quaisquer atualizações. Java fornece uma plataforma embutida para implementar o padrão Observer através da classe java.util.Observable e da interface java.util.Observer. No entanto, não é amplamente utilizado porque a implementação é realmente simples e na maioria das vezes não queremos acabar estendendo uma classe apenas para implementar o padrão Observer, já que Java não oferece herança múltipla em classes. O Java Message Service (JMS) usa o padrão de design Observer junto com o padrão de Mediador para permitir que aplicativos se inscrevam e publiquem dados para outros aplicativos. Frameworks Model-View-Controller (MVC) também usam o padrão Observer, onde o Modelo é o Assunto e as Visualizações são observadores que podem se registrar para serem notificados sobre qualquer alteração no modelo.

Exemplo de Padrão Observer em Java

Para o nosso exemplo de programa em Java usando o padrão observador, implementaríamos um tópico simples e os observadores podem se registrar neste tópico. Sempre que qualquer nova mensagem for postada no tópico, todos os observadores registrados serão notificados e poderão consumir a mensagem. Com base nos requisitos do Assunto, aqui está a interface base Assunto que define os métodos de contrato a serem implementados por qualquer assunto concreto.

package com.journaldev.design.observer;

public interface Subject {

	//métodos para registrar e cancelar o registro de observadores
	public void register(Observer obj);
	public void unregister(Observer obj);
	
	//método para notificar observadores sobre mudança
	public void notifyObservers();
	
	//método para obter atualizações do assunto
	public Object getUpdate(Observer obj);
	
}

A seguir, criaremos contrato para Observador, haverá um método para anexar o Assunto ao observador e outro método a ser usado pelo Assunto para notificar sobre qualquer mudança.

package com.journaldev.design.observer;

public interface Observer {
	
	//método para atualizar o observador, usado pelo assunto
	public void update();
	
	//anexar com o assunto para observar
	public void setSubject(Subject sub);
}

Agora nosso contrato está pronto, vamos prosseguir com a implementação concreta do nosso tópico.

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;
		//a sincronização é usada para garantir que qualquer observador registrado após o recebimento da mensagem não seja notificado
		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;
	}
	
	//método para postar mensagem no tópico
	public void postMessage(String msg){
		System.out.println("Message Posted to Topic:"+msg);
		this.message=msg;
		this.changed=true;
		notifyObservers();
	}

}

A implementação do método para registrar e cancelar um observador é muito simples, o método adicional é postMessage() que será usado pela aplicação cliente para enviar uma mensagem de String para o tópico. Observe a variável booleana para acompanhar a mudança no estado do tópico e usada na notificação dos observadores. Essa variável é necessária para que, se não houver atualização e alguém chamar o método notifyObservers(), ele não envie notificações falsas para os observadores. Também observe o uso da sincronização no método notifyObservers() para garantir que a notificação seja enviada apenas aos observadores registrados antes que a mensagem seja publicada para o tópico. Aqui está a implementação dos Observadores que vão observar o assunto.

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;
	}

}

Observe a implementação do método update() onde está chamando o método getUpdate() do Subject para obter a mensagem a ser consumida. Poderíamos ter evitado essa chamada passando a mensagem como argumento para o método update(). Aqui está um programa de teste simples para consumir nossa implementação de tópico.

package com.journaldev.design.observer;

public class ObserverPatternTest {

	public static void main(String[] args) {
		//criar subject
		MyTopic topic = new MyTopic();
		
		//criar observadores
		Observer obj1 = new MyTopicSubscriber("Obj1");
		Observer obj2 = new MyTopicSubscriber("Obj2");
		Observer obj3 = new MyTopicSubscriber("Obj3");
		
		//registrar observadores no subject
		topic.register(obj1);
		topic.register(obj2);
		topic.register(obj3);
		
		//anexar observador ao subject
		obj1.setSubject(topic);
		obj2.setSubject(topic);
		obj3.setSubject(topic);
		
		//verificar se há alguma atualização disponível
		obj1.update();
		
		//agora enviar mensagem para o subject
		topic.postMessage("New Message");
	}

}

Ao executarmos o programa acima, obtemos a seguinte saída.

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

Diagrama de Classe do Padrão Observer em Java

O padrão de design Observer também é chamado de padrão publish-subscribe. Algumas de suas implementações são;

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

Isso é tudo para o padrão de design Observer em Java, espero que você tenha gostado. Compartilhe seu amor com comentários e compartilhando com outras pessoas.

Source:
https://www.digitalocean.com/community/tutorials/observer-design-pattern-in-java