Boas práticas em GO: como organizar códigos e projetos em Go

Solução: Use nomes diferentes para variáveis em blocos internos.

Código aninhado em excesso

Muitos níveis de if/else dificultam a leitura e compreensão do código.

Solução: Simplifique as condições, retorne antecipadamente, quando possível, e alinhe o caminho principal (o código que executa na maioria das vezes) à esquerda, como no exemplo abaixo:

Mau uso de funções init

Funções init são executadas automaticamente ao iniciar um pacote. Evite usá-las para tarefas complexas ou que possam falhar, pois o tratamento de erros é limitado.

Solução: Prefira funções normais para inicializações.

Excesso de getters e setters

Em Go, não é idiomático usar getters e setters para todos os campos de uma struct, como no exemplo abaixo:

Solução: Acesse os campos diretamente, a menos que haja uma lógica específica para encapsular.

Poluição de interfaces

Criar interfaces desnecessárias torna o código mais complexo. Interfaces devem ser descobertas conforme a necessidade, e não criadas antecipadamente.

Solução: Prefira interfaces pequenas e com propósito claro.

Interfaces no lado do produtor

Quando a interface é definida no pacote produtor, qualquer mudança na interface pode exigir alterações em todos os pacotes que a utilizam. Isso cria um acoplamento desnecessário entre o produtor e os consumidores.

Solução: Defina interfaces no pacote que as utiliza (consumidor), não no pacote que implementa os tipos concretos (produtor). Isso dá mais flexibilidade ao consumidor.

any não diz nada

Em Go, any é um alias para interface{} e representa qualquer tipo.

Ele foi introduzido no Go 1.18 para tornar o código mais legível e intuitivo, substituindo o uso explícito de interface{} para indicar valores de qualquer tipo.

Entretanto, any pode receber qualquer tipo, mas isso torna o código menos expressivo.

Solução: Use tipos concretos sempre que possível.

Genéricos

Genéricos permitem escrever código que funciona com diferentes tipos. Use-os com cautela, apenas quando necessário para evitar repetição de código com tipos diferentes.

Solução: Não use genéricos quando tornar o código mais complexo.

Desorganização do projeto

Organize o projeto em pacotes com nomes claros e concisos.

Evite pacotes muito pequenos ou muito grandes. Separe código público de código privado.

Ignorar colisões de nomes de pacotes

Evite nomes de variáveis que colidam com nomes de pacotes.

Solução: Use nomes diferentes ou aliases para pacotes.

Não usar linters

Linters são ferramentas que analisam o código em busca de erros e problemas de estilo.

Solução: Use linters para garantir a qualidade do código.

Conclusão

Escreva código Go simples, claro e bem organizado. Evite abstrações desnecessárias e use as ferramentas disponíveis para garantir a qualidade do código.

Lembre-se que a consistência é fundamental para facilitar a manutenção do projeto.

Quer aprofundar ainda nessa linguagem? Aprenda a programar em Go com boas práticas na Alura! Conheça as formações Linguagem Go e Aprenda a programar em Go.