O Padrão Observer e Swing

O padr�o Observer, um dos mais usados no JDK, � respons�vel por manter a depend�ncia um-para-muitos entre objetos distintos, que ser�o notificados da mudan�a de estado do objeto observado.

Na maioria dos exemplos encontrados na web, o padr�o Observer raramente � encontrado aplicado juntamente com componentes Swing.

O objetivo deste artigo � demonstrar uma aplica��o, do padr�o Observer, em uma interface gr�fica utilizando os componentes do pacote javax.swing. Para que a notifica��o de objetos seja expl�cita, utilizar-se-� uma situa��o que ser� descrita nos pr�ximos par�grafos.

Partindo de uma situa��o

Os taxistas de uma determinada regi�o resolveram informatizar o sistema de chamadas via telefone da seguinte maneira: a telefonista recebe um pedido de taxi e digita os dados do cliente na central. Ao enviar o pedido, todos os taxis (munidos de um computador) receber�o uma notifica��o com os dados.

Como citada no in�cio do artigo, o padr�o Observer mant�m uma depend�ncia um-para-muitos entre objetos. Na situa��o descrita n�o � muito dif�cil imaginar quem � o �um� e quem s�o os �muitos�.

Ao ter-se a Central como objeto �nico e respons�vel por notificar os taxis de que h� um novo cliente dispon�vel, ele ser� o observado. Os taxis ser�o, ent�o, os observadores. A Figura 1 fornece uma visualiza��o para o caso.

**Figura 1** � rela��o um-para-muitos entre central e os taxis

A partir de agora, ao inv�s de consider�-los observada e observadores, eles ser�o chamados de Subject e Observers, respectivamente.

Modelando a estrutura Observer

H� diversas maneiras de se implementar o padr�o Observer. Neste artigo ir� se criar duas interfaces (que ser�o implementadas pelos objetos concretos): Subject e Observer.

Antes de mais nada, ser� criada a classe Cliente, como na Listagem 01.


package cliente;

private String nome;      
private String rua;       
private int numero;       
private String bairro;    
private String complemento;        
private String destino;

public Cliente(String nome, String rua, int numero, 
String bairro, String complemento, String destino){
      this.nome = nome;
      this.rua = rua;
      this.numero = numero;
      this.bairro = bairro;
      this.complemento = complemento;
      this.destino = destino;
}
      
public Cliente(){}
      
//m�todos de acesso...

public String getEndereco(){
      return rua + ", " + numero + " - " + bairro + " " + complemento;
}

Listagem 01 � Classe Cliente

Agora ser�o criadas as interfaces que ao serem implementadas pelas classes concretas ir�o definir o padr�o Observer na aplica��o.


package patternobserver;

import cliente.Cliente;

public interface Subject {
            public void addObserver(Observer o);
     public void removeObserver(Observer o);
     public void notifyObservers(Cliente corrida);
}

Listagem 02 � Interface Subject (Observada)


package patternobserver;
  
 import cliente.Cliente;
  
 public interface Observer {
         public void update(Cliente corrida);
 }

Listagem 03 � Interface Observer (Observadores)

Uma classe que implemente Subject (Listagem 02), deve fornecer implementa��es para addObserver que adiciona um observador � lista de observadores, removeObservers que remove um observador da lista e notifyObservers que � respons�vel por notificar um ou mais observadores.

Esse �ltimo m�todo ir� receber um Cliente e envi�-lo aos observadores desejados que ir�o interpret�-lo cada um � sua maneira.

As classes que implementam Observer dever�o apenas implementar update que recebe um Cliente (de notifyObservers) e interpreta-o da maneira como desejar, seja exibindo-o, descartando-o, etc. O importante � notar um princ�pio b�sico de design que � sempre procurar uma fraca liga��o entre os objetos que interagem no mesmo. Logo, � poss�vel perceber que a classe concreta que implementa Subject n�o precisam saber o que os observadores ir�o fazer com o Cliente. Apenas os notificam.

Com as interfaces criadas falta apenas criar as classes concretas; isto �, a Central que implementar� Subject e a classe Taxi que implementar� Observer.

Criando as classes concretas

A Listagem 04 representa a classe CentralComponent (Subject � observada). Como o objetivo principal do artigo � demonstrar o padr�o em uma aplica��o Swing, essa classe foi criada j� pronta para ser exibida em um internal frame.

N�o � recomend�vel dar mais de uma funcionalidade a uma classe � neste caso, a de exibir um formul�rio e comunicar os observadores � por�m, isto foi feito para manter a clareza e resumir o m�ximo poss�vel a quantidade de c�digo e poder focar o padr�o.


package components;

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.util.ArrayList;
import java.util.Iterator;

import javax.swing.JInternalFrame;
import javax.swing.JPanel;

