Skip to content

Latest commit

 

History

History
205 lines (152 loc) · 7.72 KB

Checkstyle.md

File metadata and controls

205 lines (152 loc) · 7.72 KB
Raw

Checkstyle

Koodin testauksen lisäksi koodin luettavuuden ylläpitäminen on tärkeää. Tässä hyvänä apuvälineenä on staattisen analyysin työkalu Checkstyle. ks. http://checkstyle.sourceforge.net/. Kurssilla käytetään Ohjelmoinnin Perusteista ja Ohjelmoinnin Jatkokurssista tuttua checkstyleä, koodin laatuvaatimuksien seurannassa.

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.

Checkstylen tuominen projektiin

Checkstyle on helppo tuoda Maven-projektiin, lisätään se vain pom.xml tiedostoon. Jotta Checkstylen raporteista pääsisi helposti tarkastelemaan lähdekoodissa olevaa ongelmakohtaa, on hyvä käyttää Checkstyleä yhdessä jxr:n kanssa.

Lisää pom.xml tiedostoon

<build>
  <plugins>
  ...
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>2.17</version>
      <configuration>
        <configLocation>checkstyle.xml</configLocation>
      </configuration>
    </plugin>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-jxr-plugin</artifactId>
      <version>2.5</version>
    </plugin>
  </plugins>
</build>

Checkstylen tarkkailemien virheiden joukko on konfiguroitavissa erillisen konfiguraatiotiedoston avulla, luo nyt tätä varten projektiin uusi XML-tiedosto checkstyle.xml.

Avaa tiedosto ja korvaa tiedoston sisältö tällä:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name='Checker'>

    <!-- asetetaan kieliasetukset englanniksi. -->
    <property name="localeCountry" value="EN"/>
    <property name="localeLanguage" value="en"/>

    <module name='TreeWalker'>

        <property name='tabWidth' value='4' />
        
        <!-- Block Checks -->

        <module name='EmptyBlock' />
        <module name='LeftCurly' />
        <module name='NeedBraces' />
        <module name='RightCurly' />
        <module name='AvoidNestedBlocks' />
        <module name="NestedIfDepth">
          <property name="max" value="2"/>
        </module>
        <module name="NestedForDepth">
          <property name="max" value="2"/>
        </module>
        <module name="NestedTryDepth"/>

        <!-- Miscellaneous -->
        <module name='Indentation' />
        <module name="OneStatementPerLine"/>

        <!--- Naming Conventions -->

        <module name='ClassTypeParameterName' />
        <module name='ConstantName' />
        <module name='LocalFinalVariableName' />
        <module name='LocalVariableName' />
        <module name='MemberName' />
        <module name='MethodName' />
        <module name='MethodTypeParameterName' />

        <module name='PackageName'>
            <property name='format' value='^[a-z]+(\.[a-z][a-z0-9]*)*$' />
        </module>

        <module name='ParameterName' />
        <module name='StaticVariableName' />
        <module name='TypeName' />

        <!-- Whitespace -->

        <module name='GenericWhitespace' />
        <module name='EmptyForInitializerPad' />
        <module name='EmptyForIteratorPad' />
        <module name='MethodParamPad' />

        <module name='NoWhitespaceAfter'>
            <property name='tokens' value='BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS' />
        </module>

        <module name='NoWhitespaceBefore'>
            <property name='tokens' value='SEMI, DOT, POST_DEC, POST_INC' />
            <property name='allowLineBreaks' value='true' />
        </module>

        <module name='ParenPad' />
        <module name='TypecastParenPad' />
        <module name='WhitespaceAfter' />

        <module name='WhitespaceAround'>
            <property name='allowEmptyConstructors' value='true' />
            <property name='allowEmptyMethods' value='true' />
        </module>

    </module>

    <!-- File Length -->

    <module name='FileLength'>
        <property name='max' value='200' />
    </module>

</module>

Lisätään aiemmin luotuun nbactions.xml-tiedostoon vielä yksi valikko, jolla voi ajaa Checkstylen helposti suoraan Netbeansistä. Lisää tiedostoon alla oleva pätkä. Tallenna ja aja projektille Clean and Build. Nyt pitäisi Custom valikossa näkyä Pitin lisäksi Checkstyle.

<actions> 
  ...
  <action>
    <actionName>CUSTOM-checkstyle</actionName>
    <displayName>Checkstyle</displayName>
    <goals>
      <goal>jxr:jxr</goal>
      <goal>checkstyle:checkstyle</goal>
    </goals>
  </action>
</actions>

Vaihtoehtoisesti Checkstylen voi ajaa komentoriviltä komennolla mvn jxr:jxr checkstyle:checkstyle Sekä komentoriviltä ajettaessa että suoraan Netbeansistä checkstyle.xml on aiemmin luodun konfiguraatiotiedoston nimi ja komennot olettavat että tiedosto sijaitsee projektihakemiston juuressa.

Generoituasi Checkstyle-raportin löydät sen polusta /target/site/checkstyle.html.

Lisää Checkstylestä voi lukea ohtun sivuilta

Deadline 3: Luokkien jättäminen checkstylen ulkopuolelle

Kurssilla ei ole tarpeen kirjoittaa ehdottoman siistiä käyttöliittymäkoodia, ja siksi emme vaadikaan että käyttöliittymäluokkia testataan ollenkaan Checkstylen avulla. Muutetaan siis vielä raportointi niin, että tietyt tiedostot jätetään pois (esimerkiksi Main.java-tiedostosi). Lisää siis seuraava määritys <module name='TreeWalker'>-tagin ulkopuolelle (!!) esimerkiksi siis <module name='FileLength'>-tagin ylä- tai alapuolelle, mutta kuitenkin niin, että se on <module name='Checker'>- tagin alaisuudessa:

    <module name="SuppressionFilter">
    	<property name="file" value="mysuppressions.xml" />
    </module>

Seuraavassa siis esimerkikki checkstyle.xml-tiedostosta:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name='Checker'>

    <module name='TreeWalker'>

        <property name='tabWidth' value='4' />
	      
	      <!-- Paljon moduuleja välissä -->
        

    </module>

    <!-- File Length -->

    <module name="SuppressionFilter">
    	<property name="file" value="mysuppressions.xml" />
    </module>

    <module name='FileLength'>
        <property name='max' value='200' />
    </module>

</module>

Nyt puuttuu enää itse mysuppressions.xml-tiedoston luonti. Luo siis samaan kansioon missä checkstyle.xml-tiedostosi sijaitsee tiedosto mysuppressions.xml ja anna sen sisällöksi seuraava:

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <suppress files="Tiedostosi1.java" checks="[a-zA-Z0-9]*"/>
    <suppress files="Tiedostosi2.java" checks="[a-zA-Z0-9]*"/>
</suppressions>

Korvaamalla Tiedostosi1 ja Tiedostosi2 niillä tiedostojen nimillä, joita et halua testata, poistaa tiedostot checkstylen testauksen näköalueelta (voit kopioida kumman tahansa rivin ja liittää sen aina toisen alle, että saat enemmän kuin kaksi). Sallittuja tiedostoja ovat esimerkiksi UI-luokat. Siis esimerkiksi Swing komponentit kuten JFrame ja varsinkin GUI editorilla luodut UI-luokat. Jos luokka on 100% oma tekemäsi eikä se ole käyttöliittymäluokka, älä jätä sitä checkstylen ulkopuolelle.