Koodin laatu Raportointi Mavenin kanssa
Parantamalla ohjelmakoodin laatua parannetaan myös sen kestävyyttä ja ylläpidettävyyttä . Tämä opas opettaa sinulle, miten voit luoda koodin laaturaportteja Maven-projektille .
- Kuinka luoda projektisivusto ja raportit Mavenin kanssa
- Koodianalyysi ja raportointi-laajennukset Mavenille
- Miten luoda raportteja Mavenissa
- Miten katsella raportteja Mavenissa
- Lähde XRef
- Testilähde Xref
- Java-dokumentit
- Testaa Java-dokumentteja
- Surefire-raportti
- Failsafe-raportti
- Checkstyle
- CPD
- PMD
- FindBugs
- Käännä raporttisi SonarQubella
Kuinka luoda projektisivusto ja raportit Mavenin kanssa
Maven antaa sinulle mahdollisuuden luoda HTML-sivusto, joka kuvaa projektiasi. Voit käyttäämvn-sivustokomento projektisivuston luomiseen.
Kun olet valmis, avaa kohde / site / index.html- tiedosto nähdäksesi sivuston:
Hankkeessa on yleensä teknisiä tietoja hankkeen arkkitehtuurista (riippuvuudet, laajennukset…); sinun on rikastettava sitä Mavenin raportin laajennusten tuottamilla tiedoilla (kuten määritellään projektin kokoonpanotiedostossa ).
Koodianalyysi ja raportointi-laajennukset Mavenille
Alla on ote, joka voidaan sisällyttää kokoonpanotiedostoosi ( pom.xml ). Siinä on pari erillistä laajennusta koodianalyysiin ja raportointiin. Jokainen plug-in luo projektirakenteesta erityisen raportin.org.apache.maven.plugins maven-failsafe-plugin 2.19.1 integraatiotesti tarkista org.apache.maven.plugins maven-jxr-plugin 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: ei 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 vääriä totta 50 sääntöä / java /android.xml säännöt / java / basic.xml säännöt / java / braces.xml säännöt / java / clone.xml säännöt / java / koodit.xml säännöt / java / comments.xml säännöt / java / coupling.xml säännöt / java / design.xml rulesets / java / empty.xml rulesets / java / finalizers.xml säännöt / java / import.xml säännöt / java / j2ee.xml säännöt / java / javabeans.xml säännöt / java / junit.xml säännöt / java / lokit -jakarta-commons.xml säännöt / java / logging-java.xml säännöt / java / migrating.xml säännöt / java / migrating_to_13.xml säännöt / java / migrating_to_14.xml säännöt / java / migrating_to_15.xml säännöt / java / migrating_to_junit4.xml rulesets / java / naming.xml säännöt /java/optimizations.xml säännöt / java / strictexception.xml säännöt / java / strings.xml säännöt / java / sunsecure.xml säännöt / java / typeresolution.xml säännöt / java / tarpeettomat.xml säännöt / java / unusedcode.xml org. codehaus.mojo findbugs-maven-plugin 3.0.0
Huom. Nämä laajennukset annettiin esimerkkeinä. Napsauta laajennuksia, jos haluat löytää täydellisen luettelon käytettävissä olevista laajennuksista.
Miten luoda raportteja Mavenissa
Ennen kuin aloitat projektisivuston, on tärkeää suorittaa yksiköiden ja integraatiotestien tekeminen jokaiselle uudelle laajennukselle. Voit esimerkiksi käyttäämvn tarkistaa sivustonkomento tuottaa projektisivusto, joka sisältää jo yksikön tulokset ja integraatiotestit .
Miten katsella raportteja Mavenissa
Voit tarkastella raportteja napsauttamalla My Project > Project Documentation > Projektiraportit :
Lähde XRef
Tämän raportin avulla voit tarkastella projektin lähdekoodia :
Testilähde Xref
Tämän raportin avulla voit tarkastella hankkeen testilähdekoodin ristiviittausversiota.Java-dokumentit
Tämä raportti sisältää JavaDoc API -asiakirjan:
Testaa Java-dokumentteja
Tämä raportti sisältää Test JavaDoc API -asiakirjan.Surefire-raportti
Tämä raportti sisältää yksikön testauksen tulokset:
Failsafe-raportti
Tämä raportti sisältää integraatiotestauksen tulokset.Checkstyle
Tässä raportissa luetellaan kaikki Java- standardin syntaksisääntöjen rikkomukset :
Virheilmoitusten takana olevia sääntöjä voidaan muokata mukautetun tarkistusohjelman tarkistusasetuksen avulla.
CPD
Tässä raportissa korostetaan kaksoiskoodilohkoja projektissa:
Muokkaa
arvoparametri määrittää koodin vähimmäispituuden.
PMD
Tässä raportissa korostetaan huonoa koodirakennetta (nykyisen PMD-säännön vastaisesti ), joka saattaa johtaa virheisiin:
Muokkaa
parametri muuttaa PMD-säännön oletusasetusta.FindBugs
Maven luo lähdekoodiraportin FindBugs Libraryn kanssa. Tässä kattavassa raportissa luetellaan koodin mahdolliset virheet: