Докладване за качеството на кода с Maven
Чрез подобряване на качеството на кода на програмата, ще се подобри и нейната стабилност и поддръжка . Това ръководство ще ви научи как да генерирате отчети за качеството на код за проект Maven .
- Как да генерирате сайта на проекта и отчетите с Maven
- Модули за анализ на кодове и отчитане на Maven
- Как да генерираме отчети в Maven
- Как да преглеждате отчети в Maven
- Източник XRef
- Източник на тест Xref
- Документи за Java
- Изпробвайте Java Docs
- Surefire Report
- Безопасен доклад
- Checkstyle
- CPD
- PMD
- FindBugs
- Компилирайте отчетите си със SonarQube
Как да генерирате сайта на проекта и отчетите с Maven
Maven ви дава възможност да генерирате HTML сайт, който описва вашия проект. Можете да използватеmvn siteкоманда за генериране на сайта на проекта.
След като го направите, отворете файла target / site / index.html, за да видите сайта:
Сайтът на проекта обикновено съдържа техническа информация за архитектурата на проекта (зависимости, плъгини…); ще трябва да го обогатите с данните, генерирани от приставките за доклади на Maven (както е определено във вашия конфигурационен файл на проекта ).
Модули за анализ на кодове и отчитане на Maven
По-долу е извадка, която може да бъде включена във вашия конфигурационен файл ( pom.xml ). Той разполага с няколко самостоятелни плъгина за анализ на кодове и отчитане. Всеки плъгин ще генерира конкретен доклад за сайта на проекта.org.apache.maven.plugins maven-failsafe-plugin 2.19.1 интеграция-тест проверка на org.apache.maven.plugins maven-jxr-plugin 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: няма. org.apache.maven.plugins maven-surefire-report-plugin 2.19.1 org.apache.maven.plugins maven-checkstyle-плъгин 2.17 org.apache.maven.plugins maven-pmd-plugin 3.6 /android.xml набор от правила / java / basic.xml rulesets / java / braces.xml набор от правила / java / clone.xml набор от правила / java / codesize.xml rulesets / java / comments.xml набор от правила / java / coupling.xml design.xml набор от правила / java / empty.xml rulesets / java / finalizers.xml набор от правила / java / imports.xml rulesets / java / j2ee.xml rulesets / java / javabeans.xml набор от правила / java / junit.xml rulesets / java / logging -jakarta-commons.xml набор от правила / java / logging-java.xml rulesets / java / migrating.xml rulesets / java / migrating_to_13.xml rulesets / java / migrating_to_14.xml rulesets / java / migrating_to_junit4.xml набор от правила / java / naming.xml /java/optimizations.xml rulesets / java / strictexception.xml набор от правила / java / strings.xml rulesets / java / sunsecure.xml rulesets / java / typeresolution.xml набор от правила / java / unnecessary.xml rulesets / java / unusedcode.xml org. codehaus.mojo findbugs-maven-plugin 3.0.0
NB Тези приставки са дадени като примери. Кликнете върху приставките, за да откриете пълния списък с наличните приставки.
Как да генерираме отчети в Maven
Преди да създадете сайта на проекта, е важно да изпълнявате тестове за единица и интеграция за всеки от новите плъгини. Можете например да използватеmvn проверете сайтакоманда за генериране на сайт на проекта, който вече ще включва резултатите от тестовете за единица и интеграция .
Как да преглеждате отчети в Maven
Кликнете върху Моят проект > Документация на проекта > Отчети за проекта, за да видите отчетите:
Източник XRef
Този отчет ще ви позволи да видите изходния код на проекта:
Източник на тест Xref
Този отчет ще ви позволи да видите версия на кръстосана препратка на изходния код на теста на проекта.Документи за Java
Този отчет ще съдържа документацията на JavaDoc API :
Изпробвайте Java Docs
Този отчет ще съдържа документацията на тестовия JavaDoc API .Surefire Report
Този отчет ще съдържа резултатите от тестването за единица :
Безопасен доклад
Този отчет ще съдържа резултатите от тестването за интеграция .Checkstyle
Този отчет ще изброи всички нарушения на стандартните правила за синтаксис в Java:
Правилата зад съобщенията за грешки могат да бъдат редактирани чрез персонализирана проверка на Checkstyle конфигурация.
CPD
Този отчет ще подчертае дублиращите се блокове в проекта:
Редактирайте
стойностпараметър за определяне на минималната дължина на кода.
PMD
Този отчет ще подчертае конструкцията на лошия код (в нарушение на текущия набор от правила за PMD ), която потенциално може да доведе до грешки:
Редактирайте
параметър за промяна на стандартния PMD Ruleset.FindBugs
Maven ще създаде доклад за изходния код с библиотеката FindBugs. Този обширен доклад ще изброи възможните грешки в кода ви: