當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

玩转Eclipse — 自动代码规范检查工具Checkstyle

發布時間：2025/3/21 编程问答 44 豆豆

生活随笔收集整理的這篇文章主要介紹了玩转Eclipse — 自动代码规范检查工具Checkstyle 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

大項目都需要小組中的多人共同完成，但是每個人都有自己的編碼習慣，甚至很多都是不正確的。那么如何使小組所有開發人員都遵循某些編碼規范，以保證項目代碼風格的一致性呢？如果硬性地要求每個開發人員在提交代碼之前，都要對照的編碼規范將自己的代碼檢查一遍，將是一個非常枯燥而且耗時的任務。Checkstyle是一個開源代碼分析工具，能夠幫助開發人員保證他們的代碼遵循一定的代碼規范。Checkstyle通過不斷地檢查你的代碼，一旦發現有違反定義的代碼規范的地方就立馬提示，以便開發人員能夠及時發現和修改不規范代碼。Checkstyle在Eclipse中的插件是eclipse-cs。

1. 安裝Checkstyle插件

? ? ? ??Eclipse菜單欄上選擇?Help -> Install New Software...，進入如下安裝界面：

? ? ? ??點擊“Add...”打開Add Repository對話框，如圖輸入Name和Location，點擊“OK”。
? ? ? ??選擇剛剛添加的JAutodoc，一直點擊“Next >”直到安裝結束。

2. 配置Checkstyle

? ? ? ??Eclipse菜單欄上選擇?Window -> Preferences -> Checkstyle，進入如下設置界面：

? ? ? ??在Global Check Configurations框中，列出可以選擇的檢查配置（Check Configuration），Default欄標記為對勾的默認配置。

? ? ? ??如果想自己配置檢查選擇，可以點擊“New...”按鈕新建一個配置，進入如下Check Configuration界面：

? ? ? ??檢查配置的類型，可以有多種選擇。Internal Configuration類型是檢查配置存在于Eclipse內部；External Configuration類型相當于導入一個已有的xml配置文件。Checkstyle配置都是xml文件。

? ? ? ??如果想修改已有的配置，可以點擊“Configure...”按鈕，打開Checkstyle Configuration對話框，根據需要進行修改。

3. 使用Checkstyle

? ? ? ??Checkstyle會在代碼開發過程中，不斷地檢查代碼規范，一般檢查的內容包括：

Javadoc注釋
命名約定
標題
Import
大小
空白
修飾符
代碼
類設計

? ? ? ??下面這段代碼經過Checkstyle檢查之后，不符合規范的代碼，底色都會被標記為淺黃色進行提示。點擊行頭的提示標記，就會顯示具體不符合規范的地方。示例如下圖所示：

Reference

? ? ? ??Checkstyle官網

? ? ? ??Checkstyle的Eclipse插件官網

為便于規范各位開發人員代碼、提高代碼質量，研發中心需要啟動代碼評審機制。為了加快代碼評審的速度，減少不必要的時間，可以加入一些代碼評審的靜態檢查工具，另外需要為研發中心配置統一的編碼模板和代碼格式化模板。

????? Java代碼規范、格式化和checkstyle檢查配置文檔下載地址：http://www.blogjava.net/Files/amigoxie/Java代碼規范、格式化和checkstyle檢查配置文檔.rar

1、配置統一的編碼模板

1.1 配置編碼模板

??在Eclipse或MyEclipse中點擊Window -> Preferences菜單，點擊左側的“Java”->“Code Style”->“Code Templates”，界面如下圖所示：??
???

???????? 點擊上圖右側的“Import”按鈕，在彈出的文件選擇窗口選擇公司自己的編碼模板，例如eclipse_templates.xml文件（僅提供參考，可自行修改）。在“Configure generated code and comments”區域有“Comments”和“Code”兩個菜單，點開后可以看到各種類型的注釋和編碼模板定義：
??????
???????

???????? 可以點擊上面的各種類型查看該模板文件的定義。

例如文件注釋定義：
????

文件注釋定義中的文件作者取自所在系統登錄用戶，若不正確時，可點擊“Edit”按鈕后進行修改。

選擇編碼模板文件完成后點擊下方的“Apply”按鈕應用該模板文件，而后點擊“OK”按鈕完成設置。

