Eclipse中使用Checkstyle,checkstyle插件检查java代码的自定义配置文件：
生活随笔
收集整理的這篇文章主要介紹了
Eclipse中使用Checkstyle,checkstyle插件检查java代码的自定义配置文件：
小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.
摘要：近來(lái)項(xiàng)目組在搞代碼檢查，所以領(lǐng)導(dǎo)讓把checkstyle這個(gè)插件搞明白，現(xiàn)在我把我們寫(xiě)的自定義的checkstyle.xml文件記錄一下，以便大家可以一起使用：
一：要使用checkstyle插件在eclipse中檢查java代碼，那必須的先安裝eclipse的checkstyle插件，如何安裝，我相信大家知道，這里就不多說(shuō)了
二：下面就是自定義的checkstyle.xml文件(這個(gè)是核心)
<?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"> <!-- This configuration file was written by the eclipse-cs plugin configuration editor --> <!-- Checkstyle-Configuration: check Description: none --> <module name="Checker"><property name="severity" value="error"/><property name="charset" value="UTF-8"/><message key="general.exception" value="有一個(gè)異常 - {0} "/><message key="general.fileNotFound" value="文件沒(méi)找到!"/><!--章節(jié)2.2A --><!-- 不允許使用TAB縮進(jìn),此規(guī)則必須在<TreeWalker>標(biāo)簽外 --><module name="FileTabCharacter"><property name="severity" value="error"/><property name="eachLine" value="true"/><message key="containsTab" value="本行包含 tab 字符,違反編碼規(guī)范2.2章節(jié)"/></module><!--章節(jié)3.1.1 --><!-- 檢查每個(gè)java package中是否有java注釋文件，默認(rèn)是允許一個(gè)package-info.java，也可以通過(guò)allowLegacy屬性配置允許package.html。此規(guī)則必須在<TreeWalker>標(biāo)簽外 --><module name="JavadocPackage" /><module name="TreeWalker"><property name="severity" value="error"/> <property name="tabWidth" value="4"/> <message key="general.exception" value="有一個(gè)異常 - {0}"/> <!--章節(jié)1.2.2 --><!-- 修飾符順序檢測(cè) --><module name="ModifierOrder"> <message key="mod.order" value="''{0}'' 修飾符順序錯(cuò)誤.違反編碼規(guī)范1.2.2章節(jié)"/> <message key="annotation.order" value="''{0}'' 注釋修飾符不能在非注釋修飾符前面."/> </module><!--章節(jié)2.2B --> <!-- 縮進(jìn)風(fēng)格--><module name="Indentation"><property name="severity" value="error"/><property name="basicOffset" value="4"/><message key="indentation.error" value="你縮進(jìn)了{(lán)1}個(gè)空格，正確應(yīng)該縮進(jìn) {2}個(gè)空格，違反編碼規(guī)范2.2章節(jié)"/><!-- 子級(jí)縮進(jìn) --><message key="indentation.child.error" value="你縮進(jìn)了{(lán)1}個(gè)空格，正確應(yīng)該縮進(jìn) {2}個(gè)空格，違反編碼規(guī)范2.2章節(jié)"/></module><!--章節(jié)2.3 --><!-- 頁(yè)寬--><module name="LineLength"> <property name="max" value="80"/> <message key="maxLineLen" value="行字符數(shù)超過(guò)80個(gè).違反編碼規(guī)范2.3章節(jié)"/> </module> <!--章節(jié)2.4 --><!--操作符換行策略檢查--><module name="OperatorWrap"><property name="severity" value="error"/><property name="option" value="nl"/><property name="tokens" value="ASSIGN,BAND,BOR,DIV,EQUAL,GE,GT,LAND,LE,LOR,LT,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,STAR,STAR_ASSIGN"/><message key="line.after" value="''{0}'沒(méi)有放在新行之首，違反編碼規(guī)范2.4章節(jié)"/></module> <!--章節(jié)2.6 --><module name="ParenPad"><property name="severity" value="error"/><property name="tokens" value="LPAREN,RPAREN,CTOR_CALL,METHOD_CALL,SUPER_CTOR_CALL"/><message key="ws.followed" value="''{0}'' 后面有空格，違反編碼規(guī)范2.6章節(jié)"/><message key="ws.preceded" value="''{0}''前面有空格，違反編碼規(guī)范2.6章節(jié)"/></module> <module name="TypecastParenPad"><property name="severity" value="error"/><property name="tokens" value="RPAREN,TYPECAST"/><message key="ws.followed" value="''{0}''后面多一個(gè)空格，違反編碼規(guī)范2.6章節(jié)"/><message key="ws.preceded" value="''{0}''前面多一個(gè)空格，違反編碼規(guī)范2.6章節(jié)"/></module> <module name="WhitespaceAfter"><property name="severity" value="error"/><property name="tokens" value="COMMA,SEMI"/><message key="ws.notFollowed" value="''{0}''后面多一個(gè)空格，違反編碼規(guī)范2.6章節(jié)"/></module> <module name="WhitespaceAround"><property name="severity" value="error"/><property name="tokens" value="RCURLY,LITERAL_ASSERT,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE"/><property name="allowEmptyConstructors" value="true"/><property name="allowEmptyMethods" value="true"/><message key="ws.notPreceded" value="''{0}'' 關(guān)鍵字前少一個(gè)空格，違反編碼規(guī)范2.6章節(jié)"/><message key="ws.notFollowed" value="''{0}'' 關(guān)鍵字后少一個(gè)空格，違反編碼規(guī)范2.6章節(jié)"/></module><!--章節(jié)2.7 --><!-- 每行語(yǔ)句數(shù)量--><module name="OneStatementPerLine"><!--模塊的元數(shù)據(jù)類型設(shè)置，經(jīng)過(guò)測(cè)試發(fā)現(xiàn)該標(biāo)簽沒(méi)用--><metadata name="net.sf.eclipsecs.core.comment" value="Coding Problems-> Only one statement per line allowed" /><message key="multiple.statements.line" value="禁止一行有多句代碼，違反編碼規(guī)范2.7章節(jié)" /></module><!--章節(jié)2.8 --><!-- 每行變量聲明數(shù)量--><module name="MultipleVariableDeclarations"> <property name="severity" value="error"/> <message key="multiple.variable.declarations.comma" value="每一個(gè)變量的定義必須在它的聲明處，且在同一行，違反編碼規(guī)范2.8章節(jié)"/> <message key="multiple.variable.declarations" value="每一行只能定義一個(gè)變量，違反編碼規(guī)范2.8章節(jié)"/> </module> <!--章節(jié)2.9.1 --><!-- Checks the placement of right curly braces ('}') for else, try, and catch tokens. The policy to verify is specified using property option. option: 右大括號(hào)是否單獨(dú)一行顯示 tokens: 定義檢查的類型 --> <module name="RightCurly"> <property name="option" value="alone"/> <property name="severity" value="error"/> </module> <!--章節(jié)2.9.1 --> <!-- 檢查左側(cè)大括號(hào) 左側(cè)大括號(hào)必須放在前一行代碼的行尾 --><module name="LeftCurly"><property name="severity" value="error"/><message key="line.previous" value="左側(cè)大括號(hào)沒(méi)有放在前一行代碼的行尾，違反編碼規(guī)范2.9.1章節(jié)"/></module> <!--章節(jié)2.9.2 --><!-- 檢查代碼塊是否缺失大括號(hào)--><module name="NeedBraces"> <message key="needBraces" value="''{0}'' 結(jié)構(gòu)沒(méi)有用大括號(hào) '''{}'''s，違反編碼規(guī)范2.9.2章節(jié)"/> </module> <!-- 章節(jié)3.2 --><!-- 對(duì)文件頭的注釋進(jìn)行檢查 --><!--章節(jié)3.3 --><!--對(duì)類和接口的javadoc注釋進(jìn)行檢查--><module name="JavadocType"><property name="severity" value="error"/><message key="type.missingTag" value="Javadoc 類型的注釋丟失 {0} 標(biāo)簽.違反編碼規(guī)范3.3章節(jié)"/><message key="javadoc.missing" value="缺少 Javadoc 注釋.違反編碼規(guī)范3.3章節(jié)"/><message key="javadoc.unusedTagGeneral" value="未使用過(guò)的 Javadoc 標(biāo)簽.違反編碼規(guī)范3.23章節(jié)"/><message key="javadoc.unusedTag" value="未使用過(guò)的 {0} 標(biāo)簽for ''{1}''.違反編碼規(guī)范3.3章節(jié)"/><message key="type.tagFormat" value="Javadoc 類型標(biāo)簽 {0}必須匹配模式 ''{1}''.違反編碼規(guī)范3.3章節(jié)"/></module><!--章節(jié)3.4，3.7 --> <!--public protect private變量的注釋進(jìn)行檢查--><module name="JavadocVariable"><property name="severity" value="error"/><property name="scope" value="public"/><message key="javadoc.missing" value="變量注釋：缺少Javadoc注釋,違反編碼規(guī)范3.4章節(jié)"/></module> <module name="JavadocVariable"><property name="severity" value="error"/><property name="scope" value="protected"/><message key="javadoc.missing" value="變量注釋：缺少Javadoc注釋,違反編碼規(guī)范3.4章節(jié)"/></module> <module name="JavadocVariable"><property name="severity" value="error"/><message key="javadoc.missing" value="變量注釋：缺少Javadoc注釋,違反編碼規(guī)范3.4章節(jié)"/></module> <!--章節(jié)3.5 --><!-- 檢查所有方法的javadoc，可以不聲明RuntimeException --><module name="JavadocMethod"><property name="allowUndeclaredRTE" value="true"/><!--允許get set 方法沒(méi)有注釋--><property name="allowMissingPropertyJavadoc" value="true"/><message key="javadoc.missing" value="方法注釋：缺少Javadoc注釋，違反編碼規(guī)范3.5章節(jié)"/></module> <!-- 命名規(guī)范 --><!--章節(jié)4.2 --><!-- 包名命名規(guī)范 --><module name="PackageName"> <!-- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> --> <property name="format" value="^org\.neris\.[a-z]+(\.[a-z]+)+$"/> <message key="name.invalidPattern" value="包名 ''{0}'' 不符合org.neris.項(xiàng)目名.模塊名，違反編碼規(guī)范4.2章節(jié)"/> </module> <!--章節(jié)4.3,4.4 --><!-- 類的命名,匹配規(guī)則默認(rèn):(^[A-Z][a-zA-Z0-9]*$),必須以大寫(xiě)字母開(kāi)始 --><module name="TypeName"> <property name="tokens" value="CLASS_DEF"/><message key="name.invalidPattern" value="類名 ''{0}''沒(méi)有通過(guò)大駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述，違反編碼規(guī)范4.3章節(jié)"/> </module> <!-- 接口命名,匹配規(guī)則默認(rèn):(^[A-Z][a-zA-Z0-9]*$),必須以大寫(xiě)字母開(kāi)始 --><module name="TypeName"> <property name="tokens" value="INTERFACE_DEF"/><message key="name.invalidPattern" value="接口名 ''{0}''沒(méi)有通過(guò)大駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述，違反編碼規(guī)范4.3章節(jié)"/> </module><!--章節(jié)4.6 --><!-- 方法名命名 --> <module name="MethodName"> <property name="severity" value="error"/> <property name="format" value="(^[a-z][a-zA-Z0-9]*$)"/> <message key="name.invalidPattern" value="方法名 ''{0}''沒(méi)有通過(guò)小駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述.違反編碼規(guī)范4.6章節(jié)"/> </module> <!--章節(jié)4.7 --><!-- 局部變量命名 --><module name="LocalVariableName"> <property name="format" value="(^[a-z][a-zA-Z0-9]*$)"/> <message key="name.invalidPattern" value="變量名 ''{0}''沒(méi)有通過(guò)小駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述.違反編碼規(guī)范4.7章節(jié)"/> </module> <!-- 局部的final變量，包括catch中的參數(shù)的檢查 --> <module name="LocalFinalVariableName" > <property name="severity" value="error"/><message key="name.invalidPattern" value="變量名 ''{0}''沒(méi)有通過(guò)小駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述.違反編碼規(guī)范4.7章節(jié)"/></module><!-- 變量命名 --><module name="MemberName"> <message key="name.invalidPattern" value="變量名 ''{0}''沒(méi)有通過(guò)小駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述.違反編碼規(guī)范4.7章節(jié)"/> </module> <!-- 靜態(tài)變量命名 --><module name="StaticVariableName"><message key="name.invalidPattern" value="變量名 ''{0}''沒(méi)有通過(guò)小駝峰命名法命名，具體名稱應(yīng)使用意義完整的英文描述.違反編碼規(guī)范4.7章節(jié)"/></module><!-- 數(shù)組變量命名 --><module name="ArrayTypeStyle"><property name="severity" value="error"/><message key="array.type.style" value="數(shù)組定義沒(méi)有采取int[] index這種方式，違反編碼規(guī)范4.7.2章節(jié)"/></module> <!--章節(jié)4.8 --><!-- 常量命名--><module name="ConstantName"><property name="severity" value="error"/><message key="name.invalidPattern" value="常量 ''{0}'' 常量名違反編碼規(guī)范4.8章節(jié)."/></module><!--章節(jié)5.1 --><!-- import語(yǔ)句不使用通配符 --><module name="AvoidStarImport"><property name="severity" value="error"/><message key="import.avoidStar" value="引用包時(shí)不能使用*號(hào).違反編碼規(guī)范5.1章節(jié)"/></module> <!--章節(jié)5.2 --><!-- 魔法數(shù)檢測(cè)--><module name="MagicNumber"> <property name="severity" value="error"/> <message key="magic.number" value="''{0}'' 是一個(gè)魔法數(shù)(即常數(shù)).違反編碼規(guī)范5.2章節(jié)"/> </module><!--章節(jié)5.4 --><!-- 多余的關(guān)鍵字，包含不適用this作為關(guān)鍵字 --> <module name="RedundantModifier"> <message key="redundantModifier" value="''{0}'' 多余的修飾符.違反編碼規(guī)范5.4章節(jié)"/> </module> <!--章節(jié)5.5 --><!-- 重載父類方法 --><module name="MissingOverride"> <message key="annotation.missing.override" value="重載方法缺少@Override，違反編碼規(guī)范5.5章節(jié)" /><message key="tag.not.valid.on" value="注釋-> Javadoc {0}標(biāo)簽在這個(gè)位置是無(wú)效的." /></module> <!--章節(jié)5.6 --><!--判斷語(yǔ)句使用 --><module name="SimplifyBooleanExpression"><property name="severity" value="error"/><message key="simplify.expression" value="存在布爾冗余，違法編碼規(guī)范5.6章節(jié)."/></module><!--章節(jié)5.7 --><!-- 檢查switch語(yǔ)句是否忘記了default標(biāo)簽 --><module name="MissingSwitchDefault" ><property name="severity" value="error"/><message key="missing.switch.default" value="switch 語(yǔ)句后邊沒(méi)有 default 語(yǔ)句.違法編碼規(guī)范5.7章節(jié)"/></module><!-- 檢查switch語(yǔ)句中default標(biāo)簽的順序 --><module name="DefaultComesLast"><property name="severity" value="error"/><message key="default.comes.last" value="建議Default 放在 switch 語(yǔ)句的最后."/></module> <!--章節(jié)5.9 --><!-- 禁止使用System.out.println --><module name="Regexp"><property name="format" value="System\.out\.println"/> <property name="message" value="不要使用 System.out 與 System.out 進(jìn)行控制臺(tái)打印，應(yīng)該使用日志工具類(如：log4j)進(jìn)行統(tǒng)一記錄或者打印，違法編碼規(guī)范5.9章節(jié)"/> <property name="illegalPattern" value="true"/></module><!-- 禁止使用System.err.println --><module name="Regexp"><property name="format" value="System\.err\.println"/> <property name="message" value="不要使用 System.out 與 System.err 進(jìn)行控制臺(tái)打印，應(yīng)該使用日志工具類(如：log4j)進(jìn)行統(tǒng)一記錄或者打印，違法編碼規(guī)范5.9章節(jié)"/> <property name="illegalPattern" value="true"/></module> <!--章節(jié)5.10 --><!-- 不允許用main方法測(cè)試--><module name="UncommentedMain"></module><!--章節(jié)5.11 --><!-- NeedBraces 檢查是否應(yīng)該使用括號(hào)的地方?jīng)]有加括號(hào) tokens: 定義檢查的類型 --> <module name="NeedBraces"/> </module> </module>三：安裝好eclipse的checkstyle插件后，你就可以把checkstyle.xml文件添加進(jìn)去，如何添加，網(wǎng)上有很多文檔
總結(jié)
以上是生活随笔為你收集整理的Eclipse中使用Checkstyle,checkstyle插件检查java代码的自定义配置文件：的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇： Java 代码性能优化
- 下一篇： 密码判断