跟我学Java代码规范检测CheckStyle工具——如何应用CheckStyle工具检查Java代码的规范程度

跟我学Java代码 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 检测CheckStyle工具——如何应用CheckStyle工具检查Java代码的规范程度 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 1.1 跟我学Java代码规范检测CheckStyle工具——如何应用CheckStyle工具检查Java代码的规范程度 1.1.1 用CheckStyle检查Java代码的规范程度 1、CheckStyle是一个开源的度量代码规范性程度的检测工具 (1)CheckStyle是SourceForge下的一个项目 在sourceforge.net网站中提供有下载CheckStyle的系统包文件的链接，开发人员可以在CheckStyle的官方网站中下载其系统包文件，CheckStyle主要功能请见下图所示的介绍CheckStyle功能信息显示的页面。 (2)CheckStyle工具的主要功能特性 应用CheckStyle代码规范性度量检测工具能够帮助开发人员检查在代码编程时是否遵循了某种代码编程规范——这包括代码风格、代码结构、代码冗余和典型错误等方面的检测，从而确保项目团队中各个成员的程序代码具有一致的编码规范和风格。 在如下的官方网页中显示出对CheckStyle工具的主要功能特性的介绍信息及 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 的检查项目: 杨教授工作室，版权所有，盗版必究， 1/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 (3)CheckStyle工具能够自动化代码规范检查过程 是枯燥的由于CheckStyle工具可以自动地执行，从而使得开发人员从这项重要，但却任务中解脱出来。Checkstyle工具除了支持Sun公司所制定的Java标准的编码规范外，也还允许开发人员自定义编码规范以满足项目组的特殊要求，这主要是通过编写有关的配置文件来实现。 当然，Checkstyle代码规范程度度量的检测工具不仅可以检查项目中的代码是否遵循了某种编码规范，也还可以检查出项目中的代码在 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 方面的错误，比如重复的代码等。 2、下载开源的CheckStyle系统包文件 在CheckStyle的官方网站中找到其系统包程序文件下载的页面，开发人员可以直接下载其系统包文件，请见下图所示的CheckStyle系统包程序下载链接的页面示图。 杨教授工作室，版权所有，盗版必究， 2/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 读者可以根据自己的应用需要，下载对应的版本，然后将下载的*.zip文件解压到某个目录中。 3、CheckStyle工具也可以与Eclipse相互集成以提高检测效率 CheckStyle通常是和Apache Ant配合使用的，但现在也有许多CheckStyle的第三方插 杨教授工作室，版权所有，盗版必究， 3/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 件，如与Eclipse开发工具集成的Eclipse插件等。而CheckStyle的Eclipse插件下载网址为。如下示图所示为与Eclipse相互集成的Eclipse插件的下载网址页面示图。 在上图中所示的介绍CheckStyle的Eclipse插件信息的页面中，找到下载插件的超链接，并点击进入到CheckStyle的Eclipse插件的下载页面中。请见下图所示。 读者根据网页中的提示信息，下载相应的系统包*.zip文件，然后解压缩其系统包文件到磁盘中的某个目录中。 杨教授工作室，版权所有，盗版必究， 4/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 4、利用直接拷贝的方式实现在Eclipse中集成CheckStyle代码规范程度度量工具 可以通过将下载的解压缩后的CheckStyle系统包文件中的两个文件夹plugins和 features下的各个文件拷贝到相关的目录中，实现在Eclipse IDE中集成CheckStyle代码规范检查工具。 将解压缩后的CheckStyle系统包文件中的两个文件夹plugins和 features下的各个文件分别放到本机eclipse的安装目录下所对应的plugins和features目录中。 同样要注意的是，由于目前许多开发人员在Eclipse中基本上都安装有Eclipse的J2EE开发的插件MyEclipse。因此，实际应该是将它拷贝到MyEclipse插件所在的安装目录下的plugins和features目录中(如笔者机器中的目录为C:\Users\hp\AppData\Local\MyEclipse Professional 2014)。请见下图所示的拷贝结果。 杨教授工作室，版权所有，盗版必究， 5/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 5、在MyEclipse开发工具中通过本地安装的方式加载集成CheckStyle代码规范程度度量工具 读者如果不清楚机器中的Eclipse或者MyEclipse开发工具的安装目录，也可以在MyEclipse开发工具中通过本地安装的方式加载集成CheckStyle代码规范程度度量工具。下面介绍具体的操作实现步骤。 (1)启用Install from Site菜单 在Eclipse或者MyEclipse开发工具中，选择Help -->Install from Site菜单。 (2)在弹出的对话框中点击“Archive”按钮 (3)定位到下载的CheckStyle系统包*.zip文件所在的本地磁盘目录中 杨教授工作室，版权所有，盗版必究， 6/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 (4)选择待安装的CheckStyle系统包，并点击对话框中的“Next”下一步按钮 (5)继续点击对话框中的“Next”下一步按钮 杨教授工作室，版权所有，盗版必究， 7/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 (6)点击对话框中的Finisht”完成按钮 (7)开始安装所下载的CheckStyle系统包文件 杨教授工作室，版权所有，盗版必究， 8/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 (8)在安装的过程中出现警告对话框 (9)继续点击对话框中的“OK”按钮 杨教授工作室，版权所有，盗版必究， 9/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 (10)安装完毕后，将提示需要重新启动MyEclipse开发工具 6、检查是否成功安装所下载的CheckStyle系统包文件 )点击Hekp菜单中的—>Install from Site子菜单项目 (1 (2)点击对话框中的“already installed”按钮 杨教授工作室，版权所有，盗版必究， 10/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 点击其中的“already Installed”链接，将出现如下示图所示的对话框。查看对话框 Plug-in的安装项目。 中的所安装的程序列表中是否存在“Eclipse CheckStyle 如果查看到如上图所示的条目，则表明安装成功。 7、利用CheckStyle对项目中的代码规范程度进行检查 启动Eclipse或者MyEclipse开发工具后，再打开所需要检查的项目的属性，并在项目的属性对话框中的左面的项目树面板中选中【CheckStyle】子项目，在右面的 内容 财务内部控制制度的内容财务内部控制制度的内容人员招聘与配置的内容项目成本控制的内容消防安全演练内容 面板中可以看到各个方面的配置信息。请见下图所示。 在使用CheckStyle工具时，不要忘记选中下图所示的内容面板左上角的【CheckStyle active for this project】的选择框。 杨教授工作室，版权所有，盗版必究， 11/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 在上图所示的对话框中，点击其中的【OK】按钮后，CheckStyle工具将开始对项目中的各个代码进行检测，由于CheckStyle工具在检测之前需要对项目中的代码进行编译处理。因此，Eclipse工具会出现下图所示的警告提示对话框。 Eclipse IDE工具将重新构建工作空间，并在 Eclipse IDE的控制台中列出已发现的代码中的各种不规范的警告提示。如下图所示的对Java泛型在集合方面应用时的不规范行为进行警告提示。 杨教授工作室，版权所有，盗版必究， 12/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 因此，通过利用CheckStyle代码规范程度度量工具能够在早期的编程阶段就能够及时地发现出在编码方面的不规范行为以及有可能隐藏的错误、并及时地进行纠正——“防微杜渐”。 8、在Eclipse IDE 工具中修正不规范的代码 当采用CheckStyle代码规范程度度量工具检测出项目中的不规范的程序代码时，可以在Eclipse DE 工具中修正这些不规范的代码。具体的实现方式是在【问题】面板中右击检测出的不规范代码，在弹出的快捷菜单中选中【快速修正】子菜单项，Eclipse IDE 工具将指导开发人员修正不规范的代码。请见下图所示。 9、配置定义CheckStyle中的代码规范标准 由于CheckStyle是一个度量代码规范性程度的检测工具，因此也就必须要依据某种“代码规范”。在CheckStyle中支持两种不同形式的“代码规范”——Sun公司的Java标准代码规范和Eclipse IDE工具中的代码规范(也就是IBM公司的Java代码规范)，并允许开发人员改变和选择。请见下图所示。 杨教授工作室，版权所有，盗版必究， 13/14页 杨教授工作室 精心创作的优秀程序员 职业提升必读系列资料 当然，还允许开发人员自定义编码规范以满足项目组的特殊要求，这可以在下图所示的对话框中切换到【Local Check Configurations】标签页中，然后新建各个规则项目并 保存到有关的配置文件中。请见下图所示。 杨教授工作室，版权所有，盗版必究， 14/14页