在Eclipse中配置使用代码审查与分析工具

Checkstyle + FindBugs + PMD

Posted by mtt on October 18, 2017

前言

在大型项目中,代码遵循一定的规范非常重要,在代码进行审查的时候,可以人工Review,也可以借助一些工具,在这里我们简单介绍了Eclipse中用了代码审查和分析工具的安装使用。

Checkstyle

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但枯燥的任务中解脱出来。

在线安装

  • 点击eclipse窗口上方的windows,选择install new software
  • 在新弹出的work with栏输入checkstyle的地址:http://eclipse-cs.sf.net/update
  • 在Name栏经pending后选中出现的两个要安装的选项,一路点击next
  • 安装成功后重启eclipse

使用

  • 选择代码规范: Windows->preference选择checkstyle,点击Sun Checks,点击Set as Default,apply and close
  • 选中工程,右键选择Checkstyle->check code with checkstyle,检查错误即可

常见错误类型

错误类型 解决方案
缺少 package-info.java 文件 添加包的说明文件package-info.java
花括号所在位置不正确 调整花括号的位置
;前有多余空格 去除多余空格
缺少Javadoc注释 添加必要的注释
文件没有以空行结尾 在文件末尾加入空行
文件里有制表符 把制表符替换为空格
If中的语句必须用{}包起来 添加花括号
本行字符数 91个,最多:80个。 代码换行

PMD

PMD(Project Manager Design)是一种开源分析Java代码错误的工具。PMD通过静态分析获知代码错误。也就是说,在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则,利用这些规则可以找出Java源程序的许多问题。此外,用户还可以自己定义规则,检查Java代码是否符合某些特定的编码规范。

在线安装

  • 点击eclipse窗口上方的windows,选择install new software
  • 在新弹出的work with栏输入pmd的地址:https://dl.bintray.com/pmd/pmd-eclipse-plugin/updates/
  • 在Name栏经pending后选中PMD for eclipse4,一路点击next
  • 安装成功后重启eclipse

FindBugs

在线安装

  • 点击eclipse窗口上方的windows,选择install new software
  • 在新弹出的work with栏输入FindBugs的地址:http://findbugs.cs.umd.edu/eclipse
  • 在Name栏经pending后选中FindBugs,一路点击next
  • 安装成功后重启eclipse