Dicas de codificação

Use taglibs ou HTL o máximo possível

A inclusão de scriptlets em JSPs dificulta a depuração de problemas no código. Além disso, ao incluir scriptlets em JSPs, é difícil separar a lógica de negócios da camada de exibição, o que é uma violação do Princípio de Responsabilidade Única e do padrão de design do MVC.

Gravar código legível

O código é gravado uma vez, mas lido várias vezes. Passar algum tempo antes para limpar o código que escrevemos pagará dividendos adiante, pois nós e outros desenvolvedores precisamos lê-lo mais tarde.

Escolher nomes reveladores de intenção

Idealmente, outro programador não deve ter que abrir um módulo para entender o que ele faz. Da mesma forma, eles devem ser capazes de dizer o que um método faz sem lê-lo. Quanto melhor pudermos nos inscrever nessas ideias, mais fácil será ler nosso código e mais rápido poderemos escrever e alterar nosso código.

Na base de código AEM, as seguintes convenções são usadas:

  • Uma única implementação de uma interface é chamada de <Interface>Impl, ou seja, ReaderImpl.
  • Várias implementações de uma interface são nomeadas como <Variant><Interface>, ou seja, JcrReader e FileSystemReader.
  • As classes base abstratas são nomeadas Abstract<Interface> ou Abstract<Variant><Interface>.
  • Os pacotes são nomeados com.adobe.product.module. Cada artefato Maven ou pacote OSGi deve ter seu próprio pacote.
  • As implementações Java são colocadas em um pacote impl abaixo da API.

Observe que essas convenções não precisam necessariamente se aplicar às implementações do cliente, mas é importante que as convenções sejam definidas e seguidas para que o código possa permanecer sustentável.

Idealmente, os nomes devem revelar sua intenção. Um teste de código comum para quando os nomes não são tão claros quanto deveriam ser é a presença de comentários explicando para que serve a variável ou o método:

Não claro

Limpar

int d; //tempo decorrido em dias

int elapsedTimeInDays;

//get tagged images
getItems() de Lista pública {}

lista pública getTaggedImages() {}

Não se repita

DRY indica que o mesmo conjunto de códigos nunca deve ser duplicado. Isso também se aplica a coisas como literais de string. A duplicação de código abre a porta para defeitos sempre que algo precisa mudar e deve ser buscado e eliminado.

Evitar regras CSS nuas

As regras CSS devem ser específicas para o elemento de destino no contexto do aplicativo. Por exemplo, uma regra CSS aplicada a .content .center seria muito abrangente e poderia potencialmente acabar afetando muitos conteúdos em seu sistema, exigindo que outros substituíssem esse estilo no futuro. .myapp-centertext seria uma regra mais específica, uma vez que especifica os texto no contexto do aplicativo.

Eliminar o uso de APIs obsoletas

Quando uma API é descontinuada, é sempre melhor encontrar a nova abordagem recomendada em vez de depender da API descontinuada. Isso garantirá atualizações mais tranquilas no futuro.

Gravar código localizável

Qualquer string que não estiver sendo fornecida por um autor deve ser encapsulada em uma chamada para o dicionário i18n do AEM por meio de I18n.get() em JSP/Java e CQ.I18n.get() no JavaScript. Essa implementação retornará a string passada para ela se nenhuma implementação for encontrada, portanto, oferece a flexibilidade de implementar a localização após implementar os recursos no idioma principal.

Evitar caminhos de recursos para segurança

Embora os caminhos no JCR não devam conter espaços, a presença deles não deve causar a quebra do código. O Jackrabbit fornece uma classe de utilitário de texto com escape() e escapePath() métodos. Para JSPs, a interface do usuário do Granite expõe uma granite:encodeURIPath() EL função.

Usar a API XSS e/ou o HTL para proteger contra ataques de script entre sites

O AEM fornece uma API XSS para limpar facilmente os parâmetros e garantir a segurança contra ataques de script entre sites. Além disso, o HTL tem essas proteções incorporadas diretamente na linguagem de modelo. Uma folha de características da API está disponível para download em Desenvolvimento - diretrizes e práticas recomendadas.

Implementar o registro apropriado

Para o código Java, o AEM é compatível com slf4j como a API padrão para mensagens de registro e deve ser usado junto com as configurações disponibilizadas pelo console OSGi para fins de consistência na administração. O Slf4j expõe cinco níveis de log diferentes. Recomendamos usar as seguintes diretrizes ao escolher em qual nível registrar uma mensagem:

  • ERRO: quando algo está com defeito no código, o processamento não pode continuar. Isso frequentemente ocorrerá como resultado de uma exceção inesperada. Geralmente, é útil incluir rastreamentos de pilha nesses cenários.
  • AVISO: quando algo não funcionou corretamente, mas o processamento pode continuar. Isso será frequentemente o resultado de uma exceção que esperávamos, como uma PathNotFoundException.
  • INFO: informações que seriam úteis ao monitorar um sistema. Lembre-se de que esse é o padrão e que a maioria dos clientes deixará isso em vigor em seus ambientes. Portanto, não o use excessivamente.
  • DEBUG: Informações de nível inferior sobre processamento. Útil ao depurar um problema com suporte.
  • TRACE: As informações de nível mais baixo, como métodos de entrada/saída. Normalmente, isso só será usado por desenvolvedores.

No caso do JavaScript, console.log O só deve ser usado durante o desenvolvimento e todas as instruções de log devem ser removidas antes da versão.

Evite programação cult de carga

Evite copiar o código sem entender seu funcionamento. Em caso de dúvida, é sempre melhor perguntar a alguém que tem mais experiência com o módulo ou a API que você não sabe ao certo.

Nesta página