Prévia Markdown
Guia de Referência: Observer (Comportamental)
Visualização renderizada do arquivo padroes/comportamentais/observer.md. O conteúdo abaixo é o mesmo arquivo destinado a orientar a IA.
Guia de Referência: Observer (Comportamental)
Este guia orienta a aplicação do padrão Observer em projetos de software. Objetivo: Notificar múltiplos assinantes quando um objeto/evento muda, sem acoplar o emissor aos consumidores concretos. O padrão deve ser usado somente quando as forças do problema o justificarem.
1. Problema que resolve
Uma mudança deve desencadear diversas reações, cujo conjunto pode variar durante a execução.
Sinais no código/arquitetura
- O emissor chama diretamente vários serviços após um evento.
- Novos efeitos colaterais exigem editar a classe central.
- Listeners/subscribers precisam ser registrados/removidos.
2. Quando usar
- Eventos de domínio.
- UI reativa.
- Notificações internas e integrações assíncronas.
3. Quando NÃO usar
- Quando a consistência transacional exige sequência explícita e síncrona.
- Quando cascatas de eventos tornam o fluxo invisível.
- Quando um único consumidor fixo torna o padrão desnecessário.
4. Estrutura e participantes
- Subject/Publisher: gerencia assinantes e emite evento.
- Observer/Subscriber: contrato de reação.
- ConcreteObserver: ação específica.
5. Procedimento de implementação
- Defina eventos significativos, preferencialmente no passado (
OrderPaid). - Publique dados mínimos necessários.
- Evite o publisher conhecer subscribers concretos.
- Defina política de erro/ordem/assincronia.
- Garanta unsubscribe/limpeza quando necessário.
6. Exemplo mental
Após OrderPaid, subscribers independentes enviam recibo, atualizam analytics e liberam expedição.
7. Benefícios esperados
- OCP para novos assinantes.
- Baixo acoplamento entre emissor e reações.
8. Custos e trade-offs
- Ordem e efeitos indiretos podem dificultar debugging.
- Erros/retries exigem política clara.
9. Encaixe com Clean Architecture e SOLID
Domain Events podem nascer no domínio; publicação/transportes concretos ficam em aplicação/infra. Não transforme toda chamada em evento sem necessidade.
Regras para a IA:
- Dependa de abstrações quando a variação justificar uma fronteira.
- Não faça o domínio importar SDKs, frameworks, banco de dados ou UI.
- Mantenha cada participante com responsabilidade coesa.
- Prefira composição quando ela reduzir acoplamento; não crie hierarquias artificiais.
- Registre a decisão arquitetural quando o padrão afetar muitos módulos.
10. Caminho de refatoração
Aplique quando uma classe central acumula chamadas pós-ação para muitos serviços independentes.
Ao refatorar um sistema existente:
- Proteja o comportamento atual com testes.
- Faça passos pequenos e reversíveis.
- Introduza primeiro a abstração/contrato.
- Migre um fluxo por vez.
- Remova código antigo apenas após equivalência comportamental comprovada.
11. Estratégia de testes
Teste emissão do evento e cada subscriber separadamente; integração deve validar ordem/entrega quando isso for requisito.
Checklist mínimo:
- caminho feliz
- entradas/estados de limite
- erros e falhas de dependências
- comportamento de cada implementação concreta
- teste de contrato quando houver múltiplas implementações
- teste de integração apenas onde a fronteira externa for relevante
12. Padrões relacionados
- Mediator
- Event Bus
- Command
13. Perguntas de diagnóstico para a IA
- Qual aspecto do sistema realmente varia?
- Essa variação já está causando duplicação, condicionais ou acoplamento?
- Uma função/composição simples resolveria com menos abstrações?
- O padrão reduz o custo de uma mudança concreta que já é provável?
- Qual é o custo de introduzir novas classes, indireção e configuração?
- Como a decisão será testada e observada em produção?
14. Prompt pronto
Você é o arquiteto do projeto. Avalie se o padrão **Observer** é adequado para o problema abaixo.
Contexto: [DESCREVA o sistema, stack/arquitetura, estado atual e o problema observado]
Objetivo: [DESCREVA o resultado esperado ao avaliar ou aplicar este padrão]
Restrições: [DESCREVA prazo, legado, performance, testes, compatibilidade e o que não pode mudar]
Antes de codificar:
1. Identifique as forças que justificam ou rejeitam Observer.
2. Compare pelo menos uma alternativa mais simples e um padrão relacionado (Mediator, Event Bus, Command).
3. Se o padrão for justificado, mostre participantes, dependências e fluxo.
4. Preserve Clean Architecture/SOLID: regras centrais não dependem de infraestrutura.
5. Implemente incrementalmente, com testes.
6. Ao final, liste trade-offs e sinais de overengineering.
Não aplique o padrão apenas porque foi solicitado; rejeite-o se não houver variação/complexidade que o justifique.
Como preencher os campos
- Contexto: descreva o tipo de sistema, stack/versões, arquitetura atual, onde a mudança acontece e o comportamento relevante já existente.
- Objetivo: descreva o resultado observável que deve existir ao final, não apenas a tecnologia que você quer usar.
- Restrições: informe o que não pode mudar, compatibilidade, prazo, segurança, acessibilidade, performance, legado, dependências e limites de escopo.
Exemplo preenchido
Contexto: Após concluir um pedido, vários módulos precisam reagir: e-mail, auditoria e atualização de painel.
Objetivo: Notificar interessados sem o pedido depender diretamente de cada consumidor.
Restrições: Evitar loops/eventos duplicados; definir síncrono/assíncrono; tratar falhas dos observadores.
15. Critério de aceite
A aplicação de Observer só está concluída quando:
- o problema que motivou o padrão está explicitamente documentado;
- o código cliente depende do contrato correto, não de detalhes acidentais;
- adicionar a variação-alvo exige menos mudanças que antes;
- testes protegem a extensão/refatoração;
- não houve vazamento de infraestrutura para o núcleo;
- a solução ficou mais compreensível para manutenção, não apenas “mais orientada a padrões”.
16. Base Conceitual e Relações
- Catálogo Refactoring.Guru em português — escopo de 22 padrões.
- Design Patterns: Elements of Reusable Object-Oriented Software (Gamma, Helm, Johnson e Vlissides) — intenção, aplicabilidade, participantes, consequências e relações entre padrões.
- Guias de Clean Architecture, princípios de design, refatoração e código limpo deste pacote.