开发►代码质量

代码质量

1. 在构建时加入checkstyle校验

目的

希望规范团队的代码风格，但又不希望对目前的代码冲击太大，影响代码的正常构建

checkstyle简介

checkstyle主要用于检验java的代码风格，官方支持的有sun_checks.xml和google_checks.xml

maven配置

官方网站：http://maven.apache.org/plugins/maven-checkstyle-plugin/，为解决我们的目的，可以使用以下配置：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.17</version>
        <executions>
            <execution>
                <id>validate</id>
                <phase>validate</phase>
                <configuration>
                    <configLocation>my_checkstyle.xml</configLocation>
                    <includeTestSourceDirectory>true</includeTestSourceDirectory>
                    <!-- 以下两项配置表示当超过10000个警告时构建失败 -->
                    <failOnViolation>true</failOnViolation>
                    <maxAllowedViolations>10000</maxAllowedViolations>
                </configuration>
                <goals>
                    <goal>check</goal>
                </goals>
            </execution>
        </executions>
      </plugin>
    </plugins>
</build>

my_checkstyle.xml的内容可以参考google的风格，自行删减。