Java代码质量检查工具及使用案例

前言
在现在的软件开发中,由于软件的复杂度越来越高,业务也覆盖很广,各个业务模块业务错综复杂 。这样就需要我们需要团队开发,在我们团队中开发人员的经验、代码风格样式都不一致,以及缺乏统一的标准,从而导致我们的整个项目的的代码难以阅读,不便于后期维护 。这几天在研究代码质量管理,根据在网上搜集的资料及跟前辈学的一点经验整理一下,有需要的同学们可以查看,也便于以后自己回顾 。
主要对下面的七块进行分析
编码格式规范
代码重复
代码覆盖率
依赖项分析
复杂度监控
JAVA模拟技术
代码评审和重构
接下来的使用Eclipse 插件来揭示这些分析领域:
编码格式规范:codeStyle和CheckStyle
代码重复:PMD 的 CPD
代码覆盖率:Coverlipse或者Emma
依赖项分析:JDepend
复杂度监控:Metrics
Java模拟技术:EasyMock、PowerMock
代码评审和重构:Jupiter
编码格式规范
codestyle介绍
统一的代码规范能提高代码的可读性、可维护性 。
一般规则和格式规范:如代码缩进、程序块规范、每行最大代码长度;
命名规范:如包名、类名、接口名、枚举、属性名、方法名、参数名等命名规则;
文档规范:如类文件头注释、变量注释、方法注释等;
编程规范:如异常、并发、多线程等;
其它规范:如日志格式等 。

Java代码质量检查工具及使用案例

文章插图
图1
可以导入代码格式,实现统一 。
checkstyle介绍
安装checkstyle 的Eclipse插件
1.下载地址:
http://pan.baidu.com/s/1o6LOSwM
2.解压
net.sf.eclipsecs-updatesite_5.6.1.201306282206-bin.zip文件,到系统路径下 。如:D:geyouchaoeclipse-pluginscs(注:一定不用起名为checkstyle,不知道为什么此名就是安装不成功),此文件夹下有两个文件夹features、plugins 。
3.我们使用link的方式安装 。在Eclipse的dropins文件夹下新建checkstyle.link文件,内容为:
path=D:\geyouchao\eclipse-plugins\cs
4.关闭Eclipse,重启 。然后在Eclipse的window》Preferences下就可以看到checkstyle菜单,安装成功,如下图
Java代码质量检查工具及使用案例

文章插图
图2
使用checkstyle
自定义CheckStyle规则,下面是我定义的CheckStyle模板,然后导入
Java代码质量检查工具及使用案例

文章插图
图3
把新导入的,设置为默认
Java代码质量检查工具及使用案例

文章插图
图4
可以修改其中的值,点击“Configure…”按钮 。
Java代码质量检查工具及使用案例

文章插图
图5
下面是我自定义的CheckStyle.xml文件,供参考 。
 
<xml version="1.0"encoding="UTF-8"><!DOCTYPE module PUBLIC "-//PuppyCrawl//DTD Check Configuration 1.2//EN""http://www.puppycrawl.com /dtds/configuration_1_2.dtd"><module name="Checker"><propertyname="severity" value=https://www.isolves.com/it/cxkf/yy/JAVA/2022-06-07/"warning"/>


推荐阅读