CheckStyle的安装与配置.doc

CheckStyleCheckStyle 的安装与配置的安装与配置 威海新北洋数码科技股份有限公司威海新北洋数码科技股份有限公司 软件研究室软件研究室 2014-10-30 CheckStyle 的安装与配置 1 修订记录修订记录 日期日期修订版本修订版本描述描述作者作者 2014.10.30V1.0初稿（创建） CheckStyle 的安装与配置 2 目目 录录 一一CHECKSTYLE 简介简介.1 二二CHECKSTYLE 的下载与安装的下载与安装.1 2.1CHECKSTYLE的下载1 2.2CHECKSTYLE的安装1 三三CHECKSTYLE 的配置的配置.2 3.1引用自定义 CHECKSTYLE配置文件.2 3.2CHECKSTYLE配置文件的生成4 3.3CHECKSTYLE的使用5 CheckStyle 的安装与配置 1 一一 CheckStyle 简介简介 CheckStyle 是 SourceForge 下的一个项目，提供了一个帮助 JAVA 开发人员遵守某些编码规范 的静态 java 代码分析工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但 是枯燥的任务中解脱出来。 二二 CheckStyle 的下载与安装的下载与安装 2.1CheckStyleCheckStyle 的下载的下载 Checkstyle 可以从其官网 /中下载。进入 Checkstyle 的官网后， 进入 Download 页面，可以下载 Checkstyle。下文的介绍中，我采用的是 net.sf.eclipsecs- updatesite_01111092104-bin.zip 版本的 Checkstyle 插件。 2.2CheckStyleCheckStyle 的安装的安装 打开 Eclipse 在菜单栏中，选择 HelpInstall New Software 点击 Add，弹出如下窗口 填写 Name，点击 Local.，选择之前下载的 net.sf.eclipsecs- updatesite_01111092104-bin.zip CheckStyle 安装包。 点击 OK，窗口中选中，点击 Finish。 重启 Eclipse。 CheckStyle 的安装与配置 2 确认安装成功的步骤： 打开 eclipse，选择 window-preferences-左边导航栏中 Checkstyle，如果出现 checkstyle 说明 你安装成功。 三三 CheckStyle 的配置的配置 Checkstyle 默认提供的配置文件有两个：一是 Sun Checks,对应的配置文件是 sun_checks.xml 文件，含义是 Checkstyle configuration that checks the sun coding conventions；一般 Checkstyle 默认 的设置就是 sun_checks.xml 配置文件。另一个是 Sun Checks(Eclipse)，对应的配置文件是 sun_checks_eclipse.xml，含义是 Slightly modified version of Sun Checks that better matches the default code formatter setting of Eclipse. 一般 Sun Checks 的检查项限定得较为严格，我们实际项目中并不要求那么完美的编程规范， 那么可以自己定义检查的配置文件，最后将 Checkstyle 的配置文件设定为我们自定义的文件即可。 3.1引用自定义引用自定义 CheckStyleCheckStyle 配置文件配置文件 将配置好肩擦规则的配置文件（下文以 checkstyle1212.xml 为例）导入到项目中。具体步骤为： 打开 Eclipse，在菜单栏中选中 WindowsPreference，在弹出窗口左侧的导航中找到 CheckStyle。 CheckStyle 的安装与配置 3 点击右侧的 New 按钮，在弹出窗口中进行下图所示设置。最主要的是选择 checkstyle1212.xml。 点击 OK，完成配置文件的添加。选中配置文件，点击右侧 Set as Default，将其设置为默 认执行检查的配置文件。这样，Eclipse 中的所有项目都会执行该配置文件所规定的检查。 CheckStyle 的安装与配置 4 3.2CheckStyleCheckStyle 配置文件的生成配置文件的生成 上文 3.1 中介绍的是为 Eclipse 设置默认的自定义 CheckStyle 配置文件。我们也可以单独为某 个项目进行配置生成其自己的配置文件。具体步骤： 选中项目，右击，点选 Proporties，弹出窗口中点选 Local Check Configurations，点击右 侧的 New 按钮，弹出窗口中做如下设置。 点击 OK，生成一个该项目自己的检查配置，如下图。 CheckStyle 的安装与配置 5 选中 thisCheckStyle，点击右侧的 Configuration 按钮，弹出详细的配置项窗口，根据自己 的需要进行添加与配置，部分配置项的详细内容可以自己设置，比如一些名称的正则表 达式、if 循环的最大嵌套数、每行允许的字符的最大值等等。 3.3CheckStyleCheckStyle 的使用的使用 CheckStyle 安装与配置成功后，就可以使用它来检查项目代码了。 首先，选中项目，右击，找到 CheckStyle，选择 Activate CheckStyle，激活检查。 CheckStyle 的安装与配置 6 选中单个文件或者包或者整个项目，右击，选择 CheckStyle Check Code with Che