Prévia Markdown
Guia de Referência: Builder (Criacional)
Visualização renderizada do arquivo padroes/criacionais/builder.md. O conteúdo abaixo é o mesmo arquivo destinado a orientar a IA.
Guia de Referência: Builder (Criacional)
Este guia orienta a aplicação do padrão Builder em projetos de software. Objetivo: Construir objetos complexos em etapas claras, separando o processo de construção da representação final. O padrão deve ser usado somente quando as forças do problema o justificarem.
1. Problema que resolve
Construtores enormes, parâmetros opcionais, combinações inválidas e montagem complexa tornam a criação difícil de ler e manter.
Sinais no código/arquitetura
- Construtor telescópico com muitos parâmetros.
- Muitos parâmetros booleanos/opcionais.
- O objeto exige etapas de montagem, validação ou ordenação.
2. Quando usar
- Requests/DTOs complexos, relatórios, documentos, consultas e configurações.
- Objetos de teste com muitas combinações.
- Montagem de estruturas em etapas com representações finais diferentes.
3. Quando NÃO usar
- Para objetos simples com poucos argumentos obrigatórios.
- Quando setters simples e validação no construtor já deixam a criação clara.
- Se o builder permitir estados inválidos por tempo demais sem benefício.
4. Estrutura e participantes
- Builder: API de construção passo a passo.
- ConcreteBuilder: acumula estado e gera o produto.
- Product: objeto final.
- Director (opcional): encapsula receitas de construção reutilizáveis.
5. Procedimento de implementação
- Separe atributos obrigatórios de opcionais.
- Crie métodos de construção com nomes do domínio.
- Evite expor um produto parcialmente válido.
- Centralize validação no
build()ou no próprio produto. - Crie Directors apenas para receitas realmente reutilizadas.
6. Exemplo mental
ReportBuilder().forPeriod(period).withColumns(cols).withSummary().build() cria um relatório válido sem um construtor de 12 argumentos.
7. Benefícios esperados
- Código de criação legível e autoexplicativo.
- Evita construtores telescópicos.
- Permite receitas e variações.
8. Custos e trade-offs
- Mais classes/objetos auxiliares.
- Pode esconder regras se o builder virar um depósito de setters.
9. Encaixe com Clean Architecture e SOLID
Builders de entidades devem respeitar invariantes do domínio; builders de infraestrutura/DTOs ficam nas bordas. Para testes, um Test Data Builder é especialmente útil.
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 ao detectar long parameter list, criação repetitiva ou objetos montados em várias linhas inconsistentes.
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 combinações válidas, campos obrigatórios, defaults e rejeição de estados inválidos.
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
- Factory Method
- Composite
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 **Builder** é 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 Builder.
2. Compare pelo menos uma alternativa mais simples e um padrão relacionado (Abstract Factory, Factory Method, Composite).
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: Relatório possui muitas seções opcionais e combinações de configuração.
Objetivo: Construir relatórios complexos passo a passo com presets distintos.
Restrições: Objeto final deve ser válido; evitar builder se um construtor simples é suficiente.
15. Critério de aceite
A aplicação de Builder 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.