我的地盘我做主！ 博客：http://tester2test.cnblogs.com/ 　 msn:win_soft@163.com

Java代码缺陷自动分析工具介绍

上一篇 / 下一篇  2007-06-07 14:30:40 / 个人分类：其他

查看( 83 ) / 评论( 0 ) / 评分( 0 / 0 )
 

Java代码缺陷自动分析工具介绍

4c~dm!u}6O/sR0

l)fHqT0GP0                                                                                                    黄锡波51Testing软件测试网{5N lj)A \ u

51Testing软件测试网1Wm:j6VVF^7M

Java代码缺陷自动分析工具主要有：Findbugs、PMD和CheckStyle工具。这里重点介绍Findbugs的使用，简要提及PMD和CheckStyle工具的使用。51Testing软件测试网?Bat(L&@/]

1         FindBugs是什么？

51Testing软件测试网f&O \ R1v Os

FindBugs 是一个java bytecode静态分析工具，它可以帮助java工程师提高代码质量以及排除隐含的缺陷。

{+`.q A2U7\$Z2oW?0J E0 51Testing软件测试网~6R)p#v*gwQ

FindBugs检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。51Testing软件测试网R$U!`iA6t4A"Zx

L*tCs'Rs'E$~}0有了静态分析工具，就可以在不实际运行程序的情况对软件进行分析。FindBugs不是通过分析类文件的形式或结构来确定程序的意图，而是通常使用 Visitor 模式进行分析（Visitor 模式的更多信息）。51Testing软件测试网:mGley:p K @

51Testing软件测试网 x$a3[B F3Q q

 

&@H ndUpdb!PR1[0

2         FindBugs可以做什么？

51Testing软件测试网~ bO3l1VBSBS

FindBugs提供了35个检测器来检测字节码中可能的缺陷。可以做的事情主要有：

}e0L#v!Z0

2.1       找出 hash equals 不匹配

h,Vldf*`*cA T0找与 equals() 和 hashCode() 的实现相关的几个问题。这两个方法非常重要，因为几乎所有基于集合的类---List、Map、Set 等都调用它们。一般来说，这个检测器寻找两种不同类型的问题:

)Xu M/V/] U XQ5EQ0 51Testing软件测试网 N*k:P%zDh\

①当一个类重写对象的 equals() 方法，但是没有重写它的 hashCode 方法，或者相反的情况时。 51Testing软件测试网4nm aHz$l

:[7Xr9z ]V0②定义一个 co-variant 版本的 equals() 或 compareTo() 方法。例如， Bob 类定义其 equals() 方法为布尔 equals(Bob) ，它覆盖了对象中定义的 equals() 方法。因为 Java 代码在编译时解析重载方法的方式，在运行时使用的几乎总是在对象中定义的这个版本的方法，而不是在 Bob 中定义的那一个（除非显式将 equals() 方法的参数强制转换为 Bob 类型）。因此，当这个类的一个实例放入到类集合中的任何一个中时，使用的是 Object.equals() 版本的方法，而不是在 Bob 中定义的版本。在这种情况下， Bob 类应当定义一个接受类型为 Object 的参数的 equals() 方法。

L3r"Ocx,Wn0

7~(iHf`Z)jv0 

v5k5x^4z/a;G2K0

2.2       检测：忽略方法返回值