import org.swingBean.actions.ActionChainFactory;
import org.swingBean.actions.ApplicationAction;
import org.swingBean.actions.ValidationAction;
import org.swingBean.descriptor.GenericFieldDescriptor;
import org.swingBean.descriptor.XMLDescriptorFactory;
import org.swingBean.gui.JActButton;
import org.swingBean.gui.JBeanPanel;

import cliente.Cliente;

import patternobserver.Observer;
import patternobserver.Subject;

public class CentralComponent extends JInternalFrame implements Subject{
     private ArrayList observers = new ArrayList();
     
     public CentralComponent(){
            super("Central *Subject*");
            initComponents();
     }
     
     public void initComponents(){
            GenericFieldDescriptor descriptor = XMLDescriptorFactory
            .getFieldDescriptor(Cliente.class, "/ClienteForm.xml", "ClienteForm");
            final JBeanPanel panel = new JBeanPanel(Cliente.class, 
            "Nova Solicita��o:", descriptor);
            panel.setPreferredSize(new Dimension(300,180));
            
            ApplicationAction validationActions = ActionChainFactory.createChainActions(
                new ValidationAction(panel), new ApplicationAction(){
                    public void execute() {
                           Cliente cliente = new Cliente();
                           panel.populateBean(cliente);
                           notifyObservers(cliente);
                    }
                });
            JActButton btnEnviar = new JActButton("Solicitar>>>", validationActions); 
            
            JActButton btnLimpar = new JActButton("Limpar", new ApplicationAction(){
                    public void execute() {
                            panel.cleanForm();
                    }
            });
            
            JPanel panelButtons = new JPanel();
            panelButtons.add(btnLimpar);
            panelButtons.add(btnEnviar);
                            
            super.setDefaultCloseOperation(JInternalFrame.DISPOSE_ON_CLOSE);
            super.setLayout(new BorderLayout());
            super.add(panel, BorderLayout.NORTH);
            super.add(panelButtons, BorderLayout.SOUTH);
            super.pack();
            super.setVisible(true);
     }

     public void addObserver(Observer o) {
            observers.add(o);
     }

     public void removeObserver(Observer o) {
            observers.remove(o);
     }

     public void notifyObservers(Cliente corrida) {
            Iterator it = observers.iterator();
            while(it.hasNext()){
                    Observer observer = it.next();
                    observer.update(corrida);
            }
     }
}

Listagem 04 � classe CentralComponent

Para montagem do formul�rio de preenchimento dos dados do Cliente foi utilizado o framework SwingBean dispon�vel em http://swingbean.sourceforge.net/. O m�todo initComponents faz a montagem do mesmo, criando o painel atrav�s de um arquivo XML, como indica a Listagem 05.


<beanDescriptor>
    <line>
           <property name='nome' label='Nome:' mandatory='true'/>
    </line>
    <line>
           <property name='rua' label='Rua:' colspan='4' mandatory='true'/>
           <property name='numero' label='N�:' colspan='1' mandatory='true'/>
    </line>
    <line>
            <property name='bairro' label='Bairro:' mandatory='true'/>
           <property name='complemento' label='Complemento:' mandatory='true'/>
    </line>
    <line>
           <property name='destino' label='Destino:' mandatory='true'/>
    </line>
</beanDescriptor>

Listagem 05 � ClienteForm.xml

Os m�todos addObserver, removeObserver e notifyObservers de CentralComponent foram implementados de Subject. Os dois primeiros realizam as a��es de adi��o e remo��o de observadores do ArrayList observers, declarado no in�cio da Listagem 04. Os observadores, neste caso, s�o as classes que implementam Observer.

Ainda na Listagem 04, h� a cria��o de um evento chamado de validationActions ( evento do bot�o btnEnviar) que cria uma inst�ncia vazia de Cliente e em seguida chama o m�todo populateBean para setar as informa��es preenchidas nos atributos de cliente. Se houver algum dado obrigat�rio n�o preenchido, o pr�prio framework se encarrega de exibir uma mensagem de alerta para o usu�rio. Com o cliente corretamente preenchido, o evento finalmente chama notifyObservers, e � a� que todas classes que implementam Observer ser�o notificadas.

Com a CentralComponent j� pronta, parte-se para a cria��o da classe TaxiComponent, que ser�o os taxis observadores (implementam Observer).


package components;

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.FlowLayout;

import javax.swing.BorderFactory;
import javax.swing.JInternalFrame;
import javax.swing.JPanel;

import cliente.Cliente;

import patternobserver.Observer;

public class TaxiComponent extends JInternalFrame implements Observer{
     private ClienteComponent clienteComponent;
     
     private JPanel panelCliente;
     
     private static int codigo = 1;
     
     public TaxiComponent(){
            super("Taxi *Observer* - #000" + codigo++, true);
            this.clienteComponent = new ClienteComponent(null);
     }
     