1.2 使用編碼模板

1.2.1 創建類時自動添加注釋

???????? 在創建類時，勾選如下頁面的“Generate comments”選項，將會使新創建的類具有文件注釋和類注釋：?????
??????

???????? 生成的類的內容參考如下：

/*
?*?XX公司源代碼，版權歸XX公司所有。
?*?
?*?項目名稱?:?XXXXXXX
?*?創建日期?:?May?9,?2014
?*?修改歷史?:?
?*?????1.?[May?9,?2014]創建文件?by?Xingxing,Xie
?*/
package?cn.amigo.eip.common;
/**
?*?//TODO?添加類/接口功能描述
?*?@author?Xingxing,Xie
?*/
public?class?CommentTest?{
?
????/**
?????*?//TODO?添加方法功能描述
?????*?@param?args
?????*/
????public?static?void?main(String[]?args)?{
????????//?TODO?Auto-generated?method?stub
????}
}

1.2.2 對已有類添加注釋

???????? 對已有的類、方法添加注釋的方法：

?? 1）?選擇類的類名、方法名所在的行后，使用“ALT + SHIFT + J”快捷鍵；

?? 2）?在所在類或方法上輸入“/**”后按Enter鍵。

2、配置統一的代碼格式化模板

2.1 配置代碼格式化模板

在Eclipse或MyEclipse中點擊Window -> Preferences菜單，點擊左側的“Java”->“Code Style”->“Formatter”，界面如下圖所示：???
??????

點擊上圖的“Import”按鈕，彈出格式化模板文件選擇框，選擇代碼格式化文件，例如eclipse_formatter-profile.xml文件（僅提供參考，可自行定義）。點擊下方的“Apply”按鈕應用該模板文件，而后點擊“OK”按鈕完成設置。

在格式化文件中定義了很多Java格式化規范，例如：

上行用于設置格式化時在一行達到150個字符（包括空格）時需要換行。

又如：

上行表示格式化時使用4個空格代替tab鍵。

有興趣的人可以查看《eip_eclipse_formatter-profile.xml》文件的內容。

2.2 配置使用4個空格代替tab鍵

tab鍵在不同的IDE、編輯器（例如EditPlus、UltraEdit等）中使用的空格數不同，因此為了統一，開發人員統一使用4個空格代替tab鍵（checkstyle會配置做相應檢查）。

在Eclipse或MyEclipse中點擊Window -> Preferences菜單，點擊左側的“General”->“Editors”->“Text Editors”，界面如下圖所示：?
?????

???????? 在上圖中勾選“Insert spaces for tabs”（使用空格代替tab鍵），并設置“Displayed tab width”為4（即使用4個空格代替tab鍵）。

2.3 去掉對代碼注釋的格式化

???????? 在使用“2.4 使用模板進行格式化”進行代碼格式化時，會將代碼注釋也進行格式化，引起格式錯亂，為避免其對注釋進行格式化，采用的方法為：點擊“Java”->“Code Style”-> “Formatter”菜單，在右側選中模板后點擊“Edit”按鈕，在彈出的界面中選擇“Comments”的tab，如下圖所示：
??????

???????? 在上圖中對紅色區域的復選框取消勾選。

2.4 使用模板進行格式化

???????? 若要對某個文件進行格式化，可使用如下幾種方法：

1）?打開文件后，在代碼區域采用“CTRL + SHIFT + F”快捷鍵；

2）?打開文件后，在代碼區域點擊右鍵選擇“Source”->“Format”功能。

??? 【說明】建議采用“CTRL + Shift + F”快捷鍵。

3、配置checkstyle插件進行代碼檢查

3.1 安裝Eclipse的checkstyle插件

可以從sourceforge網站下載插件，網址如下：

http://sourceforge.net/projects/eclipse-cs/files/Eclipse%20Checkstyle%20Plug-in/

???????? 該頁面有3.3.1 ～ 5.7.0版本的checkstyle插件，因為5.0以上版本的checkstyle插件在筆者的MyEclipse 6.5版本上無法使用，所以下載的4.4.2版本，高版本的MyEclipse可嘗試新版本的checkstyle試試是否能成功使用。

安裝checkstyle插件的方法主要有如下三種：

一、在Eclipse下使用link方式鏈接插件

在某個目錄（eg. D:\Program Files (x86)\externalplugins）創建checkstyle\eclipse子目錄，將之前下載的插件下的features和plugins兩個文件下拷貝到該目錄下（eg: D:\Program Files (x86)\externalplugins\checkstyle\eclipse）。

接著在eclipse的links目錄下新建checkstyle.xml文件，在該文件中添加一行寫上需要鏈接的插件地址，例如：path=D:/Program Files (x86)/externalplugins/checkstyle。

【說明】此種方式便于管理外部Eclipse插件。

二、下載checkstyle插件文件夾后拷貝到Eclipse的和features和plugins目錄

此種方式將下載的checkstyle插件的features目錄下的內容拷貝到Eclipse下的features目錄，將將下載的checkstyle插件的plugins目錄下的內容拷貝到Eclipse下的plugins目錄。

三、使用 “Software Updates”->“Find and install”指定網址安裝插件。

點擊Eclipse或MyEclipse的“Help”->“Software Updates”->“Find and Install”，在彈出的窗口中選擇“Search for new features to install”單選框，接著在“Update sites to visit”窗口點擊“New Remote Site”按鈕，在該窗口輸入插件名稱和插件下載地址后點擊“OK”按鈕完成下載。

3.2 設置checkstyle配置文件

???????? Checkstyle插件安裝完成后，需要配置研發中心的checkstyle配置文件，配置文件參考《eclipse_checkstyle.xml》文件，該文件定義了研發中心需要用到的一些檢查規則。檢查項都加了注釋，具體內容請參見附錄。

???????? 點擊“Window”->“Preferences”菜單，在彈出窗口左側點擊“Checkstyle”，可看到右側默認選中的是“Sun Checks”檢查規則，因為該規則要求比較嚴格，而且不適合本研發中心，所以需要自定義檢查文件。

???????? 點擊“New”按鈕后，彈出“Check Configuration Properties”窗口，如下圖所示：
??????????

???????? 在上圖中選擇“Type”為“External Configuration File”（外部配置文件），在“Location”行點擊“Browse”按鈕瀏覽選擇checkstyle的配置文件，例如eclipse_checkstyle.xml文件（僅供參考，可自行定義），并輸入“Name”行的值，例如“eclipse_checkstyle”，點擊“OK”按鈕完成導入操作。回到Checkstyle主頁面選擇剛才添加的文件，點擊“Set As Default”將其設置為默認checkstyle檢查文件。

3.3 使用checkstyle

???????? 選擇某個項目，點擊右鍵選擇“Checkstyle”，會出現如下菜單：

?? 1）?Configure project(s) from blueprint：指定工程加入Checkstyle檢查；

?? 2）?Activate Checkstyle：激活Checkstyle；

?? 3）?Deactivate Checkstyle：取消激活Checkstyle；

???4）?Check code with Checkstyle：使用Checkstyle檢查代碼；

?? 5）?Clear Checkstyle violations：去掉Checkstyle的檢查提示。

??選擇“Check code with Checkstyle”對所選中的項目進行檢查，檢查后對有問題的類會使用警告或錯誤標識。參考提示信息如下：???
?? ???

???????? 左側會顯示小圓圈，將鼠標移動到上面時將給出提示信息。

???????? 使用checkstyle后，注釋、變量命名規范性、類中變量、構造函數、方法的順序的檢查、行的長度、文件的長度、方法的長度等都不需要手工進行檢查，只需要在代碼評審時使用Checkstyle檢查即可。因此，讓代碼評審人員將側重點放在checkstyle檢查不出來的一些代碼的優化問題。

3.4 checkstyle常見提示速查

???????? Checkstyle常見錯誤和警告提示見下表所示：

錯誤提示	錯誤說明
missing a javadoc comment	缺少類注釋
Line longer than X characters	行長度超過X個字符(包括空格)
Return count is X(max allowed 3)	一個方法內的返回數量是X(最大值只能為3)
Nested if-else depth is X(max allowed is 3)	最大的if-else嵌套層數為X(最大只能為3)
Array brackets at illegal position	數組的方括號“[]”的位置不正確（檢查數組類型的定義是String[] args，而不是String args[]）
Line matchs the illegal pattern 'System\.out\.println'	本行包含System.out.println語句
ctor def modifier at indentation level 8 not at corrent indentation 4	縮進不正確，一般是因為沒有在Eclipse中使用4個空格代替tab鍵引起。
'static' modifier out of order with the JLS suggestions	static修飾符沒有按照JLS的建議來排序(eg.寫成public final static...應該改成public static final)
Name 'X' must match pattern '^[A-Z][A-Z0-9][_A-Z0-9+]$'(正則表達式)	名稱不符合正則表達式'^[A-Z][A-Z0-9][_A-Z0-9+]$'(即為大寫字母，數字、下劃線等)。一般在靜態變量沒有大寫時提示，包名不是全部消息時提示，類名不是大寫開頭時提示，方法名不是小寫開頭時提示
Variable access definition in wrong order	變量定義順序不正確(例如在類成員變量定義時，將private類型的變量定義在public類型的變量之前)
Static variable definition in wrong order	靜態變量定義順序不正確(例如在構造函數之后定義靜態變量)
Instance variable definition in wrong order	成員變量定義順序不正確(例如在構造函數之后定義成員變量)
X is a magic number	X是一個魔術數字(非0、1、2的數字)
if construct must use '{}'	if結構必須使用'{}'
Got an exception - Unexpected character 0xfffd in identifier	因為沒有設置checkstyle配置文件的charset為UTF-8，而類文件使用UTF-8編碼，并且含有中文
“{” should be on the previous line	“{” 應該位于前一行
Methods is missing a javadoc comment	方法前面缺少javadoc注釋
Expected @throws tag for “Exception”	在注釋中希望有@throws的說明
“.” Is preceeded with whitespace	“.” 前面不能有空格
“.” Is followed by whitespace	“.” 后面不能有空格
“=” is not preceeded with whitespace“=”	前面缺少空格
“=” is not followed with whitespace	“=” 后面缺少空格
“}” should be on the same line	“}” 應該與下條語句位于同一行
Unused @param tag for “unused”	沒有參數“unused”，不需注釋
Variable “X” missing javadoc	變量“CA”缺少javadoc注釋
Line contains a tab character	行含有”tab” 字符
Redundant “Public” modifier	冗余的“public” modifier
final modifier out of order with the JSL suggestion	final修飾符的順序錯誤
Avoid using the “.*” form of import	Import格式避免使用“.*”
Redundant import from the same package	從同一個包中Import內容
Unused import-X?Import	import的X類沒有被使用
Duplicate import to line X	重復Import同一個內容
Import from illegal package	從非法包中 Import內容
“while” construct must use “{}”	“while” 語句缺少“{}”
Variable “X” must be private and have accessor method	變量“X”應該是private的，并且有調用它的方法
Variable “X” must match pattern “^[a-z][a-zA-Z0-9]*$”	變量“X”不符合命名規則“^[a-z][a-zA-Z0-9]*$”
“(” is followed by whitespace	“(” 后面不能有空格
“)” is proceeded by whitespace	“)” 前面不能有空格

4、附錄

4.1 eclipse_checkstyle.xml文件內容

???????? Checkstyle配置文件eclipse_checkstyle如下所示：

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

<module?name="Checker">
?????????<property?name="severity"?value="warning"/>
????<module?name="StrictDuplicateCode">
????????<property?name="charset"?value="utf-8"?/>???
????</module>???

????<module?name="TreeWalker">???
???????????
???????????
????????<module?name="JavadocType"?/>???

???????????
???????????
????????<module?name="LocalFinalVariableName"?/>???
???????????
????????<module?name="LocalVariableName"?/>???
???????????
????????<module?name="PackageName">???
????????????<property?name="format"?value="^[a-z]+(\.[a-z][a-z0-9]*)*$"?/>???
????????</module>???
???????????
????????<module?name="StaticVariableName"?/>???
???????????
????????<module?name="TypeName"?/>???
???????????
????????<module?name="MemberName"?/>???
???????????
????????<module?name="MethodName"?/>???
???????????
????????<module?name="ParameterName?"?/>???
???????????
????????<module?name="ConstantName"?/>
???????????
????????<module?name="UnusedImports"?/>???

???????????
???????????
????????<module?name="FileLength">???
????????????<property?name="max"?value="1500"?/>???
????????</module>???
???????????
????????<module?name="LineLength">???
????????????<property?name="max"?value="150"?/>???
????????</module>???
???????????
????????<module?name="MethodLength">???
????????????<property?name="tokens"?value="METHOD_DEF"?/>???
????????????<property?name="max"?value="150"?/>???
????????</module>???
???????????
????????<module?name="ParameterNumber">???
????????????<property?name="max"?value="5"?/>???
????????????<property?name="tokens"?value="METHOD_DEF"?/>???
????????</module>???

???????????
???????????
????????<module?name="MethodParamPad"?/>???
???????????
????????<module?name="TypecastParenPad"?/>

???????????
???????????
????????<module?name="ModifierOrder"?/>???
???????????
????????<module?name="RedundantModifier"?/>???

???????????
???????????
????????<module?name="EmptyBlock"?/>???
???????????
????????<module?name="NeedBraces"?/>
???????????
????????<module?name="AvoidNestedBlocks">???
????????????<property?name="allowInSwitchCase"?value="true"?/>???
????????</module>???

???????????
???????????
????????<module?name="EmptyStatement"?/>?
???????????
????????<module?name="MagicNumber">???
????????????<property?name="tokens"?value="NUM_DOUBLE,?NUM_INT"?/>???
????????</module>
???????????
????????<module?name="RedundantThrows"?/>?
???????????
????????<module?name="StringLiteralEquality"?/>???
???????????
????????<module?name="NestedIfDepth">???
????????????<property?name="max"?value="3"?/>???
????????</module>???
???????????
????????<module?name="NestedTryDepth">???
????????????<property?name="max"?value="2"?/>???
????????</module>???
???????????
????????<module?name="SuperClone"?/>???
???????????
????????<module?name="SuperFinalize"?/>???
???????????
????????<module?name="IllegalCatch">???
????????????<property?name="illegalClassNames"?value="java.lang.Exception"?/>??
????????</module>???
???????????
????????<module?name="PackageDeclaration"?/>???
???????????
????????<module?name="ReturnCount">???
????????????<property?name="max"?value="3"?/>???
????????????<property?name="format"?value="^$"?/>???
????????</module>???
???????????
????????<module?name="DeclarationOrder"?/>?
???????????
????????<module?name="MultipleVariableDeclarations"?/>???
???????????
????????<module?name="UnnecessaryParentheses"?/>????

???????????
???????????
????????<module?name="GenericIllegalRegexp">???
????????????<property?name="format"?value="System\.out\.println"?/>???
????????????<property?name="ignoreComments"?value="true"?/>
????????</module>
???????????
????????<module?name="UpperEll"?/>???
???????????
????????<module?name="ArrayTypeStyle"?/>
???????????
????????<module?name="Indentation"?/>???
????</module>?
</module>????????

checkStyle結果分析

參考：http://commons.apache.org/jelly/libs/http/checkstyle-report.html

1.Missing a Javadoc comment:缺少JavaDoc注釋
2.First sentence should end with a period:你的注釋的第一行文字結束應該加上一個"."
3.Expected @throws tag for 'Exception':在注釋中希望有@throws的說明,在方法前得注釋中添加這樣一行：* @throws Exception if has error(異常說明)
4.Parameter docType should be final:參數docType應該為final類型解決方法：在參數docType前面加個final
5.Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”變量“ABC”不符合命名規則“^[a-z][a-zA-Z0-9]*$”解決方法：把這個命名改成符合規則的命名 “aBC”
6.Utility classes should not have a public or default constructor. 接口中的內部類中不應該有公共的或者默認的構造方法
解決方法：在內部類中，定義一個私有的構造方法，然后內部類聲明為final類型。如果前面有static，那么final還必須放在static之后
7.'{' is not preceded with whitespace.大括號后面必須空一格

8.'public' modifier out of order with the JLS suggestions. public順序錯誤

9.Method 'deleteChild' is not designed for extension - needs to be abstract, final or empty. 不是拓展或繼承的方法，必須指定abstract,final或空

1Type is missing a javadoc commentClass 缺少類型說明

2“{” should be on the previous line“{” 應該位于前一行。解決方法：把“{”放到上一行去

3Methos is missing a javadoc comment 方法前面缺少javadoc注釋。解決方法：添加javadoc注釋類似這樣：

/**

* set default mock parameter.（方法說明）

* @param additionalParameters parameter additional(參數名稱)

* @return data manager(返回值說明)

* @throws Exception if has error(異常說明)

4 Expected @throws tag for “Exception”在注釋中希望有@throws的說明

解決方法：在方法前得注釋中添加這樣一行：* @throws Exception if has error(異常說明)

5“.” Is preceeded with whitespace “.” 前面不能有空格。解決方法：把“（”前面的空格去掉

6“.” Is followed by whitespace“.” 后面不能有空格。解決方法：把“）”后面的空格去掉

7“=” is not preceeded with whitespace“=” 前面缺少空格。解決方法：在“=”前面加個空格

8“=” is not followed with whitespace“=” 后面缺少空格。解決方法：在“=”后面加個空格

9“}” should be on the same line“}” 應該與下條語句位于同一行。解決方法：把“}”放到下一行的前面

10Unused @param tag for “unused”沒有參數“unused”，不需注釋

解決方法：“* @param unused parameter additional(參數名稱)” 把這行unused參數的注釋去掉“

11Variable “CA” missing javadoc變量“CA”缺少javadoc注釋

解決方法：在“CA“變量前添加javadoc注釋：/** CA. */（注意：一定記得加上“.”）

