checkstyle安装使用

1. 按照安装findbugs的方式按照checkstyle插件

安装过程中的截图如下：

受网速和软件大小限制可能比较耗时请耐心等待：

2. 导入checkstyle的规则约定文件

xdja_checkstyle.xml 文件编码为：utf-8.文件内容如下：

<?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 athttp://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 athttp://java.sun.com/j2se/javadoc/writingdoccomments/index.html- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html- some best practicesCheckstyle is very configurable. Be sure to read the documentation athttp://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"/><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>

2.1 导入步骤

进入eclipse主界面。window>perferences 进入如下截图：

2.2 导入公司自定义规则文件

如下截图：

2.3 设置为默认规则

确认设置规则：

3. 开始使用checkstyle

在eclipse工程项目右键如下图：

4. 打开checkstyle视图

5.效果报告列表和图

图：

6.规范校验及使用

结合公司制定的java代码规范文档和自定义规则文件使用。后续不断完善xdja_checkstyle.xml 规则文件。