     public void initComponents(){
            this.panelCliente = new JPanel(new BorderLayout());
            panelCliente.setBorder(BorderFactory.createTitledBorder(null, "Cliente:"));
            panelCliente.add(clienteComponent, BorderLayout.WEST);
            panelCliente.setPreferredSize(new Dimension(250,100));
            super.setDefaultCloseOperation(JInternalFrame.DISPOSE_ON_CLOSE);
            super.setLayout(new FlowLayout());
            super.setLocation(320, 0);
            super.add(panelCliente);
            super.pack();
            super.setVisible(true);
     }
     
     private void atualizaCliente(Cliente cliente){
            clienteComponent.setCorrida(cliente);
     }

     public void update(Cliente cliente) {
            atualizaCliente(cliente);             
     }       
}

Listagem 06 � classe TaxiComponent

No in�cio do c�digo � declarada uma inst�ncia de ClienteComponent. A Listagem 07 demonstra a cria��o desta classe que � apenas um painel onde s�o exibidos os dados do cliente.


package components;

import java.awt.Color;

import javax.swing.BorderFactory;
import javax.swing.JLabel;
import javax.swing.JPanel;

import cliente.Cliente;

import com.jgoodies.forms.layout.CellConstraints;
import com.jgoodies.forms.layout.FormLayout;

public class ClienteComponent extends JPanel{
     
     private JLabel lNome;
     private JLabel lEndereco;
     private JLabel lDestino;
     
     public ClienteComponent(Cliente cliente){
            lNome = createJLabel("");
            lEndereco = createJLabel("");
            lDestino = createJLabel("");
            if(cliente != null){
                    this.setCliente(cliente);
            }
            this.initComponents();
     }
     
