Koodikvaliteet Aruandlus Maveniga

Programmi koodikvaliteedi parandamisega parandatakse ka selle töökindlust ja hooldust . See juhend õpetab teile, kuidas luua Maven projekti koodikvaliteedi aruandeid.

• Kuidas luua projekti sait ja aruanded Maveniga
• Maveni koodianalüüsi ja aruandluse pluginad
• Kuidas luua aruandeid Mavenis
• Kuidas vaadata aruandeid Mavenis
  • Allikas XRef
  • Test Allikas Xref
  • Java-dokumendid
  • Testige Java-dokumente
  • Surefire'i aruanne
  • Failsafe'i aruanne
  • Checkstyle
  • CPD
  • PMD
  • FindBugs
• Koosta oma aruanded SonarQube'iga

Kuidas luua projekti sait ja aruanded Maveniga

Maven annab teile võimaluse luua oma projekti kirjeldav HTML-sait . Võite kasutada

 mvn sait 

käsk luua oma projekti sait.

Kui olete seda teinud, avage saidi vaatamiseks siht- / saidi / index.html- fail:

Projekti sait sisaldab tavaliselt tehnilist teavet projekti arhitektuuri kohta (sõltuvused, pluginad); peate seda rikastama andmetega, mis on loodud Maveni aruande lisandmoodulite poolt (nagu on määratletud teie projekti konfiguratsioonifailis ).

Maveni koodianalüüsi ja aruandluse pluginad

Allpool on väljavõte, mida saab lisada oma konfiguratsioonifaili ( pom.xml ). See sisaldab paari eraldiseisvaid pluginaid koodianalüüsi ja aruandluse jaoks. Iga pistikprogramm loob projekti kohas konkreetse aruande.

 org.apache.maven.plugins maven-failsafe-plugin 2.19.1 integratsioonitesti kontrollige org.apache.maven.plugins maven-jxr-plugin 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: nr org.apache.maven.plugins maven-surefire-report-plugin 2.19.1 org.apache.maven.plugins maven-checkstyle-plugin 2.17 org.apache.maven.plugins maven-pmd-plugin 3.6 vale tõsi 50 reeglit / java /android.xml rulesets / java / basic.xml reeglid / java / braces.xml reeglid / java / clone.xml reeglid / java / koodid.xml reeglid / java / comments.xml reeglid / java / coupling.xml reeglid / java / design.xml rulesets / java / empty.xml rulesets / java / finalizers.xml reeglid / java / import.xml reeglid / java / j2ee.xml reeglid / java / javabeans.xml reeglid / java / junit.xml reeglid / java / logimine -jakarta-commons.xml reeglid / java / logging-java.xml reeglid / java / migrating.xml reeglid / java / migrating_to_13.xml reeglid / java / migrating_to_14.xml reeglid / java / migrating_to_15.xml reeglid / java / migrating_to_junit4.xml rulesets / java / naming.xml reeglid /java/optimizations.xml reeglid / java / strictexception.xml reeglid / java / strings.xml reeglid / java / sunsecure.xml reeglid / java / typeresolution.xml rulesets / java / uncary.xml rulesets / java / unusedcode.xml org. codehaus.mojo findbugs-maven-plugin 3.0.0 

NB: Need pluginad on toodud näidetena. Saadaolevate lisandmoodulite täieliku loendi avamiseks klõpsake pluginaid.

Kuidas luua aruandeid Mavenis

Enne projekti saidi loomist on oluline käivitada iga uue pistikprogrammi üksuste ja integreerimise testid . Võite näiteks kasutada

 mvn kinnitab saiti 

käsk luua projekti sait, mis sisaldab juba üksuse tulemusi ja integreerimiskatseid .

Kuidas vaadata aruandeid Mavenis

Aruannete vaatamiseks klõpsake Minu projekt > Projekti dokumentatsioon > Projekti aruanded:

Allikas XRef

See aruanne võimaldab teil vaadata projekti lähtekoodi :

Test Allikas Xref

See aruanne võimaldab teil vaadata projekti testimise lähtekoodi ristviide versiooni.

Java-dokumendid

See aruanne sisaldab JavaDoc API dokumentatsiooni:

Testige Java-dokumente

See aruanne sisaldab Test JavaDoc API dokumentatsiooni.

Surefire'i aruanne

See aruanne sisaldab üksuse testimise tulemusi:

Failsafe'i aruanne

See aruanne sisaldab integratsiooni testimise tulemusi.

Checkstyle

See aruanne loetleb kõik Java-i tavaliste süntaksireeglite rikkumised :

Vigade sõnumite taga olevaid reegleid saab redigeerida Custom Checkstyle Checkeri konfiguratsiooni abil.

CPD

See aruanne tõstab esile projekti duplikaatide plokid :

Muuda

 väärtus 

parameetri miinimumkoodi pikkuse määramiseks.

PMD

See aruanne tõstab esile halva koodi konstruktsiooni (rikkudes praegust PMD-reeglit ), mis võib põhjustada vigu:

Muuda

parameeter vaikimisi PMD-reeglite muutmiseks.

FindBugs

Maven loob FindBugs Libraryga lähtekoodi aruande. Selles ulatuslikus aruandes loetletakse võimalikud vead teie koodis:

Koosta oma aruanded SonarQube'iga

SonarQube on avatud lähtekoodiga platvorm, mis võimaldab koostada teavet oma erinevatest aruannetest, hinnata teie koodi kvaliteeti ja võrrelda oma projekti teistega.