Conhecer e seguir os padrões e as melhores práticas da indústria é muito importante em qualquer campo, especialmente na programação com sua mistura complexa e às vezes caótica de linguagens de codificação, ferramentas, abordagens e tecnologias. É por isso que um programador Java profissional deve estar bem familiarizado com as convenções de codificação Java, sobre as quais falaremos hoje.
O que são convenções de codificação?
As convenções de codificação são conjuntos de diretrizes para cada linguagem de programação específica com recomendações sobre diferentes aspectos do desenvolvimento de software nessa linguagem, incluindo estilo de codificação, melhores práticas e métodos. As convenções de codificação devem ser seguidas por programadores de software que estão codificando nessa linguagem como guias de qualidade para garantir que seu código seja legível e que a manutenção adequada do software por outras pessoas seja possível. As convenções de codificação normalmente cobrem todos os componentes essenciais da criação de software nesta linguagem de programação, incluindo organização de arquivos, indentação, comentários, declarações, instruções, espaço em branco, convenções de nomenclatura, práticas de programação, princípios de programação, regras práticas de programação, práticas recomendadas de arquitetura e muito mais .
Qual é o propósito das convenções de codificação?
Existem várias razões pelas quais as convenções de codificação desempenham um papel importante no desenvolvimento de software.
Mantendo o estilo de código unificado
Seguir uma convenção de codificação permite que o projeto de software seja escrito em um único estilo unificado, o que é benéfico de várias maneiras diferentes, como a seguir.
Minimizando os custos de manutenção de software
Um dos mais importantes é facilitar a manutenção e o suporte do produto de software, pois muitas vezes os autores originais do programa não são os que o suportam. Isso é importante, pois 80% do custo vitalício de um software vai para a manutenção.
Melhorando a legibilidade do software
A melhoria da legibilidade do software é outro grande benefício, que também tem múltiplas implicações, como simplificar a introdução de novos desenvolvedores no projeto e aumentar a eficiência da colaboração dos membros da equipe de desenvolvimento.
Acelerando o trabalho
Finalmente, ter um código devidamente escrito e estruturado é necessário para que o processo de desenvolvimento de software seja o mais rápido possível.
A convenção de código da Oracle é reconhecida como a mais importante por uma série de razões óbvias: a convenção da Oracle é a oficial, pois a Oracle é a proprietária do Java, bem como uma das mais antigas (a última revisão deste documento foi feita em 20 de abril de 1999). Algumas das partes importantes da Convenção de Código Java da Oracle seriam a recomendação de usar maiúsculas e minúsculas ao definir classes, métodos ou variáveis, iniciar classes com letra maiúscula e usar substantivos para nomeá-las, enquanto usa verbos na forma imperativa e começa de uma letra minúscula para métodos e assim por diante.
Guia de estilo Java do Google
As convenções de codificação Java do Google são consideradas importantes devido ao status do Google como a empresa de tecnologia e Internet de aprendizado com enorme experiência no desenvolvimento de todos os tipos de aplicativos Java. Outro motivo importante é o fato de que a convenção de código Java do Google foi atualizada em 22 de maio de 2018, o que a torna mais relevante do que a convenção de código da Oracle, especialmente quando se trata de descrever recursos relativamente novos do Java que foram lançados apenas como parte do Java 8. em 2014, como lambdas e streams. Veja como os autores do Java Style Guide do Google descrevem o conteúdo dessa convenção de codificação: “Este documento serve como a definição completa dos padrões de codificação do Google para código-fonte em Java. Como outros guias de estilo de programação, as questões abordadas abrangem não apenas questões estéticas de formatação, mas também outros tipos de convenções ou padrões de codificação. No entanto, este documento se concentra principalmente nas regras rígidas que seguimos universalmente e evita dar conselhos que não sejam claramente aplicáveis (seja por humanos ou ferramentas).” “O Google Java Style Guide é uma boa referência em sua maior parte, mas é um pouco permissivo em alguns tópicos. Por outro lado, como programador Java você deve estar acostumado com 4 espaços para indentação de código, entre outras coisas”, disse David Rios, arquiteto de software e programador Java experiente, em um LinkedIn mas é um pouco permissivo em alguns tópicos. Por outro lado, como programador Java você deve estar acostumado com 4 espaços para indentação de código, entre outras coisas”, disse David Rios, arquiteto de software e programador Java experiente, em um LinkedIn mas é um pouco permissivo em alguns tópicos. Por outro lado, como programador Java você deve estar acostumado com 4 espaços para indentação de código, entre outras coisas”, disse David Rios, arquiteto de software e programador Java experiente, em um LinkedInpost com algumas adaptações propostas para o Google Java Style Guide de sua autoria.
Padrões de codificação Java mais usados
Aqui estão alguns dos padrões de codificação Java mais usados que podem ser encontrados nas convenções de codificação da Oracle e do Google mencionadas acima, bem como em outros documentos desse tipo.
Siga a convenção de nomenclatura adequada;
Adicione comentários;
Identificador significa um nome simbólico que se refere ao nome de classes, pacotes, métodos e variáveis em um programa Java;
O nome da variável deve estar relacionado ao seu propósito;
O nome do método deve estar relacionado à funcionalidade do método;
O método não deve conter mais de 50 linhas;
Não deve haver nenhum código duplicado na mesma classe ou outra classe;
Declare variáveis globais somente se necessário para usar nos outros métodos;
Verifique a criação de variáveis estáticas dentro de uma classe;
Evite acessar variáveis diretamente de outras classes, em vez disso, use métodos getter e setter;
Toda a lógica de negócios deve ser tratada apenas na classe de serviço;
Todo o código relacionado ao banco de dados deve estar apenas nas classes DAO;
Usar getters e setters;
Declare a Variável de instância como privada;
Mantenha o escopo das variáveis mínimo;
Atribua nomes significativos às variáveis;
Evite vazamentos de memória liberando conexões de banco de dados quando a consulta estiver concluída;
Tente usar o bloco Finalmente sempre que possível;
Use a estrutura Executor para programação multithread.
GO TO FULL VERSION