12Line longer than 80characters行長度超過80 。解決方法：把它分成多行寫。必要時候，可以ctrl+shift+f

13Line contains a tab character行含有”tab” 字符。快速解決方法：可以使用editplus中的format功能，把tab字符轉化為空格，然后保存Editplus英文版安裝文件在我機子上有。需要的可以來拷貝。注冊Editplus，點擊安裝文件中注冊的文件

14Redundant “Public” modifier冗余的“public” modifier 。解決方法：冗余的“public”

15Final modifier out of order with the JSL suggestion Final modifier的順序錯誤

16Avoid using the “.*” form of importImport格式避免使用“.*”

17Redundant import from the same package從同一個包中Import內容

18Unused import-Java.util.listImport進來的Java.util.list沒有被使用。解決方法：去掉導入的多余的類

19Duplicate import to line 13重復Import同一個內容解決方法：去掉導入的多余的類

20Import from illegal package從非法包中 Import內容

21“while” construct must use “{}” “while” 語句缺少“{}”

22Variable “sTest1” must be private and have accessor method變量“sTest1”應該是private的，并且有調用它的方法

23Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”變量“ABC”不符合命名規則“^[a-z][a-zA-Z0-9]*$”解決方法：把這個命名改成符合規則的命名 “aBC”

24“(” is followed by whitespace“(” 后面不能有空格 25“)”is proceeded by whitespace“)” 前面不能有空格

