Звіт про якість коду з Maven
Підвищуючи якість програми, можна підвищити її надійність і ремонтопридатність . Цей посібник навчить вас генерувати звіти про якість коду для проекту Maven .
- Як створити сайт проекту та звіти з Maven
- Модулі аналізу та звітування кодів Maven
- Як створити звіти в Maven
- Як переглядати звіти в Maven
- Джерело XRef
- Джерело випробування Xref
- Документи Java
- Перевірка документів Java
- Доповідь Surefire
- Безпечний звіт
- Checkstyle
- CPD
- PMD
- FindBugs
- Скомпілюйте ваші звіти за допомогою SonarQube
Як створити сайт проекту та звіти з Maven
Maven надає можливість створювати сайт HTML, який описує ваш проект. Ви можете використовуватиmvn сайтукоманда для створення сайту проекту.
Після цього відкрийте файл target / site / index.html, щоб переглянути сайт:
Сайт проекту зазвичай містить технічну інформацію про архітектуру проекту (залежності, плагіни…); Вам потрібно буде збагатити його даними, створеними модулями звітів Maven (як це визначено у файлі конфігурації проекту ).
Модулі аналізу та звітування кодів Maven
Нижче наведено уривок, який можна включити до вашого конфігураційного файлу ( pom.xml ). Він містить кілька автономних плагінів для аналізу коду та звітності. Кожен плагін буде генерувати певний звіт на сайті проекту.org.apache.maven.plugins maven-failsafe-плагін 2.19.1 integr-test перевірити org.apache.maven.plugins maven-jxr-плагін 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: none org.apache.maven.plugins maven-surefire-report-плагін 2.19.1 org.apache.maven.plugins maven-checkstyle-плагін 2.17 org.apache.maven.plugins maven-pmd-plugin /android.xml rulesets / java / basic.xml rulesets / java / braces.xml облік правил / java / clone.xml rulesets / java / codesize.xml rulesets / java / comments.xml rulesets / java / coupling.xml правил / java / Набори правил / java / empty.xml rulesets / java / finalizers.xml, набори правил / java / imports.xml, набори правил / java / j2ee.xml, набори правил / java / javabeans.xml, набори правил / java / junit.xml / 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_15.xml rulesets / java / migrating_to_junit4.xml набори правил / java / naming.xml /java/optimizations.xml rulesets / java / strictexception.xml ruleset / java / strings.xml об'яви / java / sunsecure.xml rulesets / java / typeresolution.xml rulesets / java / unnecessary.xml rulesets / java / unusedcode.xml org. codehaus.mojo findbugs-maven-плагін 3.0.0
NB Ці плагіни наведено як приклади. Натисніть плагіни, щоб відкрити повний список доступних плагінів.
Як створити звіти в Maven
Перш ніж створювати сайт проекту, важливо запускати тести пристроїв та інтеграції для кожного нового плагіна. Ви можете, наприклад, використовуватиmvn перевірити сайткоманда для створення сайту проекту, який вже буде включати в себе результати блоку та інтеграційні тести .
Як переглядати звіти в Maven
Натисніть на Мій проект > Документація проекту > Звіти проекту, щоб переглянути звіти:
Джерело XRef
Цей звіт дозволить вам переглянути вихідний код проекту:
Джерело випробування Xref
Цей звіт дозволить вам переглянути версію перехресного посилання на вихідний код тесту проекту.Документи Java
Цей звіт міститиме документацію JavaDoc API :
Перевірка документів Java
Цей звіт міститиме документацію API Test JavaDoc .Доповідь Surefire
Цей звіт міститиме результати для модульного тестування :
Безпечний звіт
Цей звіт міститиме результати тестування інтеграції .Checkstyle
У цьому звіті буде вказано всі порушення стандартних синтаксичних правил у Java:
Правила, які стоять за повідомленнями про помилки, можна редагувати за допомогою спеціальної конфігурації контролера Checkstyle.
CPD
У цьому звіті будуть виділені дубльовані блоки коду в проекті:
Редагувати
значенняпараметр для визначення мінімальної довжини коду.
PMD
У цьому звіті буде висвітлено слабку конструкцію коду (у порушення поточного набору правил PMD ), що потенційно може призвести до помилок:
Редагувати
параметр для зміни стандартного набору правил PMD.FindBugs
Maven створить звіт з вихідним кодом з бібліотекою FindBugs. У цьому великому звіті буде вказано можливі помилки у вашому коді: