Relatório de Qualidade de Código com Maven
Ao melhorar a qualidade do código de um programa, um também melhorará sua robustez e facilidade de manutenção . Este guia ensinará como gerar relatórios de qualidade de código para um projeto Maven .
- Como gerar site de projeto e relatórios com o Maven
- Plug-ins de Análise de Código e Relatório para Maven
- Como gerar relatórios no Maven
- Como visualizar relatórios no Maven
- Fonte XRef
- Teste de refex de origem
- Java Docs
- Testar documentos Java
- Relatório Surefire
- Relatório Failsafe
- Checkstyle
- CPD
- PMD
- FindBugs
- Compile seus relatórios com o SonarQube
Como gerar site de projeto e relatórios com o Maven
O Maven oferece a capacidade de gerar um site HTML que descreve seu projeto. Você pode usar omvn sitecomando para gerar seu site de projeto.
Uma vez feito, abra o arquivo target / site / index.html para visualizar o site:
O site do projeto geralmente contém informações técnicas sobre a arquitetura do projeto (dependências, plug-ins ...); você precisará enriquecê-lo com os dados gerados pelos plug-ins de relatório do Maven (conforme definido no arquivo de configuração do projeto ).
Plug-ins de Análise de Código e Relatório para Maven
Abaixo está um trecho que pode ser incorporado ao seu arquivo de configuração ( pom.xml ). Ele possui alguns plug-ins autônomos para análise e relatório de código. Cada plug-in gerará um relatório específico no site do projeto.org.apache.make.plugins maven-failsafe-plugin 2.19.1 Integração-teste verificar org.apache.maven.plugins maven-jxr-plugin 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: none org.apache.machina.plugins maven-surefire-report-plugin 2.19.1 org.apache.mapa.plugins maven-checkstyle-plugin 2.17 org.apache.maven.plugins maven-pmd-plugin 3.6 falso verdadeiro 50 regras / java / rulesets / java / basic.xml / conjuntos de regras java / basic.xml / java / braces.xml / java / clone.xml conjuntos de regras / java / codesize.xml conjuntos de regras / java / comments.xml / conjuntos de regras / java / coupling.xml / java / conjuntos de regras de design.xml / java / empty.xml conjuntos de regras / java / finalizers.xml / java / imports.xml conjuntos de regras / java / j2ee.xml / java / javabeans.xml / java / junit.xml / java / logging -jakarta-commons.xml conjuntos de regras / java / logging-java.xml conjuntos de regras / java / migrating.xml conjuntos de regras / java / migrating_to_13.xml conjuntos de regras / java / migrating_to_14.xml conjuntos de regras / java / migrating_to_15.xml conjuntos de regras / java / migrating_to_junit4.xml conjuntos de regras de rulesets / java / naming.xml /java/optimizations.xml rulesets / java / strictexception.xml conjuntos de regras / java / strings.xml conjuntos de regras / java / sunsecure.xml conjuntos de regras / java / typeresolution.xml conjuntos de regras / java / unnecessary.xml / java / unusedcode.xml org. codehaus.mojo findbugs-maven-plugin 3.0.0
NB Esses plug-ins foram dados como exemplos. Clique em plug-ins para descobrir a lista completa de plug-ins disponíveis.
Como gerar relatórios no Maven
Antes de criar o site do projeto, é importante executar testes de unidade e integração para cada um dos novos plug-ins. Você pode, por exemplo, usar omvn verificar sitecomando para gerar um site de projeto que já inclua os resultados da unidade e os testes de integração .
Como visualizar relatórios no Maven
Clique em Meu projeto > Documentação do projeto > Relatórios do projeto para visualizar os relatórios:
Fonte XRef
Este relatório permitirá que você visualize o código-fonte do projeto:
Teste de refex de origem
Este relatório permitirá que você visualize uma versão de referência cruzada do código-fonte de teste do projeto.Java Docs
Este relatório conterá a documentação da API JavaDoc :
Testar documentos Java
Este relatório conterá a documentação Test JavaDoc API .Relatório Surefire
Este relatório conterá os resultados para testes unitários :
Relatório Failsafe
Este relatório conterá os resultados para o teste de integração .Checkstyle
Este relatório listará todas as violações das regras de sintaxe padrão em Java:
As regras por trás das mensagens de erros podem ser editadas por meio de uma configuração personalizada do Checkstyle Checker.
CPD
Este relatório destacará blocos de código duplicados no projeto:
Edite o
valorparâmetro para definir o comprimento mínimo do código.
PMD
Este relatório destacará a construção de código deficiente (violando o conjunto de regras do PMD atual) que pode levar a erros:
Edite o
parâmetro para alterar o conjunto de regras do PMD padrão.FindBugs
O Maven criará um relatório de código fonte com a biblioteca FindBugs. Este extenso relatório listará os possíveis erros no seu código: