(CheckStyle的安装与配置.docVIP

CheckStyle的安装与配置 威海新北洋数码科技股份有限公司 软件研究室 2014-10-30 修订记录 日期 修订版本 描述 作者 2014.10.30 V1.0 初稿（创建）  目 录 一 CheckStyle简介 1 二 CheckStyle的下载与安装 1 2.1 CheckStyle的下载 1 2.2 CheckStyle的安装 1 三 CheckStyle的配置 2 3.1 引用自定义CheckStyle配置文件 2 3.2 CheckStyle配置文件的生成 4 3.3 CheckStyle的使用 5 CheckStyle简介 CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。 CheckStyle的下载 Checkstyle可以从其官网/中下载。进入Checkstyle的官网后，进入Download页面，可以下载Checkstyle。下文的介绍中，我采用的是net.sf.eclipsecs-updatesite_01111092104-bin.zip版本的Checkstyle插件。 打开Eclipse 在菜单栏中，选择Help--Install New Software 点击Add，弹出如下窗口 填写Name，点击Local...，选择之前下载的net.sf.eclipsecs-updatesite_01111092104-bin.zip CheckStyle安装包。 点击OK，窗口中选中，点击Finish。 重启Eclipse。 确认安装成功的步骤： 打开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的配置文件设定为我们自定义的文件即可。 将配置好肩擦规则的配置文件（下文以checkstyle1212.xml为例）导入到项目中。具体步骤为： 打开Eclipse，在菜单栏中选中Windows--Preference，在弹出窗口左侧的导航中找到CheckStyle。 点击右侧的New按钮，在弹出窗口中进行下图所示设置。最主要的是选择checkstyle1212.xml。 点击OK，完成配置文件的添加。选中配置文件，点击右侧Set as Default，将其设置为默认执行检查的配置文件。这样，Eclipse中的所有项目都会执行该配置文件所规定的检查。 CheckStyle配置文件的生成 上文3.1中介绍的是为Eclipse设置默认的自定义CheckStyle配置文件。我们也可以单独为某个项目进行配置生成其自己的配置文件。具体步骤： 选中项目，右击，点选Proporties，弹出窗口中点选Local Check Configurations，点击右侧的New按钮，弹出窗口中做如下设置。 点击OK，生成一个该项目自己的检查配置，如下图。 选中thisCheckStyle，点击右侧的Configuration按钮，弹出详细的配置项窗口，根据自己的需要进行添加与配置，部分配置项的详细内容可以自己设置，比如一些名称的正则表达式、if循环的最大嵌套数、每行允许的字符的最大值等等。 CheckStyle的使用 CheckStyle安装与配置成功后，就可以使用它来检查项目代码了。 首先，选中项目，右击，找到CheckSty