Observer

Introdução

O padrão Observer é um padrão de projeto comportamental que permite que um objeto, chamado de "sujeito", notifique uma lista de objetos dependentes, chamados de "observadores", sobre quaisquer mudanças em seu estado. Isso permite que os observadores sejam atualizados automaticamente sempre que o estado do sujeito muda, sem que o sujeito precise conhecer os detalhes de implementação de cada observador.

O padrão Observer é útil em situações em que vários objetos precisam ser notificados sobre mudanças em um objeto central. Por exemplo, em um sistema de estoque, vários objetos, como a interface do usuário, o banco de dados e os relatórios, podem precisar ser atualizados sempre que o estoque de um produto mudar. Artefato de especificação do GoF Comportamental de padrão Observer implementado pelo subgrupo Whiskey.

Metodologia

O subgrupo Whiskey se reuniu para discutir e viualizar os diversos padrões de projeto GoFs Comportamentais, com o objetivo de apresentar um padrão GoF Comportamental, com nível de modelagem e nível de implementação que possam ser utilizados na melhoria da plataforma da Terracap. Nesta reunião, após discutir e analisar os padrões, decidimos modelar e implementar os seguintes padrões:

State
Observer

# Subject
class Subject(ABC):
    def __init__(self):
        self._observers = []

    def attach(self, observer):
        self._observers.append(observer)

    def detach(self, observer):
        self._observers.remove(observer)

    def notify(self):
        for observer in self._observers:
            observer.update()

A classe Subject possui métodos para anexar (attach), desanexar (detach) e notificar (notify) observadores. Desta forma é possível criar uma lista de elementos que serão notificados quando a classe Subject for notificada.

# Classe de conta de usuário
class Account(Subject):
    # Construtor, para criar uma conta de usuário é necessário informar seu nome, e-mail, CPF e data de nascimento
    def __init__(self, name, email, cpf, rg, birthdate):
        super().__init__()
        self._name = name
        self._email = email
        self._cpf = cpf
        self._rg = rg
        self._birthdate = birthdate
        self._address = None
        self._phone = None
        self._foreign = None

    # Getters e setters
    @property
    def email(self):
        return self._email

    @email.setter # Setter
    def email(self, value):
        self._email = value
        self.notify() # Notifica todos os observadores

    @property
    def address(self):
        return self._address

    @address.setter
    def address(self, value):
        self._address = value
        self.notify() # Notifica todos os observadores

    @property
    def phone(self):
        return self._phone

    @phone.setter
    def phone(self, value):
        self._phone = value
        self.notify() # Notifica todos os observadores

    @property
    def foreign(self):
        return self._foreign

    @foreign.setter
    def foreign(self, value):
        self._foreign = value
        self.notify() # Notifica todos os observadores

    def __str__(self):
        return f"({self._name}, {self._cpf})"

A classe Account estende Subject e adiciona alguns atributos relativos aos dados do usuário na plataforma da Terracap.
Quando o telefone, endereço ou 'foreign'(usuário estrangeiro) for alterado, a classe Account notifica todos os observadores.

# Observer
class Observer(ABC):
    @abstractmethod
    def update(self):
        pass

A classe Observer define uma interface com o método update que deve ser implementado por observadores concretos.

# Notificador de e-mail
class EmailNotifier(Observer):
    def __init__(self, account):
        self._account = account
        self._account.attach(self)

    # Método de atualização
    def update(self):
        print(f"Os dados da sua conta: {self._account} foram alterados.\n")

A classe EmailNotifier implementa a interface Observer e mantém uma referência ao Account.
No método update, ela imprime uma mensagem notificando que os dados da conta foram atualizados.

Exemplo de uso:

def main():
    # Cria uma lista de contas
    accounts = [
        Account("John Doe", "john.doe@example.com", "123.456.789-90", "1234567", datetime.date(1990, 1, 1)),
        Account("Jane Doe", "jane.doe@example.com", "123.456.789-91", "1234568", datetime.date(1991, 2, 2)),
        Account("Bob Smith", "bob.smith@example.com", "123.456.789-92", "1234569", datetime.date(1992, 3, 3))
    ]

    # Cria um notificador de e-mail para cada conta
    for account in accounts:
        EmailNotifier(account)

    # Atualiza os dados das contas
    for account in accounts:
        account.foreign = True

if __name__ == "__main__":
    main()

A saída para o seguinte código será:

Os dados da sua conta: (John Doe, 123.456.789-90) foram alterados.
Os dados da sua conta: (Jane Doe, 123.456.789-91) foram alterados.
Os dados da sua conta: (Bob Smith, 123.456.789-92) foram alterados.

Bibliografia

Jones Roberto Nuzzi, Design Patterns — Parte 2 — Os Padrões do GOF, 2019, Medium, Disponível em: <https://medium.com/design-pattern-pt/design-patterns-parte-2-os-padroes-do-gof-d7c0a0d5b5e>

PLANTUML. PlantUML. Disponível em: <https://www.plantuml.com/>. Acesso em: 23 jul. 2024.

Histórico de Versão

Versão	Data	Descrição	Autor(es)	Revisor(es)
`1.0`	23/07/2024	Descrição da metodologia utilizada	Whiskey	Papa
`1.1`	24/07/2024	Adição dos diagramas	Whiskey	Yankee
`1.2`	24/07/2024	Revisão	Foxtrot	João Lucas

Observer

Introdução

Metodologia

Padrão Observer

Modelagem

Implementação

Exemplo de uso:

Bibliografia

Histórico de Versão