51Testing软件测试网_,|4W7["ALP Li;k

这个检测器查找代码中忽略了不应该忽略的方法返回值的地方。这种情况的一个常见例子是在调用 String 方法时，例如:

#mW_^(w_+hK|0

-u,SoO/G [5l01 String aString = "bob";

U'E {'HD'{J/f c3KS;L0

7eEW@ y([E;}02 b.replace('b', 'p');51Testing软件测试网| t8{b2BO'K

51Testing软件测试网K/T6{XQ

3 if(b.equals("pop"))

3B#T%~|[2k0 51Testing软件测试网*rq3B7rt V5V O;o$YS

这个错误很常见。在第 2 行，程序员认为他已经用 p 替换了字符串中的所有 b。确实是这样，但是他忘记了字符串是不可变的。所有这类方法都返回一个新字符串，而从来不会改变消息的接收者。

'E&jXo bx/_;x#NK0

-? MK{\X&m"F7n0 51Testing软件测试网y3kvkh k

2.3       检测：Null 指针对 null 的解引用（dereference）和冗余比较

Pc3`uN$D0这个检测器查找两类问题。它查找代码路径将会或者可能造成 null 指针异常的情况，它还查找对 null 的冗余比较的情况。例如，如果两个比较值都为 null，那么它们就是冗余的并可能表明代码错误。FindBugs 在可以确定一个值为 null 而另一个值不为 null 时，检测类似的错误，例如： 51Testing软件测试网 [Wmw7gsjICv!Ov

4o b:v hg4xO01 Person person = aMap.get("bob");

&jW t,X R;a0

i)c@8R~ V02 if (person != null) {51Testing软件测试网9I`,ie0ik,\v-E+?

51Testing软件测试网Q0A7B!| VD

3      person.updateAccessTime();

5@X6L G QW0

q(UeW F;G04 }51Testing软件测试网-^O J8K u9Q

51Testing软件测试网x a5X3E!c-a

5 String name = person.getName();

g}u;Q~-\"Y0 51Testing软件测试网0k5o l"J,J)^P`&D

在这个例子中，如果第 1 行的 Map 不包括一个名为“bob”的人，那么在第 5 行询问 person 的名字时就会出现 null 指针异常。因为 FindBugs 不知道 map 是否包含“bob”，所以它将第 5 行标记为可能 null 指针异常。 51Testing软件测试网Am!N"D5H9] r

51Testing软件测试网 q Op1B7z;w d

 51Testing软件测试网c:mb;Y5A1O,k.w

2.4       检测：初始化之前读取字段

51Testing软件测试网Y6C)Y9H3hE

这个检测器寻找在构造函数中初始化之前被读取的字段。这个错误通常是由使用字段名而不是构造函数参数引起的，例如在构造函数中读取未初始化的字段:51Testing软件测试网;hj$d9xf:c7v0S

51Testing软件测试网D.aM ~|[ ]

1 public class Thing {51Testing软件测试网\/Me+Jy H j

%?|/Qpd02      private List actions;51Testing软件测试网#k!Ej0r#vl$b

GK#v:A-Q/wc03      public Thing(String startingActions) {

F a(A K\|S0

J.Qg"V-j:f)M04       StringTokenizer tokenizer = new StringTokenizer(startingActions);51Testing软件测试网 t2T MAtOG

[:U @w"by ^.U8jO{B05          while (tokenizer.hasMoreTokens()) {51Testing软件测试网Creb;C6e*V/A$l

ZbIt@ S7~ P WO06              actions.add(tokenizer.nextToken());51Testing软件测试网o0E\!isd8i

51Testing软件测试网/k |o%R"cQ:t

7       }

~"pZOjI0 51Testing软件测试网3t O;m(T:k l:hB['Ba

8      }

m\Yp+X4{\)G#_0

}z&U2{G QB~09 }51Testing软件测试网5WT'y+`cM#zE

yU@W"l0在这个例子中，第 6 行将产生一个 null 指针异常，因为变量 actions 还没有初始化。 51Testing软件测试网?8z.[(^!h.h T"?

51Testing软件测试网l)E*p)e_3X{t

 51Testing软件测试网`/f,LK6@6mhup

2.5       命名检查

J\eKjv`P8_0对标准 Java 命令规范的测试：变量名称不应太短；方法名称不应过长；类名称应当以小写字母开头；方法和字段名应当以小写字母开头，等等。51Testing软件测试网_hW;md3?:br

51Testing软件测试网O+N Fa$O9P)i%G$v@

 

wsF6[J l;kp0

2.6       未使用的代码检查

8?0K? I%R3|A$ZUs7E0查找从未使用的私有字段和本地变量、执行不到的语句、从未调用的私有方法，等等。51Testing软件测试网M1y.aYV(hIY)f

51Testing软件测试网[5||1w.n$S

 51Testing软件测试网\T$mrI{w#_

2.7       嵌套检查

51Testing软件测试网vG3uJ A"H{

例如： switch 语句应当有 default 块，应当避免深度嵌套的 if 块，不应当给参数重新赋值，不应该对 double 值进行相等比较。

T\/b3`e]4OT8w0 51Testing软件测试网fdUc/E~L"]:l

 

$Q7y&P0Sp(D0

2.8       导入语句检查

51Testing软件测试网 @2G+o| K\3h

检查 import 语句的问题，比如同一个类被导入两次或者被导入 java.lang 的类中。51Testing软件测试网 L^bniha

*A*_H#J:i1\&B;NI6S;Fm0 51Testing软件测试网8g+Hq`jq3M1U

2.9       JUnit 测试检查

51Testing软件测试网(_3Lyb9lp:^9O&p+I8A%q

查找测试用例和测试方法的特定问题，例如方法名称的正确拼写，以及 suite() 方法是不是 static 和 public。

~ ](g2r1@S;z1D_@0 51Testing软件测试网"u;t!? Sm dN a h`#g

 51Testing软件测试网_qC[s6Z

2.10   字符串检查

51Testing软件测试网;m K+DF9n*q

找出处理字符串时遇到的常见问题，例如重复的字符串标量，调用 String 构造函数，对 String 变量调用 toString() 方法。

#MB _ k2kY])EA0 51Testing软件测试网'Bug l-s uk1HL

 

#k,E-c khj:l0Z/X0

2.11   括号检查

51Testing软件测试网wW OXY QMq0u

检查 for、 if、 while 和 else 语句是否使用了括号。

?2b dPZ"@0

?*P:C0b7f4PtZ!yX0 

:?TTg-F"l7m0

2.12   代码尺寸检查

1i [5y HPd)qnEg0测试过长的方法、有太多方法的类以及重构方面的类似问题。51Testing软件测试网1d5`,? R7^j#q

51Testing软件测试网!S#\6?x q5QoU

 

6g4Z w;K2MPmi8e0

2.13   终结函数检查

O5L|FeA"G qc0因为在 Java 语言中， finalize() 方法不是那么普遍，它们的使用规则虽然很详细，但是人们对它们相对不是很熟悉。这类检查查找 finalize() 方法的各种问题，例如空的终结函数，调用其他方法的 finalize() 方法，对 finalize() 的显式调用，等等。

D7y w'R7DZD0 51Testing软件测试网Ny{ l8B

 51Testing软件测试网"wg"kG9r4Pg \.?y

2.14   克隆检查

51Testing软件测试网}f8f.Y lV)m

用于 clone() 方法的新规则。凡是重写 clone() 方法的类都必须实现 Cloneable， clone() 方法应该调用 super.clone()，而 clone() 方法应该声明抛出 CloneNotSupportedException 异常，即使实际上没有抛出异常，也要如此。

QZ;|y,Y*D'Yh(y0 51Testing软件测试网2Z q/w'UuX

 

'je;P.|;j+fo L%y0

2.15   耦合检查

51Testing软件测试网k _Gvfl _t0Gz

查找类之间过度耦合的迹象，比如导入内容太多；在超类型或接口就已经够用的时候使用子类的类型；类中的字段、变量和返回类型过多等。51Testing软件测试网2V(KL fLnEKM

4[ `1z2H7u7F0 

f5JN5b:bD1Qg#l.Yl0

2.16   异常检查

Ca:GTAgM:J0针对异常的检查：不应该声明该方法而抛出 java.lang.Exception 异常，不应当将异常用于流控制，不应该捕获 Throwable，等等。

5FGoAy0Tf0 51Testing软件测试网8]8wp%I-Uh

 51Testing软件测试网7U"L9iZ5\0M3u/j"i)q!f

2.17   日志检查

51Testing软件测试网 x mjK?5RcG

查找 java.util.logging.Logger 的不当使用，包括非终状态（nonfinal）、非静态的记录器，以及在一个类中有多个记录器。51Testing软件测试网qX8u2U5WU H

51Testing软件测试网+d,K_3?Vf1mA+j*q6RY

 

3v Me/?)O0

2.18   Open��Close检查

TQr*A"t0检查文件或通讯方面，是否忘记Close的情况。

[ Z"K)Sv9A5s0

[zr#[,~]0 51Testing软件测试网3ve `A%sgX

2.19   其它检查

,|!^B@ I6Bh0其它缺陷清单可参见：缺陷清单51Testing软件测试网3y U!QH rc0U#[!u

51Testing软件测试网!v g p\*sP5?

 51Testing软件测试网%Cs%|;ldo5R+~

2.20    构建自己的规则集

M|8L.r/R ov0可以构建自己的规则集51Testing软件测试网+qe;VTg)L

51Testing软件测试网UsN`'e

 

X&ahZ3}A0

3         准备使用FindBugs

51Testing软件测试网Q3\5V"d`6^+r {

FindBugs目前最新版本是 0.9.3 。文件名是：findbugs-0.9.3.zip（Windows）或findbugs-0.9.3.tar.gz（Unix）。（下载网页）

X#f-r:` \+Cz0

0M#t/T)\B9oJ|8K0也可以到StarTeam取相应安装文件到本地，将它解压缩到所选的目录中，安装就完成了。

{hDcu5DLO0

b8nI+Bq0要运行 FindBugs，需要一个版本 1.4 或者更高的 Java Development Kit （JDK）。51Testing软件测试网$AF${7oGin

:c2@mU_;J0安装完后，要增加两个环境变量：

Cg$Z6x9n ]7p0 51Testing软件测试网-} qLlkPfe$i

FINDBUGS_HOME，例如：FINDBUGS_HOME ＝D:\findbugs-0.9.351Testing软件测试网#@.A%M"E[2qkn

51Testing软件测试网t2do2qY7c8P%p

JAVA_HOME，例如：JAVA_HOME＝D:\j2sdk1.4.2_0651Testing软件测试网 J;v#G$P(K/W

51Testing软件测试网$jt}*Rr@h-\y:{*ad

 

IP ?h0H.A0a"mO _(C0 51Testing软件测试网9R4@^#N ?\ `2x

在 FindBugs 主目录中，有几个值得注意的目录。文档在 doc 目录中，但是对我们来说更重要的是bin 目录，该包含了运行 FindBugs 的批处理文件。51Testing软件测试网5y0u Da4eogg1N

T+zc:[1r1tG0 51Testing软件测试网@-\$`|m+L(z

4         运行 FindBugs

6dx)g v\"T1JeB0像如今的大多数数工具一样，可以以多种方式运行 FindBugs����从 GUI、从命令行、使用 Ant、作为 Eclipse 插件程序和使用 Maven。51Testing软件测试网+FKO:F7r~/e

51Testing软件测试网#ump3L^M/K%t ?

这里将重点提及从 GUI 运行 FindBugs，简要提及使用Ant 和命令行运行。

pB c%`#~8F8R.V'Rv{0 51Testing软件测试网~~'bov%XPSC4`

 

8O`9si7u&M0

4.1       FindBugs UI

K@Y)S6\:H;^0使用 FindBugs UI 很直观。使用 FindBugs UI 的一个好处是对每一个检测到的问题提供了说明，图 1 显示了缺陷 Test的说明。51Testing软件测试网3ZO_f'kC7VL"e

*CK#G!| qh%f3]~a0图一：项目Test的缺陷说明51Testing软件测试网+U V|Ml(kb ~

s:A`&H!m0 

~!mh-RK;|o_0

_*R#K9j)ls!rK9xs0对每一种缺陷模式提供了类似的说明。窗口下面的 Source code 选项卡很有用。如果告诉 FindBugs 在什么地方寻找代码，它就会在转换到相应的选项卡时突出显示有问题的那一行。

5{CB Y,m6wQ0 51Testing软件测试网ZA"_ex n!U

图一中的上部有根据不同类别来检查缺陷的选项，选项有（By Class、By Package、By Bug Type、By Bug Category）。

6c3^2uoB0 51Testing软件测试网 J qU1}:P

图二是【file】选项，主要功能有：创建新项目、打开/关闭项目、储存项目、储存Bugs信息、装载Buugs信息51Testing软件测试网bo j+o2e g9OxXJ

Em$Cm'D+q0 

2k {9Y*r$nO6u0 51Testing软件测试网%uWht1vovB

 51Testing软件测试网#B @;k9L(c

51Testing软件测试网{']%f7ur/oU

图三是【View】选项，这些选项很有用，可以切换不同模式的视图。

7|0fs6Vu2G/`-W!r6]0 51Testing软件测试网,`%wWTD@

 51Testing软件测试网&Yk ad6y/\

gim/y'Y6D0 

M7h'{qs0

iq Tw2xr.V0图四是【Settings】选项，是对检测的缺陷模式进行选择。

7lGee3`z0 51Testing软件测试网B\h(x(^cM1Fb

 

-C3w"|(Ws c"i6f0 51Testing软件测试网 } h @$Bk([

 51Testing软件测试网;U4Z CF v&CH0n

51Testing软件测试网{3J$JBL5n

 51Testing软件测试网h8eY FY)v

EZp,J&ApfmJ0图五是【创建新项目】选项

I1WO }9g`$q%vU0 51Testing软件测试网"o k$\n/H

 

o{.I#Kb0

~0j#@e/m:i9\2]0 51Testing软件测试网xu7L6F*y3S n-R

51Testing软件测试网^ ~4?K Y4U}jog f

 

:K?(r&t)K&K+\tD0

4.2       使用 FindBugs UI步骤

^s K{'V0第一次使用51Testing软件测试网NFSDWw~

51Testing软件测试网h(D8F/[X9co

（1）       依照图五【创建新项目】选项说明，先创建新项目，输入被检查的class或jar路径、java源文件路径及程序运行依赖的class或jar路径51Testing软件测试网]"x1a(@8N#[6`/Jn

w7iWt.x~nM1V&U7M0（2）       按【FingBugs】按钮开始检查

9p"a7`1o-EG*}0 51Testing软件测试网Y Y H G M w%Dk y;Z~

（3）       如果出现下图六的警告51Testing软件测试网5E]M4p:_,l#_a%M_/e

51Testing软件测试网)q$m'DW8w

 51Testing软件测试网MM,j/q MJ I

F*g,|2Gd*d^pob0说明程序运行依赖的class或jar路径不对或依赖文件不完整，应依据警告信息完善。51Testing软件测试网8Wk)K;H$I)}n"f

51Testing软件测试网P1tq)F-[vTW;Rno

（4）       按【OK】后即进入上图一的错误信息显示51Testing软件测试网-m7iM }a'YR `+e |

U6{9V f#W,f0（5）       选择【file】储存新建的项目

;\2X5M zf0 51Testing软件测试网 u#u-TR[ yON

（6）       选择【file】储存新扫描的Bugs信息（xml文件）

{J#B-QTn&ob0 51Testing软件测试网A9KqV!f,H6W] w p

 51Testing软件测试网tkEL.I-A |

#k$P8J:]V(x y0非第一次使用51Testing软件测试网6q3[@|0G7T'l!hP

51Testing软件测试网 d|u&QW}n

（1）       选择【file】装载上次新建的项目并运行51Testing软件测试网pkCYty,h{ `(H

51Testing软件测试网-r%a4J&f1Fi9S

（2）       也可以选择【file】装载上次储存的Bugs信息来查看51Testing软件测试网d SPs Y"Dd@zrN

.RS)K(P#Q Z x [h0 

b.M ^Zpb#Jq0 51Testing软件测试网? k-s[(EZY

 

7l([:~2Y3B~:k0

)~H,ljN$L(? Be0F0值得一提的还有在将 FinBugs 作为 Ant 任务或者在命令行中运行 FindBugs 时，选择 xml 作为 ouput 选项，可以将上一次运行的结果装载到 UI 中。这样做是同时利用基于命令行的工具和 UI 工具的优点的一个很好的方法。51Testing软件测试网 tI,AwPU$P^l

51Testing软件测试网&U7G4b9a^+X8H*P

 

A`Ka W(l0

4.3       FindBugs 作为 Ant 任务

51Testing软件测试网QA3X,w`JM

如何在 Ant 编译脚本中使用 FindBugs？首先将 FindBugs Ant 任务拷贝到 Ant 的 lib 目录中，这样 Ant 就知道新的任务。将 FIND_BUGS_HOME\lib\FindBugs-ant.jar 拷贝到 ANT_HOME\lib。51Testing软件测试网%B4Tf*n-p

51Testing软件测试网n,jt0hjE

现在看看在编译脚本中要加入什么才能使用 FindBugs 任务。因为 FindBugs 是一个自定义任务，将需要使用 taskdef 任务以使 Ant 知道装载哪一个类。通过在编译文件中加入以下一行：51Testing软件测试网M!~ j8|7\ |@ V

(Q`S@b3s-E x/T051Testing软件测试网 ~~}~ _yFA

51Testing软件测试网 A"~~ K!d l

在定义了 taskdef 后，可以用它的名字 FindBugs 引用它。下一步要在编译中加入使用新任务的目标，示例如下：51Testing软件测试网.k$i#D%w4F0?M

UFk"K}_5`B01 

8s*K i w!TC L-U,f2N0 51Testing软件测试网QF/D%u_dm

2             51Testing软件测试网t?s9H4Mh u^7~

Y#aF'Ni+t;K+J;t0home="${FindBugs.home}" output="xml" outputFile="jedit-output.xml">

pp [&sva,i#jv u0

)W)E/ff*w [03         

T#b@%^$d0w[0 51Testing软件测试网Tk?5V ^sS

4         

"V9A8]H)Q/Ya O0 51Testing软件测试网V[e9kzA2t

5          51Testing软件测试网-G/f0P5vrz

51Testing软件测试网VEOi d

6      51Testing软件测试网 B;?K?`o\

p,lO;Fm07 

w&y%og\iJa$iq0 51Testing软件测试网?(Bu v1J_c d$P

第 1 行： 注意 target 取决于编译。一定要记住处理的是类文件而 不 是源文件，这样使 target 对应于编译目标保证了 FindBugs 可在最新的类文件运行。FindBugs 可以灵活地接受多种输入，包括一组类文件、JAR 文件、或者一组目录。 51Testing软件测试网 ]L1wqB$q R N

A z5B'g+i q0 

dD&y?%?YWcg|0 51Testing软件测试网 |~.RB5O^1h

第 2 行：必须指定包含 FindBugs 的目录，我是用 Ant 的一个属性完成的，像这样：51Testing软件测试网a\Q-r}C

51Testing软件测试网6^ Wr"D;Egg

0.7.3" />51Testing软件测试网4{t@ ?;sHe1j

51Testing软件测试网}#Z(tCV.]7?#]

可选属性 output 指定 FindBugs 的结果使用的输出格式。可能的值有 xml 、 text 或者 emacs 。如果没有指定 outputFile ，那么 FindBugs 会使用标准输出。如前所述，XML 格式有可以在 UI 中观看的额外好处。 51Testing软件测试网^{2?p bPZ

51Testing软件测试网7xrz:qv

 

b3m&}+XI Q4W!J0

l%KF$lg3J?0第 3 行： class 元素用于指定要 FindBugs 分析哪些 JAR、类文件或者目录。分析多个 JAR 或者类文件时，要为每一个文件指定一个单独的 class 元素。除非加入了 projectFile 元素，否则需要 class 元素。51Testing软件测试网 K(\tCAO,@3K

51Testing软件测试网Q5Khmix*@~|M

 51Testing软件测试网z C]j0l(cU4v ]

51Testing软件测试网/i*R4L9H!A*{*s0qP+D0O

第 4 行： 用嵌套元素 auxClasspath 列出应用程序的依赖性。这些是应用程序需要但是不希望 FindBugs 分析的类。如果没有列出应用程序的依赖关系，那么 FindBugs 仍然会尽可能地分析类。与 class 元素一样，可以在 FindBugs 元素中指定多个 auxClasspath 元素。 auxClasspath 元素是可选的。 51Testing软件测试网 Hnt OM'm

51Testing软件测试网%j^ dH\vds,l

 51Testing软件测试网0wyXx4XF

L7P2[{1U;cU,fE0第 5 行： 如果指定了 sourcePath 元素，那么 path 属性应当表明一个包含应用程序源代码的目录。指定目录使 FindBugs 可以在 GUI 中查看 XML 结果时突出显示出错的源代码。这个元素是可选的。

Z0a ^JRc0

k2f7}.r9B0 51Testing软件测试网5z9wmO8h`

5T[2M I'FDS0 

~,FA6t/Er\&t Q3]0

5         其它分析工具

RkC `*Eq$E#Wo2P0除FingBugs静态分析工具外，还有PMD和Checkstyle，FingBugs、PMD和Checkstyle三个工具各有不同的特点，联合使用有助于减少误报错误，提高报告的准确率。51Testing软件测试网3c$U#c2R(Bb

%A8sB!_:S{J P$]!O0这三个工具检查的侧重点各有不同：

8O"KB@ us0

工具51Testing软件测试网/n0Z9]I+f0w.@

目的

9n"s$R uK0

主要检查内容

(A|5O7o&s zB0
51Testing软件测试网}i+a7~+e$ks}

FindBugs51Testing软件测试网2eUEi };z }s/P;dD

J3[1P ?(gH+V5t'{lm4F0基于Bug Patterns概念，查找java bytecode中的潜在bug。在目前版本中，它不检查java源文件。51Testing软件测试网R%a`Enve

t)tdV,xnzy0主要检查bytecode中的bug patterns，也允许用户自定义特定的bug patterns。51Testing软件测试网 QjS^*b*z+L
51Testing软件测试网?o4L i {1j.y$F*S

PMD51Testing软件测试网 |9u(f6W&K%LP,[&Y.\

7Q J#t%p B `f0检查java源文件中的潜在问题。51Testing软件测试网^i5D `2Wogy

#[*B.O yPo@0主要包括：51Testing软件测试网 s:f {iFj6zj'fT6hA

0kbO [ |p:M~.VwV#J0  -   空try/catch/finally/switch语句块

-[|1aq]p0

+zZ9kB-O(v"q0 -        未使用的局部变量、参数和private方法

roju ^Q0cMa0

)F0q-R&W#@&k[0 -        空if/while语句

k*D ueS1yt0 51Testing软件测试网a CxJ9v"A6@

 -        过于复杂的表达式，如不必要的if语句等

dIhAq{.X g(tUGu}0 51Testing软件测试网0Bl {wxe

 -        复杂类

GLN4K9dH!?j0
51Testing软件测试网;zztv.~A

CheckStyle51Testing软件测试网'R`fE(C @2Y

 51Testing软件测试网2kPeUA'?aQ5M Q

检查java源文件是否与代码规范相符

"c/B2R'N$c1r5K0 		51Testing软件测试网+XC%YQ`NK

主要包括

:N6e/\"N2Z0 51Testing软件测试网`q8?3YnA

 -        Javadoc注释51Testing软件测试网gRE{&e{F6Yr

51Testing软件测试网? I1]RBy

 -        命名规范

I YE(Bh|&~;ghk(}0

2@.j%~*H3[e!E0 -        Headers51Testing软件测试网&ET k4t7u+sT2i

51Testing软件测试网3T7\EH8z-m3]v%UP

 -        Imports51Testing软件测试网9c;S jBBh(c&y\

Js$JqF0 -        Size冲突和度量，如过长的方法51Testing软件测试网TL4D,^ | ded m3m `

,O8[$}zhu0 -        Whitespace

(J-F1~m)w`;_(R$}*_Q)x0 51Testing软件测试网d$W6~1N;]m M7X

 -        Modifiers51Testing软件测试网p|[)U]lM

[ [9t S+m`&ulPoO0 -        Blocks

o)h!]9v*By4t+n0

\$Eh(l]0 -        Coding Problems51Testing软件测试网CGeD(m

#X:@(}:Z c9S z0 -        Class Design

q |!C1BBO0

y'N;V+`&?%X8AB0 -        重复代码

&y0V-F0A8O Y3u jS0

;|R:h+d({W0 -        Miscellaneous Checks

3P'|9i$zh4i0g$@P:a0 51Testing软件测试网&P5|)R~h9_i

 -        Optional Checks

N3p)R-Li Y/k0
51Testing软件测试网:t#jW4ug![ [u#E

 

3L#LeTm0 51Testing软件测试网.@5[H"k-~a [B

 51Testing软件测试网W4u&? Le6gL@O

5.1       PMD工具

51Testing软件测试网_1is7b&GJ$b8Ke;cv

PMD工具目前最新版本是V3.3(下载网页)。

mIr rc:L0

_4O qP9p&tu0PMD的运行环境是j2se1.3或以后版本，安装过程同样也是解压即可。

.Lv+]$ul/A#D `g!D0

5.1.1 Ant task的使用

$t ]2l8}niC0mE"{0（1）       把lib中所有的jar复制到项目的classpath中。

&C8^P:yjk#F5i8R0

#}1DS1|V4\2g c6P0（2）       将pmd-2.0.jar中的rulesets解压到指定目录，这里面定义了分析所需要的规则集合。51Testing软件测试网l7zOf Uv

3QD4U7u9D!pr|0（3）       修改build.xml文件。在这一版本中，提供了2个ant task。一个是pmd使用规则集合进行分析；另一个是检查代码中Copy & Paste代码。这2个任务对应的ant task使用：

*x`I,H%V X0 51Testing软件测试网spHK$Y;e

PMD任务：51Testing软件测试网USE]5tLY-Mc0Bk

51Testing软件测试网 h1RGB oDX IA

   

Z@7|:u5uP c"F;U0 51Testing软件测试网U{)?;rk ]8UQ&S

   

/M4K}mY:J j0

1ul D.TH0e#i"B#HS n0       

}(jO$H8?py cxx0

"|zp"Mo0                        classpathref="classpath"/>51Testing软件测试网vGe4jh,bcu ?

51Testing软件测试网0m'Knh.n[

     51Testing软件测试网5OF'QY"Xtw

dG3L_O.K X5wY A0        51Testing软件测试网7d4Cc \7B @S

51Testing软件测试网KPE.e:f#r

        

l4Iy$i0j0 51Testing软件测试网m TiZ/G

           

p|'b6bX`l2s M6`0 51Testing软件测试网U.o2Ux1}7e P!k+{

         51Testing软件测试网!S,xwEK

~A5t!b] N:PW$m$t0           

6e|2z-E&r,\?*r0

aJ6x'xBS0        

.sZ\@1i{7]$s0 51Testing软件测试网%r'G%t+e { dlV D!g

            51Testing软件测试网:q$t"jv7\$hk!@w?

51Testing软件测试网_KGu gL9`

                51Testing软件测试网k`I$VM A

M OT5pG$DA0           

!sDj |O _R2B N0

V4Jzk5u"I @I0       

S pkor,l f(g/W#S1a0 51Testing软件测试网,oq.yM'v`4P^

   

pb:sC(O?/[!xy0 51Testing软件测试网H i'd"}e

CPD任务：51Testing软件测试网` K;\s/t

Tkj3fd.a^E&U051Testing软件测试网%jn5g{~ z

2d|dX}!d4u^%DV0     51Testing软件测试网h_CNh4O L^

51Testing软件测试网 }V6s`8`

       

`UB[%y^0

)K\r6e D |9Y0                            classpathref="classpath"/>

KTCm} M#}?P r0

VuMVn.A$F6s0     51Testing软件测试网t_3AEG:}CW

)[ M X,F;r)}0        51Testing软件测试网V ll1E:el%w

Mj}tl)Z0         51Testing软件测试网]{:`2|%f(tD)m5vK

51Testing软件测试网 ]A3p#|a:{6DP!@

           

5Cxn9DX}h!I3`0

oR]k a5I$Z [L0                51Testing软件测试网*[]PEK^Z

51Testing软件测试网v |o LC*a J8u#ax

           

[8~2\j:\#_*if5w0

g;j!b3Q1c~V"J0       

'i Z l!WTf0

4I|U'yO0B k6_0    51Testing软件测试网 j8A8U+MVT

51Testing软件测试网T-m\t$I{g

（4）       运行ant pmd和ant cpd即可。51Testing软件测试网4y7ddZ3?3S

1vjjX$a9A$M] N0（5）       参数说明：

&B3TS@7a1j0}(J`w0 51Testing软件测试网2P.J;~+]-T2U']

-        formatter，指明输出格式和文件。

hhFQ9E1Gq-f0 51Testing软件测试网.hy.B rh1|g

-        rulesetfiles，指明分析所需的规则文件，不同文件使用逗号分隔。

@0n:K+N+mi8J0

ZVVh2\ n!}0-        failonerror，pmd执行出错是否中止构建过程。51Testing软件测试网#R{~&[FC

51Testing软件测试网.OmZo9ivmN

-        failOnRuleViolation，如果与规则冲突，是否中止构建过程。

2j-^E y9rt.kY0 51Testing软件测试网 w8}ni,{

-        classpath，pmd所需的classpath。

az"_b f4q+Js)zp0 51Testing软件测试网5B9y(z#f6NsR'p6F&BKX

-        printToConsole，在发现问题时是否打印到ant log或控制台。51Testing软件测试网d+l-K-D:e^

51Testing软件测试网Z Cpw6Cs2p

-        shortFilenames，在输出报告中是否使用短文件名。

)gp?;F&d2x]0 51Testing软件测试网J#l[F%^C

-        targetjdk13，是否把目标定为jdk13，如不能使用assert。

U*sq }Nz)o0 51Testing软件测试网']%]&\.}6|?U+w

-        failuresPropertyName，在任务结束时，插入违反规则的号码51Testing软件测试网2P-b\7wUrr

0g,x&hNL,R9z'j0-        encoding，读源文件时所采用的编码，如utf-8。51Testing软件测试网'C O w@K4q os

51Testing软件测试网 YG(Y%l4u/I

 

'A a(}(j4IwpV0

5.1.2 Text的使用

51Testing软件测试网.H*}e Orrr[%N1n

把bin目录下的pmd.bat修改为：

8v'Xu,h9u(b)m0 51Testing软件测试网0^:`;Dd'ffv[.Y,F

java -jar ..\lib\pmd-3.3.jar D:\temp\hpMTS_2.jar[HUANGXB1]  text[HUANGXB2]  rulesets/basic.xml[HUANGXB3] ,rulesets/braces.xml,rulesets/clone.xml,rulesets/codesize.xml,rulesets/controversial.xml,rulesets/coupling.xml, rulesets/design.xml,rulesets/favorites.xml,rulesets/finalizers.xml,rulesets/unusedcode.xml,rulesets/sunsecure.xml,rulesets/strings.xml,rulesets/strictexception.xml,rulesets/scratchpad.xml,rulesets/optimizations.xml,rulesets/naming.xml,rulesets/my-rules.xml,rulesets/logging-java.xml,rulesets/logging-jakarta-commons.xml,rulesets/junit.xml,rulesets/javabeans.xml,rulesets/imports.xml

;lq-UL:g"|F0

o&gh6v7`A]sZ_0 

7xg(M,K5Y8}m s0

5.1      CheckStyle工具

51Testing软件测试网)n0l#}6_Sj J"k }` ky

CheckStyle目前最新版本是: checkstyle-4.0-beta6（下载网页）。51Testing软件测试网vC7Ez!UoD:o H? U

51Testing软件测试网 h4q\"G3T0sOd8^F

CheckStyle的运行环境是j2se1.3或以后版本，安装过程同样也是解压即可。51Testing软件测试网/Y\w5zRm!C4stA

2TJb~}I Z0 

/d}9a VG L6oR t0

5.2.1    ant task的使用

f#x A2J d lA0（1）       复制checkstyle-4.0-beta6.jar到项目的classpath中。

C/o|| y)M DS*P0 51Testing软件测试网2IXo!Bwgq A(P D

（2）       修改build.xml文件：51Testing软件测试网 KU r0v4h

51Testing软件测试网I9dW n] r:q(oo\'y u

:}j[%W'N%V0 51Testing软件测试网"~:m#hB;y0AA,W)~~

       classpath="${weblib.dir}/checkstyle-all-3.3.jar"/>51Testing软件测试网A#D.M D"E)I R;T

'Zo Ll.ka&G8D"D |051Testing软件测试网d!EMbuQc4z:y

51Testing软件测试网j5\iI2v-W]d6LML

       

d W T7]+chWx m"W U0b0

.}%H r]/~ ?.zE @Ny0        51Testing软件测试网S&pYFM N0Il

)N6q-R~ m*oj"H0           

n4F%k2t0W-q5H0 51Testing软件测试网s\ h+mJJu

            51Testing软件测试网 jQ)J ft3hea*[

51Testing软件测试网3oB7R]oQN g

           

(@x8]9W)y0

zk#S\)VB{i9V D0            51Testing软件测试网+sN)H,BB.zGZ| g

51Testing软件测试网nh,j9]-G}

        51Testing软件测试网7?i.Oj4zI'vl

/n8t7F C{"n3Me0        51Testing软件测试网'Q\&by:H6H5Si?e|

x7r#VO~d0