解決方法：把前面或者后面的空格去掉

25、First sentence should end with a period.解決方法：你的注釋的第一行文字結束應該加上一個"."。

26、Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 'NameNotFoundException '是'NamingException'的子類重復拋出異常。

解決方法：如果拋出兩個異常，一個異常類是另一個的子類，那么只需要寫父類

去掉NameNotFoundException異常，對應的javadoc注釋異常注釋說明也需要去掉

27、Parameter docType should be final. 參數docType應該為final類型解決方法：在參數docType前面加個final

28、Line has trailing spaces. 多余的空行解決方法：去掉這行空行

29.Must have at least one statement. 至少一個聲明

解決方法：} catch (NumberFormatException nfe) {

LOG.error("Auto Renews the agreement failed", nfe);//異常捕捉里面不能為空，在異常里面加一句話。如打印等等

30、'>' is not followed by whitespace.并且又有 '(' is preceded with whitespace.

定義集合和枚舉的時候的時候，最后一個“>”后面要有空格，“（”前面不容許有空格。解決方法：去掉泛型

31、Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag 'SystemException'.原因：不合理的throws。

解決方法：要確保某些類型，如某些類、接口不被throws。把聲明的異常去掉。在實現類中拋出異常

網上參考解決方法：1、這是CheckStyle報的錯。通常需要Refreh, clean/build這個Project. 如果不行，可以嘗試clean all projects, restart Eclipse.

2、因為編譯好的類沒有在checkstyle的classpath中.所以, 只要將編譯好的class配置到在<checkstyle/>的classpath中就沒有這個問題了.另外, 還發現checkstyle的line length好像也有點問題, 明明沒有超過120個字符, 卻還是報錯.無奈, 我把Eclipse中java > code style > formatter中的Maximum line with改成了100, 然后format一下, 基本就沒有問題了

32、File does not end with a newline.解決方法：刪掉報錯的類，新建一個同名的類，把代碼全部復制過去

33、Utility classes should not have a public or default constructor. 接口中的內部類中不應該有公共的或者默認的構造方法

解決方法：在內部類中，定義一個私有的構造方法，然后內部類聲明為final類型。如果前面有static，那么final還必須放在static之后

34、Variable 'functionCode' must be private and have accessor methods.變量要改成private然后提供訪問的方法

解決方法：給這些變量的修飾符改成private，然后提供set，get方法，并加上對應的方法javadoc注釋、參數注釋。并在返回值和參數類型前添加final。并把調用了這個變量的地方改成通過方法訪問

35. 'X' hides a field.

public class Foo
{
private int bar;

public Foo(int bar)
{
this.bar = bar;
}

public final int getBar()
{
return bar;
}
}

全局private int bar;和局部public Foo(int bar)的bar變量名字重復。
解決方法：把方法里面的參數名稱改變下就可以了public Foo(int newBar)
{
this.bar = newBar;
}。

36、Got an exception - Unexpected character 0xfffd in identifier

這是因為CheckStyle不能識別制定的編碼格式。

網上參考解決方法：

1、Eclipse中可以配置，在Other-->checker中可以指定

2、可以修改checkstyle配置文件：

如果是UTF-8的話，就添加加粗的那條語句，就可以了。

37、 Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag *whatever*.
網上參考解決方法：選中CheckSytle的JavaDoc --> Method JavaDoc --> logLoadErrors。如果是CheckStyle自己加載時出錯的，打個Log就可以了，不要整出Errors嚇人。
還有一處也可能包出同樣的錯誤。Coding Problems --> Redundant Throws --> logLoadErrors選中即可

38、Expected @param tag for 'dataManager'. 缺少dataManager參數的注釋解決方法：在注釋中添加@param dataManager DataManager

網上一些其他錯誤的解答：
1. Parameter X should be final.
public class Foo
{
private int bar;

public Foo(int bar)
{
this.bar = bar;
}

public final int getBar()
{
return bar;
}
}

解釋：public Foo(int bar)的局部變量，被認為是不可改變的，檢查需要加上final關鍵字定義public Foo(final int bar)此錯誤，可以忽略不檢查。

2. Redundant 'X' modifier.

public interface CacheHRTreeService extends Manager {

/**
* Organization Tree
* @param orgDto
* @return
* @throws Exception
*/
public void setOrganization(OrganizationDTO orgDto) throws Exception;

/**
* Organization Tree
* @return
* @throws Exception
*/
public OrganizationDTO getOrganization() throws Exception;
......
}

解釋：多余的字段。public OrganizationDTO getOrganization() throws Exception;此時public為多余的字段，因為interface定義的時候，就是public的。

需要檢查。

3. - Class X should be declared as final.

解釋：對于單例設計模式，要求返回唯一的類對象。但是HRFactory和ContextFactory為優化的兩個類，不需求檢查。
其他的單例類，依然需要進行檢查。

4. - Method 'addChildrenId' is not designed for extension - needs to be
abstract, final or empty.

解釋：通過父類繼承的，此類有點特殊可以忽略此類。

5. Variable 'id' must be private and have accessor methods.解釋：BaseHRDTO類，為父類，屬性給子類繼承，比較特殊。但是其他的類，聲名需要加上范圍'private'關鍵字。需要檢查。

6. -Array brackets at illegal position.解釋：代碼寫法，習慣不一樣。需要檢查，僅僅提示

from:?http://blog.csdn.net/gtuu0123/article/details/4891833

http://blog.csdn.net/hotdust/article/details/52205867

http://blog.csdn.net/hotdust/article/details/52205855

總結

以上是生活随笔為你收集整理的玩转Eclipse — 自动代码规范检查工具Checkstyle的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： Eclipse中的checkstyle插
下一篇：正确认识Arrays.asList方法