Prévia Markdown
Guia de Referência: Memento (Comportamental)
Visualização renderizada do arquivo padroes/comportamentais/memento.md. O conteúdo abaixo é o mesmo arquivo destinado a orientar a IA.
Guia de Referência: Memento (Comportamental)
Este guia orienta a aplicação do padrão Memento em projetos de software. Objetivo: Capturar e restaurar um snapshot de estado sem expor os detalhes internos do objeto originador. O padrão deve ser usado somente quando as forças do problema o justificarem.
1. Problema que resolve
Você precisa de undo/rollback/checkpoint, mas não quer quebrar encapsulamento expondo campos internos.
Sinais no código/arquitetura
- Undo/redo solicitado.
- Operação arriscada precisa de checkpoint.
- Estado interno é complexo e não deve ser manipulado por terceiros.
2. Quando usar
- Editores.
- Transações locais/assistentes passo a passo.
- Snapshots de configuração/estado de simulação.
3. Quando NÃO usar
- Quando o estado é enorme e snapshots frequentes são caros.
- Quando Event Sourcing ou comandos compensatórios representam melhor a necessidade.
4. Estrutura e participantes
- Originator: cria/restaura snapshots.
- Memento: guarda estado capturado, opaco para o caretaker.
- Caretaker: armazena histórico sem inspecionar o conteúdo.
5. Procedimento de implementação
- Defina exatamente o estado restaurável.
- Mantenha Memento opaco ao caretaker.
- Capture cópias seguras de estado mutável.
- Defina política de retenção/limite.
- Proteja dados sensíveis presentes no snapshot.
6. Exemplo mental
Um editor chama document.createSnapshot() antes de uma transformação; History guarda o memento e pode pedir restore(snapshot).
7. Benefícios esperados
- Preserva encapsulamento.
- Simplifica undo/checkpoint.
8. Custos e trade-offs
- Consumo de memória.
- Cópias podem ser caras ou conter dados sensíveis.
9. Encaixe com Clean Architecture e SOLID
Mementos de domínio devem representar estado legítimo, sem incluir handles/objetos de infraestrutura. Para persistência durável, use DTO/versionamento apropriado.
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
Útil quando código de undo acessa campos internos diretamente ou mantém cópias ad hoc espalhadas.
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 round-trip snapshot/restore, independência do snapshot e política de histórico.
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
- Command
- Prototype
- State
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 **Memento** é 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 Memento.
2. Compare pelo menos uma alternativa mais simples e um padrão relacionado (Command, Prototype, State).
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: Editor precisa permitir desfazer alterações sem expor campos internos do documento.
Objetivo: Capturar e restaurar snapshots de estado respeitando encapsulamento.
Restrições: Controlar custo de memória e ciclo de vida; não armazenar segredos desnecessariamente.
15. Critério de aceite
A aplicação de Memento 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.