     private void initComponents(){
            CellConstraints cc = new CellConstraints();
            FormLayout layout = new FormLayout("3dlu, pref, 3dlu, 
            pref, 3dlu","3dlu, pref, 3dlu, pref, 3dlu, pref, 3dlu");
            super.setLayout(layout);
            super.add(createJLabel("Nome:"), cc.xy(2, 2));
            super.add(createJLabel("Endere�o:"), cc.xy(2, 4));
            super.add(createJLabel("Destino:"), cc.xy(2, 6));
            super.add(lNome, cc.xy(4, 2));
            super.add(lEndereco, cc.xy(4, 4));
            super.add(lDestino, cc.xy(4, 6));
     }
     
     public void setCliente(Cliente cliente){
            this.lNome.setText(cliente.getNome());
            this.lEndereco.setText(cliente.getEndereco());
            this.lDestino.setText(cliente.getDestino());
     }
     
     private JLabel createJLabel(String text){
            JLabel jLabel = new JLabel(text);
            jLabel.setBackground(Color.WHITE);
            jLabel.setBorder(BorderFactory.createLineBorder(Color.BLUE, 1));
            jLabel.setOpaque(true);
            return jLabel;
     }
}

Listagem 07 � classe ClienteComponent

Para configura��o da interface gr�fica de ClienteComponent, foi utilizada a biblioteca forms-1.0.7 de JGoodies (http://www.jgoodies.com/). O m�todo initComponents faz uso ent�o da biblioteca citada pra posicionar os labels que exibem os dados. O m�todo setCliente atualiza os dados exibidos.

ClienteComponent tem apenas a fun��o de, ao receber um Cliente, exibir os dados em um Painel. Enquanto isso, seu m�todo setCliente atualiza os dados de acordo com o novo Cliente enviado.

Com as classes CentralComponent, TaxiComponent e ClienteComponent, � poss�vel analisar a rotina do padr�o observer na aplica��o:

o respons�vel por receber a liga��o de um Cliente preenche os dados no formul�rio de CentralComponent;
ao clicar no bot�o �Solicitar�, os dados preenchidos ir�o montar um objeto de Cliente que, em seguida, ser� enviado atrav�s do m�todo notifyObservers aos observadores cadastrados;
Nota: Repare que para cada inst�ncia criada de TaxiComponent ou de alguma classe que implemente Observer, dever� haver uma chamada em addObserver para que a mesma esteja cadastrada na lista de observadores e ser notificada junto com as outras.
Todos os observadores cadastrados receberam a inst�ncia de Cliente enviada pela classe observada e cada um agora executa as opera��es que forem necess�rias com o mesmo. No exemplo atual, os computadores de cada taxi ir�o apenas notificar o taxista da nova chamada.

Para exemplificar o processo, nos pr�ximos par�grafos, ser� criada uma mini-aplica��o onde � poss�vel visualizar a CentralComponent e os TaxiComponent cadastrados atualizando suas exibi��es a cada nova chamada de Cliente.

Aplica��o de exemplo

A Listagem 08 representa o c�digo-fonte completo da aplica��o.


package gui;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JDesktopPane;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.UIManager;

import components.CentralComponent;
import components.TaxiComponent;

public class GUI extends JFrame{
     private JDesktopPane desktop = new JDesktopPane();
     
     private CentralComponent central;
     
     public GUI(){
            super("Sistema de Ger�ncia de Taxis");
     }
     
     public void initComponents(){
            this.central = new CentralComponent();
            desktop.add(central);
            
            super.setJMenuBar(montaMenu());
            super.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
            super.setExtendedState(JFrame.MAXIMIZED_BOTH);
            super.add(desktop);
            super.setVisible(true);
     }
     
     private JMenuBar montaMenu(){
            JMenuBar menuBar = new JMenuBar();
            JMenu mnuObservers = new JMenu("Observers");
            JMenuItem mniAdicionar = new JMenuItem("Adicionar");
            mniAdicionar.addActionListener(new ActionListener(){
                    public void actionPerformed(ActionEvent e){
                            adicionaTaxi();
                    }
            });
            mnuObservers.add(mniAdicionar);
            menuBar.add(mnuObservers);
     
            return menuBar;
     }
     
     private void adicionaTaxi(){
            TaxiComponent taxi = new TaxiComponent();
            taxi.initComponents();
            desktop.add(taxi);
            central.addObserver(taxi);
     }

public static void main(String args[]){
             try{    
               UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
            } catch(Exception e){}
            
            GUI gui = new GUI();
            gui.initComponents();
     }
}

Listagem 08 � classe GUI

A classe GUI extende JFrame (javax.swing), e inicialmente declara uma inst�ncia de JDesktopPane, do mesmo pacote, e uma CentralComponent. A JDesktopPane criada tem a fun��o de exibir um painel onde ser�o exibidos a CentralComponent e os TaxiComponent de maneira que se possa posicion�-los da maneira como o usu�rio quiser, facilitando a visualiza��o das chamadas.

Em initComponents, a central � adicionada e exibida, assim como a interface gr�fica geral. Ainda dentro desse m�todo, h� uma chamada para montaMenu que ir� retornar um JMenuBar contendo apenas um item que � o de adicionar taxis.

O m�todo adicionaTaxi � chamado pelo �nico item de menu da GUI apresentada, e cria um novo componente visual de taxi (TaxiComponent), inicia sua interface gr�fica (initComponents), adiciona o taxi no desktop que � o componente onde ser�o visualizados pelo usu�rio e em seguida chama addObserver da central que cadastra o novo Taxi na lista de observadores.

**Figura 2** � interface gr�fica do Sistema de Ger�ncia de Taxis

Ap�s criar alguns taxis e posicion�-los na tela, como indica a Figura 2, o usu�rio j� pode realizar as solicita��es de taxi atrav�s da Central e ao clicar em �Solicitar�, cada um dos Taxis criados ir� exibir as informa��es preenchidas. Isso acontece porque todos eles est�o cadastrados na lista de observadores (contida na Central).

Na aplica��o n�o foi tratada a a��o de remover um taxi, mas pode ser facilmente tratada, pois a interface Subject j� fez com que CentralComponent implementasse essa a��o.

Conclus�o

No artigo foram usadas interfaces criadas para a aplica��o do Sistema de Ger�ncia de Taxis para facilitar a compreens�o do padr�o. Por�m o Java j� fornece em suas API classes que suportam o padr�o Observer, como as classes Observable e Observer, ambas de java.util, e possuem mais recursos.

Uma das vantagens mais expl�citas do padr�o � o fato das liga��es entre observador e observ�vel serem fracas, o que � um bom princ�pio de design.

Em determinadas situa��es n�o h� necessidade de utilizar os muitos recursos das classes que tratam o padr�o Observer na API do Java. Na aplica��o dos taxis, por exemplo, apenas os m�todos addObserver e notifyObservers foi utilizado para os observados e update para os observadores. J� outras aplica��es mais robustas podem requerer m�todos adicionais que encapsulam as notifica��es para restringi-las a determinados observadores, por exemplo.

Tecnologias:

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Assista grátis a nossa aula inaugural

Perguntas frequentes

Quem somos?

Por que a programação se tornou a profissão mais promissora da atualidade?

Como faço para começar a estudar?

Em quanto tempo de estudo vou me tornar um programador?

Sim, você pode se tornar um programador e não precisa ter diploma de curso superior!

O que eu irei aprender estudando pela DevMedia?

Principais diferenciais da DevMedia

Qual o investimento financeiro que preciso fazer para me tornar um programador?

Como funciona a forma de pagamento da DevMedia?

Por Adriano Em 2007

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

O Padr�o Observer e Swing

O padr�o Observer, um dos mais usados no JDK, � respons�vel por manter a depend�ncia um-para-muitos entre objetos distintos...