Prévia Markdown
Guia de Referência: Proxy (Estrutural)
Visualização renderizada do arquivo padroes/estruturais/proxy.md. O conteúdo abaixo é o mesmo arquivo destinado a orientar a IA.
Guia de Referência: Proxy (Estrutural)
Este guia orienta a aplicação do padrão Proxy em projetos de software. Objetivo: Interpor um substituto com o mesmo contrato para controlar o acesso a um objeto real. O padrão deve ser usado somente quando as forças do problema o justificarem.
1. Problema que resolve
Você precisa executar algo antes/depois do acesso: lazy loading, autorização, comunicação remota, cache, rate limit ou auditoria.
Sinais no código/arquitetura
- O objeto real é caro de criar.
- O acesso precisa ser autorizado/registrado.
- O recurso é remoto e deve parecer local ao cliente.
2. Quando usar
- Virtual proxy/lazy loading.
- Protection proxy/autorização.
- Remote proxy.
- Caching/rate limiting quando o contrato é o mesmo.
3. Quando NÃO usar
- Quando middleware/decorator é mais explícito para a preocupação.
- Quando o proxy mascara latência de rede e induz o cliente a tratar operação remota como barata.
4. Estrutura e participantes
- Subject: contrato.
- RealSubject: implementação real.
- Proxy: implementa o mesmo contrato e controla a delegação.
- Client: usa Subject.
5. Procedimento de implementação
- Defina contrato comum.
- Encapsule a referência/criação do real subject.
- Adicione a política de acesso no proxy.
- Preserve semântica do contrato.
- Torne latência/erros observáveis quando remoto.
6. Exemplo mental
SecureDocumentStore implementa DocumentStore, valida permissões e só então delega ao S3DocumentStore.
7. Benefícios esperados
- Controle de acesso sem alterar o objeto real.
- Pode adiar custos ou encapsular acesso remoto.
8. Custos e trade-offs
- Adiciona indireção e pode esconder custos/erros.
- Pode ser confundido com Decorator.
9. Encaixe com Clean Architecture e SOLID
Proxy externo pertence a adapters/infra. Casos de uso conhecem apenas o contrato; política de autorização de negócio, porém, deve continuar explícita no núcleo quando for regra de domínio.
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 cada cliente repete autorização/cache/lazy logic antes de chamar o mesmo serviço.
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 política do proxy, delegação, falhas e que o real subject não seja acionado quando o acesso é negado.
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
- Decorator
- Adapter
- Facade
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 **Proxy** é 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 Proxy.
2. Compare pelo menos uma alternativa mais simples e um padrão relacionado (Decorator, Adapter, Facade).
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: Objeto remoto é caro para carregar e exige controle de acesso e cache.
Objetivo: Controlar acesso ao objeto mantendo a mesma interface do serviço real.
Restrições: Proxy não deve esconder falhas importantes; políticas de cache/autorização precisam ser explícitas.
15. Critério de aceite
A aplicação de Proxy 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.