Prévia Markdown
Guia de Referência: Singleton (Criacional)
Visualização renderizada do arquivo padroes/criacionais/singleton.md. O conteúdo abaixo é o mesmo arquivo destinado a orientar a IA.
Guia de Referência: Singleton (Criacional)
Este guia orienta a aplicação do padrão Singleton em projetos de software. Objetivo: Garantir uma única instância acessível de uma classe durante um escopo definido. O padrão deve ser usado somente quando as forças do problema o justificarem.
1. Problema que resolve
Há um recurso que deve ser coordenado por uma instância única, e o sistema precisa controlar sua criação e acesso.
Sinais no código/arquitetura
- Existe uma invariável real de unicidade.
- Criar duas instâncias causa conflito de recurso.
- O ciclo de vida precisa ser centralmente controlado.
2. Quando usar
- Casos raros de coordenação de recurso único no processo.
- Caches/configurações somente quando o escopo de unicidade é requisito real.
- Como implementação encapsulada por um container de DI, preferindo escopo singleton do container.
3. Quando NÃO usar
- Para conveniência de acesso global.
- Para serviços de negócio que podem ser injetados.
- Quando testes precisam substituir a instância e o padrão cria estado global oculto.
4. Estrutura e participantes
- Singleton: controla construção e fornece acesso à instância única.
- Client: consome a instância, idealmente por abstração/injeção.
5. Procedimento de implementação
- Prove a necessidade de unicidade.
- Prefira gerenciar o ciclo de vida no container/composition root.
- Se implementar diretamente, trate concorrência e inicialização.
- Evite estado mutável global.
- Ofereça uma abstração que permita testes.
6. Exemplo mental
Um ProcessLockManager precisa ser único no processo; ainda assim, classes de negócio recebem ILockManager por injeção em vez de chamar getInstance().
7. Benefícios esperados
- Controla uma instância única.
- Pode centralizar ciclo de vida de recurso.
8. Custos e trade-offs
- Acoplamento global, dependências ocultas e testes difíceis.
- Concorrência e inicialização podem complicar a implementação.
9. Encaixe com Clean Architecture e SOLID
Trate Singleton como detalhe de composição. Entidades e casos de uso não devem buscar um singleton global; dependam de interfaces.
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
Se getInstance() aparece por toda a base, considere extrair interface + injeção de dependência e restringir a unicidade ao composition root.
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 concorrência se houver lazy initialization; teste consumidores substituindo a abstração por fake.
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
- Abstract Factory
- Facade
- Dependency Injection
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 **Singleton** é 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 Singleton.
2. Compare pelo menos uma alternativa mais simples e um padrão relacionado (Abstract Factory, Facade, Dependency Injection).
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: Aplicação usa uma instância global de configuração acessada por muitos módulos.
Objetivo: Avaliar se Singleton é justificável ou se injeção de dependência oferece acoplamento menor.
Restrições: Evitar estado global oculto; garantir testabilidade; rejeitar o padrão se não houver necessidade de instância única.
15. Critério de aceite
A aplicação de Singleton 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.