maven-checkstyle-plugin

Это очень полезный плагин. Плагин проверяет стиль и качество исходного кода. Проверка качества кода особенно актуальна при разработке в команде из нескольких программистов. Автоматизация такой проверки - большая помощь в этой нудной и кропотливой работе.

Плагин основан на проекте http://checkstyle.sourceforge.net/. Из наиболее часто используемых и простых проверок:

• наличие комментариев
• размер класса не более N строк
• в конструкции в try-catch, блок catch не пустой.
• не используется System.out.println(.. вместо LOG.error(..

Подключить плагин довольно просто:

..
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>2.7</version>
        </plugin>
...........

mvn checkstyle:check

Т.к. почти каждые проекты пишутся немного по-разному, рекомедую создать свой набор правил. Полный набор правил описан тут: http://checkstyle.sourceforge.net/availablechecks.html и задать его можно в специальном конфигурационном файле. (см. http://checkstyle.sourceforge.net/config.html) пример файла со сравнительно нестрогой проверкой приведён...

Внутри jar плагина есть примеры конфигурационных файлов:

• config/sun_checks.xml - от Sun Microsystems. Используются по умолчанию.
• config/maven_checks.xml - от Maven.
• config/turbine_checks.xml -от Turbine.
• config/avalon_checks.xml - от Avalon.

Если каком то месте кода появляется ошибка, но по объективным причинам код такой и должен быть, можно подавить вывод ошбки используя модуль SuppressionCommentFilter или SuppressionFilter

Пример объявления maven-checkstyle-plugin из реально работающего кода

 <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>2.6</version>
    <configuration>
        <configLocation>src/config/checkstyle.xml</configLocation>
            <consoleOutput>true</consoleOutput>
        </configuration>
        <executions>
            <execution>
                <phase>package</phase>
                <goals><goal>check</goal></goals>
            </execution>
        </executions>
</plugin>