• 介紹

  CheckStyle是SourceForge下的一個項目，提供了一個幫助JAVA開發人員遵守某些編碼規范的工具。它能夠自動化代碼規范檢查過程，從而使得開發人員從這項重要，但是枯燥的任務中解脫出來。

  現在就來看看CheckStyle，從安裝、checkstyle規范的編寫及配置。

• 安裝CheckStyle插件

  要使用 checkstyle 需要安裝一個 插件 CheckStyle-IDEA,可以通過在線安裝插件的方式去安裝,如下圖：?

• 配置 checkstyle 文件

  當安裝好插件，打開 IDEA的設置頁面 settings -> Other Settings 你會發現默認的 Checkstyle , 勾選就OK了,如下圖。

  其實在還可以點擊上面綠色加號添加自定義checkstyle文件，該文件放在項目的根目錄。在里面可以設置你想要的格式，如第一次跟我一樣不會寫的這里有個華為 CheckStyle文件自己可以去看。

  如果不想向上面那樣每次手動的去添加加載的話，可以用代碼來加載，可以在項目的.idea文件中添加checkstyle-idea.xml和codesStyleSettings.xml兩個文件：

• checkstyle-idea.xml

<?xml version="1.0" encoding="UTF-8"?> <project version="4"><component name="CheckStyle-IDEA"><option name="configuration"><map><entry key="active-configuration" value="PROJECT_RELATIVE:$PRJ_DIR$/checkstyle.xml:Google Checkstyle rules" /><entry key="checkstyle-version" value="7.7" /><entry key="location-0" value="PROJECT_RELATIVE:$PRJ_DIR$/checkstyle.xml:Google Checkstyle rules" /><entry key="location-1" value="CLASSPATH:/sun_checks.xml:The default Checkstyle rules" /><entry key="scan-before-checkin" value="false" /><entry key="scanscope" value="JavaOnly" /><entry key="suppress-errors" value="false" /><entry key="thirdparty-classpath" value="" /></map></option></component> </project>

• codesStyleSettings.xml

<?xml version="1.0" encoding="UTF-8"?> <project version="4"><component name="ProjectCodeStyleSettingsManager"><option name="PER_PROJECT_SETTINGS"><value><option name="IMPORT_LAYOUT_TABLE"><value><package name="java" withSubpackages="true" static="false" /><package name="javax" withSubpackages="true" static="false" /><emptyLine /><package name="" withSubpackages="true" static="false" /><emptyLine /><package name="" withSubpackages="true" static="true" /></value></option><codeStyleSettings language="JAVA"><option name="RIGHT_MARGIN" value="120" /><option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" /><option name="SPACE_BEFORE_ANNOTATION_ARRAY_INITIALIZER_LBRACE" value="true" /><option name="IF_BRACE_FORCE" value="3" /><option name="DOWHILE_BRACE_FORCE" value="3" /><option name="WHILE_BRACE_FORCE" value="3" /><option name="FOR_BRACE_FORCE" value="3" /><indentOptions><option name="INDENT_SIZE" value="2" /><option name="CONTINUATION_INDENT_SIZE" value="4" /><option name="TAB_SIZE" value="2" /></indentOptions></codeStyleSettings></value></option><option name="USE_PER_PROJECT_SETTINGS" value="true" /></component> </project>

自定義的checkstyle還需要在Maven pom.xml中配置就OK了，如下圖：

• pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion>......<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-checkstyle-plugin</artifactId><version>2.17</version><configuration><configLocation>checkstyle.xml</configLocation><encoding>UTF-8</encoding><consoleOutput>true</consoleOutput><failsOnError>true</failsOnError><violationSeverity>warning</violationSeverity></configuration><dependencies><dependency><groupId>com.puppycrawl.tools</groupId><artifactId>checkstyle</artifactId><version>7.8</version></dependency></dependencies></plugin>......</plugins></build> </project>

?

到此，基本的配置就完畢了。現在 IDEA的控制面板會多一個 CheckStyle，你可以在這里方便的進行代碼檢查。可以點擊面板的左上角下拉框 Rules 去動態切換不同的 checkstyle。

?

轉載于:https://www.cnblogs.com/chenglc/p/8487654.html

總結

以上是生活随笔為你收集整理的CheckStyle的全部內容，希望文章能夠幫你解決所遇到的問題。

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