Jenkins——静态检查checkstyle自定义代码检查

1. pom的配置
   a) 在<build>里增加checkstyle配置，代码如下：

<plugin>  
    <groupId>org.apache.maven.plugins</groupId>  
    <artifactId>maven-checkstyle-plugin</artifactId>  
    <version>2.17</version>
    <configuration>
        <consoleOutput>ture</consoleOutput>
        <outputFileFormat>xml</outputFileFormat>
        <configLocation>eidlink_checks.xml</configLocation>
        <linkXRef>ture</linkXRef>
    </configuration>
</plugin>

b) 在<reporting>里增加checkstyle的报告生存配置，代码如下：

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

2. 定义本公司checkstyle规则
   checkstyle默认使用sun_checks.xml或者google_checks.xml，规则定义比较严格，在实际使用中进行了取舍。

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

<!--

 Checkstyle configuration that checks the sun coding conventions from:

   - the Java Language Specification at
     http://java.sun.com/docs/books/jls/second_edition/html/index.html

   - the Sun Code Conventions at http://java.sun.com/docs/codeconv/

   - the Javadoc guidelines at
     http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

   - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html

   - some best practices

 Checkstyle is very configurable. Be sure to read the documentation at
 http://checkstyle.sf.net (or in your downloaded distribution).

 Most Checks are configurable, be sure to consult the documentation.

 To completely disable a check, just comment it out or delete it from the file.

 Finally, it is worth reading the documentation.

-->

