Manual de Padrões para Desenvolvimento Java

Tamanho: px

Começar a partir da página:

Download "Manual de Padrões para Desenvolvimento Java"

Maria de Fátima Fernandes Santana
7 Há anos
Visualizações:

1 Desenvolvimento Java Versão <1.2> Histórico de Revisões Data Versão Descrição Autor 18/10/ Versão Inicial 06/04/ Atualizado conforme Histórico de Versões EPG 05/05/ Atualizado conforme Histórico de Versões EPG Márcio Aloise/Rodrigo Cayres

2 Desenvolvimento Java fl. 2 de 7 1. Introdução 1.1. Objetivo do Documento Este documento tem por finalidade de atribuir um padrão de desenvolvimento Java a fim de minimizar impactos no desenvolvimento do sistema. 2. Padrões de Desenvolvimento 2.1. Regras Gerais São consideradas Regras Gerais todo e qualquer padrão de codificação envolvendo aplicações desenvolvidas em linguagem Java Nomenclaturas Nomenclatura de Pacotes (Packages) Nomes de Pacotes (Packages) devem ser escritos totalmente em minúsculo. Exemplo: package br.com.empresa.cliente.projeto.funcionalidade. pacote Nomenclatura de Classes e Interfaces A primeira letra deve ser maiúscula e, se o nome for composto por várias palavras, a primeira letra de cada palavra deve ser maiúscula. Quando houver iniciais, devem ser figuradas como maiúsculas. Nunca utilizar nomes de Classes ou Interfaces com acentuação. Exemplos: CadastroPessoaBean; FornecedorORM; ClienteMB Nomenclatura de Métodos A primeira letra deve ser minúscula e, se o nome for composto por várias palavras, a primeira letra de cada palavra subsequente deve ser maiúscula (formato chamado camelcase ). Nunca utilizar nomes de Métodos com acentuação. Os nomes devem, normalmente, ser pares de verbo-substantivo. Exemplos: CadastrarPessoa; obtersaldo; pesquisarfornecedor Imports Preferencialmente deve-se importar somente o necessário. Evitar, sempre que possível, a importação de pacotes completos, utilizando-se do caractere de asterisco. Desta última forma, são importadas também classes que não vão ser usadas, sobrecarregando o sistema de forma desnecessária. Exemplos:

3 Desenvolvimento Java fl. 3 de 7 Correto: import java.util.arraylist import java.util.calendar; import javax.ejb.ejb; Errado: import java.util.*; import javax.ejb.*; Javadoc e Comentários Javadoc de Classes Todas as classes devem definir os atributos no javadoc: author, version, revision, descrição e, quando atrelado a um caso de uso específico, determinar sua numeração, seguindo a formatação abaixo: /** * UC028 Emitir Boletos * Classe contendo Regras de Negócio para impressão de Boletos * * <pre> * Last Modified $Date: 2011/06/01 14:54:18 $ * Last Modified by $Author: autor $ * </pre> * autor $Revision: 1.1 $ */ Javadoc de Métodos Todos os métodos devem possuir javadoc com texto explicativo da finalidade daquele método. Para os métodos que são herdados, é obrigatório o uso do javadoc com atributo inheritdoc. Exemplo: /** {@inheritdoc} */ Confidencial Magna Sistemas Consultoria, 2015 Página 3

4 Desenvolvimento Java fl. 4 de Comentários em código Comentar o código sempre que possível. A manutenção do código se tornará mais fácil para você e para outros que fizerem manutenção Padrões de Códigos Indentação Manter o código indentado, o que consiste à adição de tabulações no início de cada linha na quantidade equivalente ao número de blocos em que cada linha está contida Constantes As constantes Java são criadas marcando-se variáveis como static e final. Elas devem ser declaradas com caracteres underscore( _ ) como separadores e escritas em letras maiúsculas. Exemplos: public static final Integer CONSTANTE_UM = 1; public static final String CODIGO_UF_SP = SP ; Variáveis Assim como os métodos, a primeira letra deve ser minúscula e, se o nome for composto por várias palavras, a primeira letra de cada palavra subsequente deve ser maiúscula (formato chamado camelcase ). Nunca utilizar nomes de Variáveis com acentuação Arrays Especificadores de arrays devem ser descritas no tipo e não no nome da variável. Exemplo: Correto: int[] a = new int[20]; Errado: int a[] = new int[20]; Tratamento de Exceções Evitar usar catches vazios em blocos try-catch. Tratamento de erros mal feitos escondem erros que poderiam ser corrigidos. Caso não haja a necessidade real de propagação de uma exception para o método chamador, informar na cláusula catch que aquela exception não será propagada. Exemplos: Confidencial Magna Sistemas Consultoria, 2015 Página 4

5 Desenvolvimento Java fl. 5 de 7 try { // código-executado //... } catch (ObjectNotFoundDAOException e) { // NÃO FAZ NADA } catch (DAOException e) { throw new RollbackBusinessException(e); } Linhas de Código Uma declaração por linha é recomendada, encorajando comentários. Exemplo: Recomendado: int level; // nível de identação int size; // tamanho da tabela Não recomendado: int level, size; 2.2. Regras de Nomeação de Propriedades JavaBean Métodos de Acessos Para completar o nome de um método getter ou setter, deve-se mudar a primeira letra do nome da propriedade para maiúscula e depois juntar a ela o prefixo adequado (get, is ou set). Exemplos: private Boolean flagchecked; private boolean empty; private int recordcount; Métodos de Acesso: getflagchecked(); isempty(); setrecordcount(integer count); Confidencial Magna Sistemas Consultoria, 2015 Página 5

6 Desenvolvimento Java fl. 6 de Assinatura de Método Getter Assinaturas de método getter devem ser marcadas como public, não usar argumentos e ter um tipo de retorno que seja do mesmo tipo de argumento da propriedade. Exemplo: private int size; private Integer count; private Boolean checked; private boolean admin; public int getsize(); public Integer getcount(); public Boolean getchecked(); public boolean isadmin(); No entanto, existem particularidades para definição de nomenclatura de métodos getter, relacionados a seguir Propriedade Não-Booleana e Boolean Wraper Se a propriedade não for booleana, ou se a propriedade for do tipo Boolean (Wraper) o prefixo do método getter deve ser get. Exemplos: private int size; private Integer count; private Boolean checked; public int getsize(); public Integer getcount(); public Boolean getchecked(); Propriedade Booleana (boolean primitivo) Se o tipo da propriedade for boolean primitivo (boolean), o prefixo do método getter deve ser is. Exemplos: private boolean admin; private boolean empty; private boolean checked; Confidencial Magna Sistemas Consultoria, 2015 Página 6

7 Desenvolvimento Java fl. 7 de 7 public boolean isadmin(); public boolean isempty(); public boolean ischecked(); Assinatura de Método Setter Assinaturas de método setter devem ser marcadas como public, com um tipo de retorno void e um argumento que represente o tipo da propriedade. Exemplos: private int size; private Integer count; private Boolean checked; private boolean admin; private Boolean empty; public void setsize(int size); public void setcount(integer count); public void setchecked(boolean checked); public void setadmin(boolean admin); public void setempty(boolean empty); Confidencial Magna Sistemas Consultoria, 2015 Página 7

Documentos relacionados

Programação Orientada a Objectos - P. Prata, P. Fazendeiro

Programação Orientada a Objectos - P. Prata, P. Fazendeiro 3 Classes e instanciação de objectos (em Java) Suponhamos que queremos criar uma classe que especifique a estrutura e o comportamento de objectos do tipo Contador. As instâncias da classe Contador devem