使用PMD进行代码审查(转)

原文地址：使用PMD进行代码审查

很久没写博客了，自从上次写的设计模式的博客被不知名的鹳狸猿下架了一次之后兴趣大减，那时候就没什么兴致写博客了，但是这段时间还没有停下来，最近也在研究一些其他的东西，目前有点想做点东西的打算，但好像也没什么好的切入点，先边走边看吧，今天有点兴致来玩一下代码审查的工具了，分享一下吧，也不算什么新技术，但是好像网上的资料都过期了，就写在这边，可能会有人有需要把。

最近在审查代码，不得不说，很多人的代码还是写的很不规范，之前没接手现在这个项目的时候还真的不知道原来之前的人写代码这么浪，各种魔法数字乱飞，各种try catch，Collection也不注意性能，只要功能能实现就好了，导致性能异常低下，还有各种从网上copy代码也不看看性能的，最扯的是竟然看到了一个MD5的实现。。。难道之前写代码的人不知道java自带的md5实现吗？也就不吐槽了，现在接手代码需要对代码进行整改重构，想先大概的扫一遍代码，不过代码量的确也很大，肉眼看的话，实在是有点累人，也就想着偷懒看能不能找些自动扫描工具，查了一下，目前用的比较多的也就PMD，checkstyle，findbugs，大致看了下，目前用的人比较多的好像是PMD，而且官网一直也在更新，就上网站下载下来了。

不知道是不是因为被墙的关系，https://pmd.github.io/ pmd的包下载的特别慢，下载的速度一直保持在10几K，好不容易下载完了，在下载的中间网上顺便查了一下使用手册，但是竟然发现，网上的资料竟然那么老，都不能用了，还是要去看官方文档上的资料，笔者使用的是window7的系统，下载完之后，解压出来，按下WIN+R，打开运行命令cmd，进入控制台，进入到~\pmd-bin-5.4.4\bin,刚才解压的路径下，接下来就是要对工程进行扫描了

例子如下

pmd -d E:\Eclipse-Projects\project-1.2-develop -f html -r e:\design.html -R java-design

-d 是dir,指定代码路径,笔者扫描的是整个代码工程,-f 是format,指定要输出的格式，默认是txt, -R 是指定使用的是哪种规则集,这里说一下，网上目前看的，除了笔者的这篇文章其他写的几乎都是错的，至少我目前没看到正确的规则集，新版的规则集格式换了,

目前pmd支持的规则集有 java-basic,java-unusedcode,java-imports,java-design,java-typeresolution，指定的规则集就是扫描的代码必须满足一定的规则才可以通过，如果不满足的话，pmd都会帮你罗列出不满足规则集的代码，以及行号，还有-r 是-reportfile指定输出的文件路径，这样基本的命令，运行的话就可以等待控制台完成，去指定路径查看html，看工具给我们的代码提了哪些意见了，笔者认为这个工具还是不错的，相比与checkstyle的话，checkstyle如果自己不写规则的话，按照google或者sun自带的规则的话，就实在太严格了，满满的都是报错。。

PMD里面还给我们提供了一些好用的GUI的工具里面的cpdgui可以查找重复的代码，bgastviewer可以把代码抽象成语法树等等，剩下的大家可以自己去摸索了，这个工具相对目前其他的代码审查工具，功能还是挺全面的，大家可以一试。