<module name="Checker">
   <property name="severity" value="warning"/>

   <!-- Checks that a package-info.java file exists for each package.     -->
   <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
   <!-- <module name="JavadocPackage"/> -->

   <!-- Checks whether files end with a new line.                        -->
   <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
   <!-- <module name="NewlineAtEndOfFile"> -->
       <!-- <property name="severity" value="ignore"/> -->
   <!-- </module> -->

   <!-- Checks that property files contain the same keys.         -->
   <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
   <!-- <module name="Translation"/> -->

   <!-- Checks for Size Violations.                    -->
   <!-- See http://checkstyle.sf.net/config_sizes.html -->
   <module name="FileLength"/>

   <!-- Checks for whitespace                               -->
   <!-- See http://checkstyle.sf.net/config_whitespace.html -->
   <!-- <module name="FileTabCharacter"> -->
       <!-- <property name="severity" value="ignore"/> -->
   <!-- </module> -->

   <!-- Miscellaneous other checks.                   -->
   <!-- See http://checkstyle.sf.net/config_misc.html -->
   <!-- <module name="RegexpSingleline"> -->
      <!-- <property name="severity" value="ignore"/> -->
      <!-- <property name="format" value="\s+$"/> -->
      <!-- <property name="minimum" value="0"/> -->
      <!-- <property name="maximum" value="0"/> -->
      <!-- <property name="message" value="Line has trailing spaces."/> -->
   <!-- </module> -->

   <!-- Checks for Headers                                -->
   <!-- See http://checkstyle.sf.net/config_header.html   -->
   <!-- <module name="Header"> -->
   <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
   <!--   <property name="fileExtensions" value="java"/> -->
   <!-- </module> -->

   <module name="TreeWalker">
       <property name="tabWidth" value="4"/>

       <!-- Checks for Javadoc comments.                     -->
       <!-- See http://checkstyle.sf.net/config_javadoc.html -->
       <!-- <module name="JavadocMethod"> -->
           <!-- <property name="logLoadErrors" value="true"/> -->
           <!-- <property name="suppressLoadErrors" value="true"/> -->
       <!-- </module> -->
       <!-- <module name="JavadocType"/> -->
       <!-- <module name="JavadocVariable"/> -->
       <!-- <module name="JavadocStyle"/> -->


       <!-- Checks for Naming Conventions.                  -->
       <!-- See http://checkstyle.sf.net/config_naming.html -->
       <module name="ConstantName"/>
       <module name="LocalFinalVariableName"/>
       <module name="LocalVariableName"/>
       <module name="MemberName"/>
       <module name="MethodName"/>
       <module name="PackageName"/>
       <module name="ParameterName"/>
       <module name="StaticVariableName"/>
       <module name="TypeName"/>


       <!-- Checks for imports                              -->
       <!-- See http://checkstyle.sf.net/config_import.html -->
       <module name="AvoidStarImport"/>
       <!-- <module name="IllegalImport"/> --> <!-- defaults to sun.* packages --> 
       <module name="RedundantImport"/>
       <module name="UnusedImports"/>


       <!-- Checks for Size Violations.                    -->
       <!-- See http://checkstyle.sf.net/config_sizes.html -->
       <module name="LineLength">
           <property name="max" value="120"/>
       </module>
       <!-- <module name="MethodLength"/> -->
       <!-- <module name="ParameterNumber"/> -->


       <!-- Checks for whitespace                               -->
       <!-- See http://checkstyle.sf.net/config_whitespace.html -->
       <!-- <module name="EmptyForIteratorPad"/> -->
       <module name="GenericWhitespace"/>
       <module name="MethodParamPad"/>
       <!-- <module name="NoWhitespaceAfter"> -->
           <!-- <property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/> -->
       <!-- </module> -->
       <!-- <module name="NoWhitespaceBefore"/> -->
       <!-- <module name="OperatorWrap"/> -->
       <!-- <module name="ParenPad"/> -->
       <module name="TypecastParenPad"/>
       <!-- <module name="WhitespaceAfter"/> -->
       <!-- <module name="WhitespaceAround"> -->
           <!-- <property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAND,LCURLY,LE,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,LITERAL_ASSERT,TYPE_EXTENSION_AND,WILDCARD_TYPE"/> -->
       <!-- </module> -->


       <!-- Modifier Checks                                    -->
       <!-- See http://checkstyle.sf.net/config_modifiers.html -->
       <module name="ModifierOrder"/>
       <module name="RedundantModifier"/>


       <!-- Checks for blocks. You know, those {}'s         -->
       <!-- See http://checkstyle.sf.net/config_blocks.html -->
       <module name="AvoidNestedBlocks"/>
       <module name="EmptyBlock"/>
       <module name="LeftCurly"/>
       <module name="NeedBraces"/>
       <module name="RightCurly"/>


       <!-- Checks for common coding problems               -->
       <!-- See http://checkstyle.sf.net/config_coding.html -->
       <module name="AvoidInlineConditionals"/>
       <module name="EmptyStatement"/>
       <module name="EqualsHashCode"/>
       <module name="HiddenField"/>
       <module name="IllegalInstantiation"/>
       <module name="InnerAssignment"/>
       <!-- <module name="MagicNumber"/> -->
       <module name="MissingSwitchDefault"/>
       <module name="SimplifyBooleanExpression"/>
       <module name="SimplifyBooleanReturn"/>

       <!-- Checks for class design                         -->
       <!-- See http://checkstyle.sf.net/config_design.html -->
       <module name="DesignForExtension"/>
       <module name="FinalClass"/>
       <module name="HideUtilityClassConstructor"/>
       <module name="InterfaceIsType"/>
       <module name="VisibilityModifier"/>


       <!-- Miscellaneous other checks.                   -->
       <!-- See http://checkstyle.sf.net/config_misc.html -->
       <module name="ArrayTypeStyle"/>
       <module name="FinalParameters"/>
       <module name="TodoComment">
           <property name="severity" value="ignore"/>
       </module>
       <module name="UpperEll"/>
   </module>
</module>

3. jenkins配置
   a) 安装插件Checkstyle Plug-in
   b) 增加构建步骤clean install checkstyle:checkstyle

   
   Paste_Image.png
   

   c) 增加构建后步骤，默认设置

   
   Paste_Image.png
4. 查看检查报告
   趋势图：

Paste_Image.png

检查报告：

Paste_Image.png

【参考】
1、Jenkins+maven+checkstyle对java代码进行静态代码分析
2、maven配置checkstyle检查的自定义模块