让开发自动化: 用 Eclipse 插件提高代码质量

男娘i 2022-07-28 05:21 140阅读 0赞

### [让开发自动化: 用 Eclipse 插件提高代码质量][_ Eclipse]  ###

[http://www.ibm.com/developerworks/cn/java/j-ap01117/index.html][http_www.ibm.com_developerworks_cn_java_j-ap01117_index.html]

发软件时，我的主要目标之一是：要么防止将缺陷引入代码库，要么限制缺陷的生存期；换言之，要尽早找到缺陷。很显然，越是了解如何编写更好的代码以及如何有效测试软件，就越能及早地捕捉到缺陷。我也很想要一张能发现潜在缺陷的安全之网。

在本系列[八月份][Link 1]的那期文章中，我得出了这样的结论：将检验工具集成到构建过程（例如，使用 Ant 或 Maven）中，能够建立起一种寻找潜在缺陷的方法。尽管这种方法使一致性成为可能并超越了 IDE，但它也有一点*反作用*。必须在本地构建软件或等待 Continuous Integration 构建的运行。如果使用 Eclipse 插件，就可以在通过 Continuous Integration 构建或集成*前*发现一些这样的冲突。这就促成了我称为*渐进编程*的编程方式，在这种方式下，允许在编码过程中进行一定程度的质量检验 —— 再也不能比这个更早了！

本文涵盖了我所认为的 “五大” 代码分析领域：

*  编码标准
 *  代码重复
 *  代码覆盖率
 *  依赖项分析
 *  复杂度监控

可以用接下来的几个灵活的 Eclipse 插件来揭示这些分析领域：

*  CheckStyle：用于编码标准
 *  PMD 的 CPD：帮助发现代码重复
 *  Coverlipse：测量代码覆盖率
 *  JDepend：提供依赖项分析
 *  Eclipse Metric 插件：有效地查出复杂度

## Eclipse 不是您的构建系统 ##

使用 Eclipse 插件与您将这些检验工具用于构建过程并不矛盾。事实上，您想要确保的是：下列使用 Eclipse 插件的规则就是应用到构建过程中的规则。

**安装 Eclipse 插件**

安装 Eclipse 插件再简单不过了，只需要几个步骤。在开始之前，最好把该插件下载站点的 URL 准备好。表 1 是本文用到的插件的列表：

表 1. 代码改进插件和相应的下载站点 URL  
 工具 目的 Eclipse 插件的 URL

<table style="border-right-width:1px; border-bottom-width:1px; border-left-width:1px; border-right-style:solid; border-bottom-style:solid; border-left-style:solid; border-right-color:rgb(204,204,204); border-bottom-color:rgb(204,204,204); border-left-color:rgb(204,204,204); border-top-width:0px; border-top-color:initial; width:708px; color:rgb(0,0,0); font-family:'Times New Roman'; text-align:left"> 
 <tbody> 
 <tr></tr> 
 <tr> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> CheckStyle</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> 编码标准分析</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> http://eclipse-cs.sourceforge.net/update/</td> 
 </tr> 
 <tr> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> Coverlipse</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> 测试代码覆盖率</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> http://coverlipse.sf.net/update</td> 
 </tr> 
 <tr> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> CPD</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> 复制/粘贴检验</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> http://pmd.sourceforge.net/eclipse/</td> 
 </tr> 
 <tr> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> JDepend</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> 包依赖项分析</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> http://andrei.gmxhome.de/eclipse/</td> 
 </tr> 
 <tr> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> Metrics</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> 复杂度监控</td> 
 <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding-top:8px; padding-right:5px; padding-bottom:8px; padding-left:5px; vertical-align:top"> http://metrics.sourceforge.net/update</td> 
 </tr> 
 </tbody> 
</table>

知道了这些有用插件的下载地址后，安装插件就是一个极简单的过程。启动 Eclipse，然后遵循下列步骤：

1.  选择**Help | Software Updates | Find and Install**，如图 1 所示：  
      
      
      
    图 1. 寻找并安装 Eclipse 插件  
    ![寻找并安装 Eclipse 插件][Eclipse]  
      
      
      
    
2.  选择**Search for new features to install**单选按钮,单击**Next**。  
      
    
3.  单击**New Remote Site**，输入要安装的插件名和 URL（参见图 2），单击**OK**，然后单击**Finish**来显示 Eclipse 更新管理器。  
      
      
      
    图 2. 配置新的远程站点  
    ![配置新的远程站点][pmd-remotesite.jpg]  
      
      
      
    
4.  在 Eclipse 更新管理器中，有一个查看插件各方面特性的选项。我通常选择顶级项，如图 3 所示。选择您需要的选项并单击**Finish**。Eclipse 现在安装该插件。您需要重启 Eclipse 实例。  
      
      
      
    图 3. 安装 Eclipse 插件  
    ![安装 Eclipse 插件][Eclipse 1]

请遵循上述这些步骤来安装其他的 Eclipse 插件；只需改变插件名和相应的下载位置即可。

[回页首][Link 2]

**用 CheckStyle 校正标准**

代码库的可维护性直接影响着软件的整个成本。另外，不佳的可维护性还会让开发人员十分头痛（进而导致开发人员的缺乏）—— 代码越容易修改，就越容易添加新的产品特性。像 CheckStyle 这样的工具可以协助寻找那些可影响到可维护性、与编码标准相冲突的地方，比方说，过大的类、太长的方法和未使用的变量等等。

## 有关 PMD ##

另一个叫做 PMD 的开源工具提供的功能和 CheckStyle 类似。我偏爱 CheckStyle，但 PMD 也有很多执着的追随者，所以我建议您了解一下这个工具，毕竟它也颇受一些人的青睐。

使用 Eclipse 的 CheckStyle 插件的好处是能够在编码过程中了解到源代码上下文的各种编码冲突，让开发人员更可能在签入该代码前真正处理好这些冲突。您也几乎可以把 CheckStyle 插件视作一个连续的代码复查工具！

安装 CheckStyle 插件并做如下配置（参见图 4）：

1.  选择**Project**，然后选择 Eclipse 菜单中的**Properties**菜单项。  
      
    
2.  选择**CheckStyle active for this project**复选框，单击**OK**。  
      
      
      
    图 4. 在 Eclipse 中配置 CheckStyle 插件  
    ![在 Eclipse 中配置 CheckStyle 插件][Eclipse _ CheckStyle]

Eclipse 重新构建工作空间，并在 Eclipse 控制台中列示已发现的编码冲突，如图 5 所示：

图 5. Eclipse 中 CheckStyle 的代码冲突列表  
![Eclipse 中 CheckStyle 的代码冲突列表][Eclipse _ CheckStyle 1]

使用 CheckStyle 插件在 Eclipse 内嵌入编码标准检验是一种很棒的方法，用这种方法可以*在编码时*积极地改进代码，从而在开发周期的早期发现源代码中潜在的缺陷。这么做还有更多的好处，如节省时间、减少失败，也因此会减少项目的成本。没错，这就是一种积极主动的方式！

[回页首][Link 2]

**用 Coverlipse 确认覆盖率**

Coverlipse 是一个用于 Cobertura 的 Eclipse 插件，Cobertura 是一个代码覆盖率工具，可以用它来评估具有相应测试的源代码的比率。Cobertura 也提供一个 Ant 任务和 Maven 插件，但用 Cobertura，您可以*在编写代码时*评估代码覆盖率。您见过这样的模式吗？

通过选择 Eclipse 菜单项**Run**安装 Coverlipse 插件并将其和 JUnit 关联起来，该操作会显示一系列运行配置选项，例如 JUnit、SWT 应用程序和 Java™ 应用程序。右键单击它并选择**JUnit w/Coverlipse**节点中的**New**。在这里，需要确定 JUnit 测试的位置，如图 6 所示：

图 6. 配置 Coverlipse 以获取代码覆盖率  
![配置 Coverlipse 以获取代码覆盖率][Coverlipse]

一旦单击了**Run**，Eclipse 会运行 Coverlipse 并在源代码（如图 7 所示）中嵌入标记，该标记显示了具有相关 JUnit 测试的代码部分：

图 7. Coverlipse 生成的具有嵌入类标记的报告  
![Coverlipse 生成的具有嵌入类标记的报告][Coverlipse 1]

正如您所见，使用 Coverlipse Eclipse 插件可以更快地确定代码覆盖率。例如，这种实时数据功能有助于在将代码签入 CM 系统*前*更好地进行测试。这对渐进编程来说意味着什么呢？

[回页首][Link 2]

**用 CPD 捕捉代码重复**

Eclipse 的 PMD 插件提供了一项叫做 CPD（或复制粘贴探测器）的功能，用于寻找重复的代码。为在 Eclipse 中使用这项便利的工具，需要安装具有 PMD 的 Eclipse 插件，该插件具有 CPD 功能。

为寻找重复的代码，请用右键单击一个 Eclipse 项目并选择**PMD | Find Suspect Cut and Paste**，如图 8 所示：

图 8. 使用 CPD 插件运行复制粘贴检验  
![使用 PMD/CPD 插件运行复制粘贴检验][PMD_CPD]

一旦运行了 CPD，您的 Eclipse 根目录下就会创建出一个`report`文件夹，其中包含一个叫做 cpd.txt 的文件，文件中列示了所有重复的代码。图 9 中是一个 cpd.txt 文件的例子：

图 9. Eclipse 插件生成的 CPD 文本文件  
![Eclipse 插件生成的 CPD 文本文件][Eclipse _ CPD]

靠人工来寻找重复的代码是一项挑战，但使用像 CPD 这样的插件却能在编码时轻松地发现重复的代码。

[回页首][Link 2]

**使用 JDepend 进行依赖项检查**

JDepend 是个可免费获取的开源工具，它为包依赖项提供面向对象的度量值，以此指明代码库的弹性。换句话说，JDepend 可有效测量一个架构的健壮性（反之，脆弱性）。

除了 Eclipse 插件，JDepend 还提供一个 Ant 任务、Maven 插件和一个 Java 应用程序，用以获取这些度量值。对于相同的信息，它们有着不同的传递机制；但 Eclipse 插件的特别之处和相应优点是：它能以更接近源代码（即，编码时）的方式传递这条信息。

图 10 演示了使用 Eclipse JDepend 插件的方法：通过右键单击源文件夹并选择**Run JDepend Analysis**。一定要选择一个含源代码的源文件夹；否则看不到此菜单项。

图 10. 使用 JDepend Analysis 分析代码  
![使用 JDepend Analysis 分析代码][JDepend Analysis]

图 11 显示了运行 JDepend Analysis 时生成的报告。左边显示包，右边显示针对每个包的依赖项度量值。

图 11. Eclipse 项目中的包依赖项  
![Eclipse 项目中的包依赖项][Eclipse 2]

正如您所见，JDepend 插件提供了有助于不断观察架构可维护性变化的大量信息 —— 这其中最大的好处是您可以在编码时看到这些数据。

[回页首][Link 2]

**用 Metrics 测量复杂度**

“五大”代码分析最后的一项是测量复杂度。Eclipse 提供一种叫做 Metrics 的插件，使用该插件可以进行许多有用的代码度量，包括圈复杂度度量，它用于测量方法中惟一路径的数目。

安装 Metrics 插件并重启 Eclipse；然后遵循下列步骤：

1.  右键单击您的项目并选择**Properties**菜单。在结果窗口中，选择**Enable Metrics plugin**复选框并单击**OK**，如图 12 所示：  
      
      
      
    图 12. 为项目配置 Metrics  
    ![为项目配置 Metrics][Metrics]  
      
      
      
    
2.  从 Eclipse 中选择**Window**菜单打开 Metrics 视图，然后选择**Show View | Other...**。  
      
    
3.  选择**Metrics | Metrics View**打开如图 13 中显示的窗口。您需要使用 Java 透视图并重新构建项目，从而显示这些度量值。  
      
      
      
    图 13. 打开 Eclipse 中的 Metrics View  
    ![打开 Eclipse 中的 Metrics View][Eclipse _ Metrics View]  
      
      
      
    
4.  单击**OK**来显示如图 14 中的窗口。  
      
    在此例中，我正在查看一个单独方法的圈复杂度。真正妙的是您可以双击 Metrics 列表中的方法，该插件会在 Eclipse 编辑器中为此方法打开源代码。这就让修正变得超级简单（如果需要的话）！  
      
      
      
    图 14. 查看方法的圈复杂度  
    ![查看方法的圈复杂度][metrics-report.jpg]

正如我之前提到过的，Eclipse Metrics 插件还提供了许多功能强大的度量值，有助于您在开发软件的过程中改进代码 —— 可见，它是一个渐进编程意义上的插件!

[回页首][Link 2]

**合适的才是最好的**

正如您从本文中看到的那样，将“五大”测量方法，即编码标准、代码重复、代码覆盖率、依赖项分析和复杂度监控，用于改进代码质量十分重要。但适合您的才是好的。请记住还有其他许多可用的 Eclipse 插件（比如 PMD 和 FindBugs）能够帮助您在开发周期的早期改进代码质量。不管您想要的工具或偏爱的方法是什么，重要的是：行动起来去积极改进代码质量并让手工代码检验的过程变得更加有效。我估计您使用这些插件一段时间后，就再也离不开它们了。

**参考资料**

学习

*  您可以参阅本文在 developerWorks 全球站点上的[英文原文][Link 3]。  
      
    
 *  [*让开发自动化*][Link 4]（Paul Duvall，developerWorks）：阅读完整的系列。  
      
    
 *  “[Improving Code Quality with PMD and Eclipse][]” （Levent Gurses，Jacoozi，2005 年 1 月）：这篇文章将 PMD 视为 Eclipse 插件，介绍了使用 PMD 改进代码质量并缩短代码检验过程的方法。  
      
    
 *  “[用 Cobertura 测量测试覆盖率][Cobertura]” （Elliotte Rusty Harold，developerWorks，2005 年 5 月）：Elliotte Rusty Harold 分享了他的经验，即如何使用代码覆盖率的最佳实践来利用 Cobertura。  
      
    
 *  “[不要被覆盖报告所迷惑][Link 5]” （Andrew Glover，developerWorks，2006 年 1 月）：这篇文章进一步揭示了覆盖率报告中的数字所代表的真正含义，也给出了这些数字所不能代表的含义。  
      
    
 *  “[Managing Your Dependencies with JDepend][]” （Glen Wilcox，OnJava，2004 年 1 月）：在这篇文章中，Glen Wilcox 介绍了 JDepend，这是一个可以免费获取的工具，它能洞悉软件架构中的许多质量问题。  
      
    
 *  “[软件架构的代码质量][Link 6]” （Andrew Glover，developerWorks，2006 年 4 月）：Andrew Glover 介绍了如何持续监控以及如何改正能够影响软件架构长期存续性的代码质量问题。  
      
    
 *  “[*让开发自动化*: 持续检查][Link 1]” （Paul Duvall，developerWorks，2006 年 8 月）：Paul Duvall 介绍了自动化的检查工具（如 CheckStyle、JavaNCSS 和 CPD ）是如何增强开发过程的以及何时应该使用这些工具。  
      
    
 *  “[Detecting Duplicate Code with PMD's CPD][Detecting Duplicate Code with PMD_s CPD]” （Tom Copeland，OnJava，2003 年 3 月）：Tom Copeland 介绍了一种叫做 CPD（复制/粘贴检测器）的开源工具，该工具用于寻找重复的 Java 代码。  
      
    
 *  “[Maintain organizational standards with code audits”][Maintain organizational standards with code audits]（testearly.com）：编码标准有利于广大开发人员对代码库达成共识。  
      
    
 *  [developerWorks Java 技术专区][developerWorks Java]：数百篇关于 Java 编程各方面的文章。

获得产品和技术

*  [Eclipse plugin for PMD][]：使用 PMD 插件在代码中寻找复制粘贴问题。  
      
    
 *  [Eclipse plugin for JDepend][]：此插件有助于分析代码库中的包依赖项。  
      
    
 *  [Eclipse plugin for Cobertura][]：Coverlipse 是 用于 Cobertura 的 Eclipse 插件，它提供代码覆盖率信息。  
      
    
 *  [Eclipse Metrics][]：此插件提供度量值，如圈复杂度，非常有助于寻找复杂代码。  
      
    
 *  [Eclipse plugin for CheckStyle][]：检验项目编码标准的遵循情况。

讨论

[提高代码质量论坛][Link 7]：developerWorks 的积极贡献者 Andrew Glover 是一名专注于改进代码质量的顾问，他为这个由他主持的论坛带来了很多相当专业的知识。

[_ Eclipse]: http://samwong.iteye.com/blog/2046941
[http_www.ibm.com_developerworks_cn_java_j-ap01117_index.html]: http://www.ibm.com/developerworks/cn/java/j-ap01117/index.html
[Link 1]: http://www.ibm.com/developerworks/cn/java/j-ap08016/index.html
[Eclipse]: /images/20220727/f15ba80dfdf449f0b8a93831df79bcd8.png
[pmd-remotesite.jpg]: /images/20220727/766f0c5fbf6d410dad6d69748b6de5f7.png
[Eclipse 1]: /images/20220727/3a383310d81d4cd08725530e9c1d014b.png
[Link 2]: http://www.ibm.com/developerworks/cn/java/j-ap01117/index.html#ibm-pcon
[Eclipse _ CheckStyle]: /images/20220727/e880ce71a3794a5aa2fca314c41590a0.png
[Eclipse _ CheckStyle 1]: /images/20220727/3f54bc38b21b454d842ad9a1b9bbdba9.png
[Coverlipse]: /images/20220727/f8ffb68201334e65b33361c06bc22db3.png
[Coverlipse 1]: /images/20220727/588fd8c0dcfe4850a3667f78ed0e089a.png
[PMD_CPD]: /images/20220727/d23487e8b99a4873980af89301fccefd.png
[Eclipse _ CPD]: /images/20220727/0774ec9d992144f3b8948a367522227e.png
[JDepend Analysis]: /images/20220727/258b8a84fbba4604b0a8cbdce52c5b1c.png
[Eclipse 2]: /images/20220727/c7b5151122934b8c95c56689c79057af.png
[Metrics]: /images/20220727/a99cd385989241d69aa8bd0e11f8036f.png
[Eclipse _ Metrics View]: /images/20220727/1103f8d533cf435cbdea075cd1e8b1e8.png
[metrics-report.jpg]: /images/20220727/abd43235da1940de9d30b2aa930440b1.png
[Link 3]: http://www.ibm.com/developerworks/java/library/j-ap01117/?S_TACT=105AGX52&S_CMP=cn-a-j
[Link 4]: http://www.ibm.com/developerworks/cn/java/j-ap/
[Improving Code Quality with PMD and Eclipse]: http://www.jacoozi.com/index.php?option=com_content&task=view&id=121&Itemid=134
[Cobertura]: http://www.ibm.com/developerworks/cn/java/j-cobertura/
[Link 5]: http://www.ibm.com/developerworks/cn/java/j-cq01316/index.html
[Managing Your Dependencies with JDepend]: http://www.onjava.com/pub/a/onjava/2004/01/21/jdepend.html
[Link 6]: http://www.ibm.com/developerworks/cn/java/j-cq04256/index.html
[Detecting Duplicate Code with PMD_s CPD]: http://www.onjava.com/pub/a/onjava/2003/03/12/pmd_cpd.html
[Maintain organizational standards with code audits]: http://www.testearly.com/2006/03/14/maintain-organizational-standards-with-code-audits/
[developerWorks Java]: http://www.ibm.com/developerworks/cn/java/
[Eclipse plugin for PMD]: http://pmd.sourceforge.net/eclipse/
[Eclipse plugin for JDepend]: http://andrei.gmxhome.de/jdepend4eclipse/index.html
[Eclipse plugin for Cobertura]: http://coverlipse.sf.net/update
[Eclipse Metrics]: http://metrics.sourceforge.net/update
[Eclipse plugin for CheckStyle]: http://eclipse-cs.sourceforge.net/update/
[Link 7]: http://www.ibm.com/developerworks/forums/dw_forum.jsp?S_TACT=105AGX52&cat=10&S_CMP=cn-a-j&forum=812