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

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

上一篇 / 下一篇  2007-07-12 12:19:40 / 个人分类：其他

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

Java代码缺陷自动分析工具介绍51Testing软件测试网$Ye$C{T E g

7yIupjiNg?z0                                                                                                    黄锡波

PT`O8qP(_0 51Testing软件测试网#]|FN,pP {

Java代码缺陷自动分析工具主要有：Findbugs、PMD和CheckStyle工具。这里重点介绍Findbugs的使用，简要提及PMD和CheckStyle工具的使用。

c!i;z`*b(vKO~_0

1         FindBugs是什么？

p-e C g r'oZ L0FindBugs 是一个java bytecode静态分析工具，它可以帮助java工程师提高代码质量以及排除隐含的缺陷。

!Y8mMf5}D W5XKjU0

]0z d(O;G8J9S0FindBugs检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。51Testing软件测试网#Z{;{L&U.W

HH&A.MH{Uoae.uD0有了静态分析工具，就可以在不实际运行程序的情况对软件进行分析。FindBugs不是通过分析类文件的形式或结构来确定程序的意图，而是通常使用 Visitor 模式进行分析（Visitor 模式的更多信息）。51Testing软件测试网L8GKMLb,u0D

51Testing软件测试网&S5S,|1JX EPF

 

N N5Y] ]C#x ]0

2         FindBugs可以做什么？

51Testing软件测试网O"ZD!x&I9{S

FindBugs提供了35个检测器来检测字节码中可能的缺陷。可以做的事情主要有：51Testing软件测试网#i Vy Eh Kr0C+{

2.1       找出 hash equals 不匹配

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

)| ^`:Um&C wyyn0 51Testing软件测试网Vj tK'L9t `6P

①当一个类重写对象的 equals() 方法，但是没有重写它的 hashCode 方法，或者相反的情况时。 51Testing软件测试网,ey5T? d7m"bVN

51Testing软件测试网3i@ IX2w K@1w

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

51Testing软件测试网[ G5\2Iy

 51Testing软件测试网 f$M4Z$Bn-_

2.2       检测：忽略方法返回值

D-hzu7L$w(d4O+q+m0这个检测器查找代码中忽略了不应该忽略的方法返回值的地方。这种情况的一个常见例子是在调用 String 方法时，例如:51Testing软件测试网AiTgn

&a"LlZ G'm"Z,a(y'A01 String aString = "bob";

wt-v#Fn Q/kq7cV0 51Testing软件测试网F;}0T} o&bez(_

2 b.replace('b', 'p');

0? T`gx4W5fg)i0

4E.G-RP&p-D03 if(b.equals("pop"))

pP9V~T-h0 51Testing软件测试网W7Y)G@2tk v c

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

?9puO fA5Q1V/hzf0 51Testing软件测试网Pyih8c!p@2~/e-X5U&BN

 51Testing软件测试网(ZW+GrK2o

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

51Testing软件测试网IIl%r|#v

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

;fa2u,Ux2S~D;e01 Person person = aMap.get("bob");

9WkZo$r4f5vS0 51Testing软件测试网.E'dF&[1RHO9r[0S(Ii

2 if (person != null) {

qB9t l%d Ln#D B G8C0 51Testing软件测试网p/D0j7t\!lg*n

3      person.updateAccessTime();51Testing软件测试网%mu0z [:^/`rsk5|)z

4} xIN%uLc^5{04 }

C V*VMM^C2r{5O0

-s;F+Z,V'E0n!QH05 String name = person.getName();

(zW5t:bs U.RL_ @0

2KT8x x M^&y @!W:H:`p*a0在这个例子中，如果第 1 行的 Map 不包括一个名为“bob”的人，那么在第 5 行询问 person 的名字时就会出现 null 指针异常。因为 FindBugs 不知道 map 是否包含“bob”，所以它将第 5 行标记为可能 null 指针异常。 51Testing软件测试网 G-g*K%V*@wh CPO

P4X x1{wFs_0 

.xrUs[7[-}0

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

L |&@])bh0这个检测器寻找在构造函数中初始化之前被读取的字段。这个错误通常是由使用字段名而不是构造函数参数引起的，例如在构造函数中读取未初始化的字段:

E Gk9P%Jq1J0 51Testing软件测试网C4q7Y'{|g^#M }`(X

1 public class Thing {

3CcC4\&Le @0 51Testing软件测试网4T*hu Pry3d*C Y

2      private List actions;51Testing软件测试网KL {.ak

4]8NG&f1S{r03      public Thing(String startingActions) {51Testing软件测试网|/dt.K+_)Fxi

#Y_!Kj}pE04       StringTokenizer tokenizer = new StringTokenizer(startingActions);51Testing软件测试网 Tr3y3Ro;C

bSpFo05          while (tokenizer.hasMoreTokens()) {51Testing软件测试网} rFO7MW+`2l:PF

v(Od:Fm'D9abD.d#N^06              actions.add(tokenizer.nextToken());51Testing软件测试网#NK@.S2PP

51Testing软件测试网!Y5[pM(kO4A b9c&[

7       } 51Testing软件测试网I4}4u.v!\/z

ke @ md.j]!U%]:q,x08      }

(m mK q Y'?0

F%Uvu/O:sX&[09 }51Testing软件测试网f%~;d3Jp4@2? a

51Testing软件测试网o OPjO:N Jr

在这个例子中，第 6 行将产生一个 null 指针异常，因为变量 actions 还没有初始化。

&~hI7UTDG&S9kp|%q,}0 51Testing软件测试网5bs:} p-p.?#_m;I

 

7Ng7mXU0

2.5       命名检查

k g\ f-M0对标准 Java 命令规范的测试：变量名称不应太短；方法名称不应过长；类名称应当以小写字母开头；方法和字段名应当以小写字母开头，等等。

bn vJP.[o0 51Testing软件测试网W1G%R"{}3n ^#kWq

 51Testing软件测试网+j$X/X1@(^_*bA

2.6       未使用的代码检查

51Testing软件测试网6i`HH&h\5V

查找从未使用的私有字段和本地变量、执行不到的语句、从未调用的私有方法，等等。51Testing软件测试网CR W/SG#t;|PHZN

51Testing软件测试网R6Z(B i~ SN%k~1]

 51Testing软件测试网'MX/mPk)u(BySS

2.7       嵌套检查

51Testing软件测试网8S&j(Z,rfM-Ax/H)f+v

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

3g;H EahXr]0 51Testing软件测试网,Lq9qW&\]3uE k

 51Testing软件测试网 dOG9ND4fJ^L9X

2.8       导入语句检查

51Testing软件测试网.|j|,u R$^$T-rJR

检查 import 语句的问题，比如同一个类被导入两次或者被导入 java.lang 的类中。

N0_9HI;U"?X0 51Testing软件测试网v/b)m~`,Y

 51Testing软件测试网\ \:B.f2v W-x

2.9       JUnit 测试检查

51Testing软件测试网DY ? h0jan|;y

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

t.b,Wx+s'V7_0

ScH:fP1H RQ%M0 

q~%\-I z\ @ _0

2.10   字符串检查

,xyY4S.R0找出处理字符串时遇到的常见问题，例如重复的字符串标量，调用 String 构造函数，对 String 变量调用 toString() 方法。51Testing软件测试网 n8n,lH$D ] \5Ae

51Testing软件测试网;N:a7]X`s]$sp

 

.nI Gc(\dz/Q0

2.11   括号检查

51Testing软件测试网 ?'?|(?:S9H

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

&c&jF.X!{B2p _0 51Testing软件测试网y+B/HU7|J"eW

 

a?[}6yM2E9H9u0

2.12   代码尺寸检查

51Testing软件测试网F#c9T)J'?L0\/k.~

测试过长的方法、有太多方法的类以及重构方面的类似问题。

(ukh~&j0 51Testing软件测试网.ZQ `G+vB

 51Testing软件测试网,XS6^3i;Ot(o|'Fu7_

2.13   终结函数检查

51Testing软件测试网FtZ3AIa `p'^

因为在 Java 语言中， finalize() 方法不是那么普遍，它们的使用规则虽然很详细，但是人们对它们相对不是很熟悉。这类检查查找 finalize() 方法的各种问题，例如空的终结函数，调用其他方法的 finalize() 方法，对 finalize() 的显式调用，等等。51Testing软件测试网k+d G"j3wx sS_3EE

Vfiz^3|d})].Q0 

ZQ.M`:^_0

2.14   克隆检查

$E6f%bAxr L,Z0用于 clone() 方法的新规则。凡是重写 clone() 方法的类都必须实现 Cloneable， clone() 方法应该调用 super.clone()，而 clone() 方法应该声明抛出 CloneNotSupportedException 异常，即使实际上没有抛出异常，也要如此。51Testing软件测试网M(O;YFc4DF+p"M

51Testing软件测试网)ZW BO*h

 51Testing软件测试网+zj`&HF;L5FHV{

2.15   耦合检查

3OC.C3E4s#PY0查找类之间过度耦合的迹象，比如导入内容太多；在超类型或接口就已经够用的时候使用子类的类型；类中的字段、变量和返回类型过多等。51Testing软件测试网Z1ZP(eS1Ib`1o\H

;J7Zu[.J?0 51Testing软件测试网+H3C dJ%{K }

2.16   异常检查

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

F7etf]E;I+R?@0

^DQ][zI7_0 51Testing软件测试网@4y/s!Vj7{T [8| K-x

2.17   日志检查

51Testing软件测试网M8afunexR F

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

1\R6xmq)AE0 51Testing软件测试网8Hc{%PT$M uQf

 

!ZB$M7n!J0Q t0

2.18   Open��Close检查

51Testing软件测试网-O QO5eY;Q dh+G

检查文件或通讯方面，是否忘记Close的情况。51Testing软件测试网:lx'd7x7g:ks._Z&K

E+Ye1E4K nF l!p0 

}!n]3y5Uz0

2.19   其它检查

{#_^U$X"w/ZYR%LT|0其它缺陷清单可参见：缺陷清单

2CF.}Di&z0

B+J'a;{6n0 

K!rDn5b0

2.20    构建自己的规则集

}d@^ [8\P GO0可以构建自己的规则集

!?;sp1@pp,ot.B yI0 51Testing软件测试网^T/Q*i@S4M2o

 51Testing软件测试网U9](nka

3         准备使用FindBugs

.V\ j&k&O3i0FindBugs目前最新版本是 0.9.3 。文件名是：findbugs-0.9.3.zip（Windows）或findbugs-0.9.3.tar.gz（Unix）。（下载网页）51Testing软件测试网YyS/A3yt n

-t%sSZlmP!m%l\0rbg0也可以到StarTeam取相应安装文件到本地，将它解压缩到所选的目录中，安装就完成了。 51Testing软件测试网)Xu f;m,rwf]ge

51Testing软件测试网jT T(^oeln

要运行 FindBugs，需要一个版本 1.4 或者更高的 Java Development Kit （JDK）。

nayj f"mTKH5~0 51Testing软件测试网_2E#a!}AZy-vO

安装完后，要增加两个环境变量：51Testing软件测试网 Dhd b0mU9c3Kp;U

51Testing软件测试网D)p(m:Z.L*P6J5I2T

FINDBUGS_HOME，例如：FINDBUGS_HOME ＝D:\findbugs-0.9.3

+DtY.t;s0v;GGI0 51Testing软件测试网{%X [}Mf9P!n"m[

JAVA_HOME，例如：JAVA_HOME＝D:\j2sdk1.4.2_06

Jy LJ)xr\0

9W G+az1X V0 51Testing软件测试网;B3IP"W*yri6GL

?L6LAbb5p0在 FindBugs 主目录中，有几个值得注意的目录。文档在 doc 目录中，但是对我们来说更重要的是bin 目录，该包含了运行 FindBugs 的批处理文件。51Testing软件测试网 i"d&ny;JX ?5XH

;n0pYS6f)M$i1XR_W0 

l)Y~5ElY/j0

4         运行 FindBugs

U*l4}Q]i F0像如今的大多数数工具一样，可以以多种方式运行 FindBugs����从 GUI、从命令行、使用 Ant、作为 Eclipse 插件程序和使用 Maven。

NXpM Oj+p*m8I~"m+]0 51Testing软件测试网H0vf&gFV

这里将重点提及从 GUI 运行 FindBugs，简要提及使用Ant 和命令行运行。51Testing软件测试网1Rb0V-U6iJu&`

&Q g%rK)BzK G!Ld0 

xE;jyt a?.g*f0

4.1       FindBugs UI

51Testing软件测试网3jy.hX kD/s

使用 FindBugs UI 很直观。使用 FindBugs UI 的一个好处是对每一个检测到的问题提供了说明，图 1 显示了缺陷 Test的说明。51Testing软件测试网 ~$T$I?#W}

51Testing软件测试网}y2f*mQU5W kD

图一：项目Test的缺陷说明51Testing软件测试网/QGf|0b H

51Testing软件测试网8`Yg9Tv ^2v

 

|{4Ss.a+HtpX0

o)A;]8i ?/w|5D h]-Pe0对每一种缺陷模式提供了类似的说明。窗口下面的 Source code 选项卡很有用。如果告诉 FindBugs 在什么地方寻找代码，它就会在转换到相应的选项卡时突出显示有问题的那一行。51Testing软件测试网.`b;f2\? ]

51Testing软件测试网CJN*Z w x%~

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

+G%Y4g7VD2~0pu*A0 51Testing软件测试网Q%j WV7z3M

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

51Testing软件测试网H9}5R7CsR Y

 

5g)} W;n+oqF0 51Testing软件测试网na cG*y]

 51Testing软件测试网%@c/aE"v2Q

51Testing软件测试网/D"k'b8]T9x9E

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

U!^k+p pYd8l0 51Testing软件测试网(PA |u"EB&U0?

 51Testing软件测试网4C{B4x8p3f

4xH#E0J_0r2B*Q0 51Testing软件测试网K9|0E] w!a5V%oBLd

51Testing软件测试网 L`:GvE0de%G

图四是【Settings】选项，是对检测的缺陷模式进行选择。51Testing软件测试网sn&f(p o[;z

'zIkJ4F0i [0 51Testing软件测试网'lJ U%~:xf0QD$d

V8@*J;k;@ XrU0 

ifp9B+Cq,^n0 51Testing软件测试网,B$qdy^D7X$p

 

lE&lET#KW J0

vA7\D'm0图五是【创建新项目】选项51Testing软件测试网)lB+^~E:y&g

9N/c8K'R |'g0 51Testing软件测试网;MH*l^D4_o O{&j

51Testing软件测试网^4j'Ws)Gu5y`p

 

Qzu*cL$dt#{0

O zD(K1ZY0 51Testing软件测试网6j-JI(u*j({ QO

4.2       使用 FindBugs UI步骤

7i,q4?Db0第一次使用

;G${8H-q b0 51Testing软件测试网l&v6o+rf8hPL2j

（1）       依照图五【创建新项目】选项说明，先创建新项目，输入被检查的class或jar路径、java源文件路径及程序运行依赖的class或jar路径

B;`q)da i0 51Testing软件测试网s(H/j%F3MWQ$RZ"~

（2）       按【FingBugs】按钮开始检查

`e6U&f9h{)M$y5r0 51Testing软件测试网s$[.F9L3PL'XTR

（3）       如果出现下图六的警告

+n0uID#d!@]{:u&rn.Z0

DS a;tY@s0 51Testing软件测试网v2i%o7B3FM7ozJ_

5D6wZt(N4s0e0说明程序运行依赖的class或jar路径不对或依赖文件不完整，应依据警告信息完善。

C9fZG I"^d*~Y0 51Testing软件测试网3_/v*Ik }T

（4）       按【OK】后即进入上图一的错误信息显示51Testing软件测试网7ngH \;y&pE

| BR,L X%dJr0（5）       选择【file】储存新建的项目

[)h9r&P4o(P3J0 51Testing软件测试网6H]`5NN#^

（6）       选择【file】储存新扫描的Bugs信息（xml文件）51Testing软件测试网MR.@/K @^+_

51Testing软件测试网Cqn9t ]*Uwt

 

!Ja"D-Z6E0

Jr+n)]N8]0a0非第一次使用

Q#f8q cGN2P4F(Z&Y0

{2l8YV@*J oj8G0{7x%M0（1）       选择【file】装载上次新建的项目并运行

k7n;C9|8k4{0 51Testing软件测试网7g8B/eAx:y`Jp

（2）       也可以选择【file】装载上次储存的Bugs信息来查看

im2r0{'u/i(fZ}8p0

$LI5c2N0?3Z0 51Testing软件测试网Jr g-|2j/`NaA8s)s

51Testing软件测试网 Y!Pz!WW

 

!X2})T k$ge0

w9`Bn}-Hv0值得一提的还有在将 FinBugs 作为 Ant 任务或者在命令行中运行 FindBugs 时，选择 xml 作为 ouput 选项，可以将上一次运行的结果装载到 UI 中。这样做是同时利用基于命令行的工具和 UI 工具的优点的一个很好的方法。51Testing软件测试网J_ uGG

51Testing软件测试网#G-}z-]3M7u|!F_(`

 51Testing软件测试网?;GBx'M t/^T:[p

4.3       FindBugs 作为 Ant 任务

51Testing软件测试网"[`l E8q(pO/A

如何在 Ant 编译脚本中使用 FindBugs？首先将 FindBugs Ant 任务拷贝到 Ant 的 lib 目录中，这样 Ant 就知道新的任务。将 FIND_BUGS_HOME\lib\FindBugs-ant.jar 拷贝到 ANT_HOME\lib。51Testing软件测试网4x$zIE:C:U

51Testing软件测试网 L)X*I veo+@;B

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

*H3L"]"Ii+DV3\0

LF nx$WG0

9y%z"F(i ~HcE }0在定义了 taskdef 后，可以用它的名字 FindBugs 引用它。下一步要在编译中加入使用新任务的目标，示例如下：

w8X#p0H\&BnP0 51Testing软件测试网TCgx[%B9j @

1 

4v _v-y}E&|J0 51Testing软件测试网(C*z!BDn!a

2             51Testing软件测试网z#Oe ||:J

51Testing软件测试网 R!F a!C0_

home="${FindBugs.home}" output="xml" outputFile="jedit-output.xml">

C&]%SIPv$u,]4c0

.hM"m1P-E^03         

f6^G(C-J)Z&qXP0 51Testing软件测试网-O|j0T*eM5N g%gNl

4         

SxO WFOM0 51Testing软件测试网"?0gA tn'hj

5         

2W$Ikg*[E7R8]0

7CE_*}k NbG&@i06      51Testing软件测试网![#LC {(V

Ik+FgzEG"` yN G07 

DmD(YG^#v.A0

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

%h(R4E+D$kt:_XOE0

t s+W#U2[N/~0 51Testing软件测试网1e](C B&Z

51Testing软件测试网U~\.ONY6^9o

第 2 行：必须指定包含 FindBugs 的目录，我是用 Ant 的一个属性完成的，像这样：51Testing软件测试网zO1KW|

51Testing软件测试网b o h-q;p;O eW-b

0.7.3" />

fn7B4L-a4[a:@0

8C#I4T6eFP#l3J)v0可选属性 output 指定 FindBugs 的结果使用的输出格式。可能的值有 xml 、 text 或者 emacs 。如果没有指定 outputFile ，那么 FindBugs 会使用标准输出。如前所述，XML 格式有可以在 UI 中观看的额外好处。 51Testing软件测试网9}qh)N8m

51Testing软件测试网E7P$z5A I?M5A%`

 

!`o m)x/D;H,k+OU0 51Testing软件测试网%s{!c6h[!c;~ e

第 3 行： class 元素用于指定要 FindBugs 分析哪些 JAR、类文件或者目录。分析多个 JAR 或者类文件时，要为每一个文件指定一个单独的 class 元素。除非加入了 projectFile 元素，否则需要 class 元素。

H KO+?x,wu8r-L+e0

a(W1l*b.^ BJz0 

yz` or}0

0x4`9?.h8[{_f+B9d0第 4 行： 用嵌套元素 auxClasspath 列出应用程序的依赖性。这些是应用程序需要但是不希望 FindBugs 分析的类。如果没有列出应用程序的依赖关系，那么 FindBugs 仍然会尽可能地分析类。与 class 元素一样，可以在 FindBugs 元素中指定多个 auxClasspath 元素。 auxClasspath 元素是可选的。 51Testing软件测试网[i~-]6IP

0Wu5zea5L0 

S|+Q}7aW0

D'hw:`J$X1b$ZZ{0第 5 行： 如果指定了 sourcePath 元素，那么 path 属性应当表明一个包含应用程序源代码的目录。指定目录使 FindBugs 可以在 GUI 中查看 XML 结果时突出显示出错的源代码。这个元素是可选的。

.G3L'|#Mwd_+tQ8s%d0 51Testing软件测试网 bm@u4bHk

 51Testing软件测试网!~$f$f&t@H

51Testing软件测试网3v.r`&T,K(pQ

 51Testing软件测试网V|R6?v&mmd

5         其它分析工具

51Testing软件测试网:Z.L R\&d0j5A]P

除FingBugs静态分析工具外，还有PMD和Checkstyle，FingBugs、PMD和Checkstyle三个工具各有不同的特点，联合使用有助于减少误报错误，提高报告的准确率。

_%n3ap@|&k@~ \0 51Testing软件测试网(sD"lDh%lGn8o0X

这三个工具检查的侧重点各有不同：51Testing软件测试网 FlV-s6j~

工具

2G G Z|a] D)h0

目的51Testing软件测试网9K RU{f*W-N9n;L

主要检查内容51Testing软件测试网8V\8M6dw1| U
51Testing软件测试网)c$e] | MR&X

FindBugs51Testing软件测试网$|TO'XK-G!y6Q

jX:w m$b3{K$?0基于Bug Patterns概念，查找java bytecode中的潜在bug。在目前版本中，它不检查java源文件。51Testing软件测试网}cR4C?ws5c

 51Testing软件测试网{~y7m h

主要检查bytecode中的bug patterns，也允许用户自定义特定的bug patterns。

%Z2JDU!]0

/u9C _.^j3I4ll%L,wk0PMD

2v4sO ]gC%B0

p0|0L7K+^ dm;zH cPpj0检查java源文件中的潜在问题。

Zg/T-F]~'\o E0

Y1W3U&K+Qg*p0主要包括：

\bxY[H6d0

0cQrkG x0iz0  -   空try/catch/finally/switch语句块51Testing软件测试网Uf LA~"aJ9l3X

+G WJ6E.bH e0 -        未使用的局部变量、参数和private方法51Testing软件测试网RNk+N'Cu[*@3Wa

`(B'\C:q|0 -        空if/while语句

|6O i:cX0 51Testing软件测试网;l*Ht1ha

 -        过于复杂的表达式，如不必要的if语句等51Testing软件测试网 E(eW!r!A0q/BE3^*^

51Testing软件测试网Z/z E3PD+\$`7]QM

 -        复杂类51Testing软件测试网 Xx[+X'S+x'^ J

a?7~+L(KZv0CheckStyle51Testing软件测试网*W;K7f Xdp

 51Testing软件测试网~zR"C \,g1?

检查java源文件是否与代码规范相符51Testing软件测试网?1~W(K|a;H6U4m

T ] g+oyhdv t0主要包括51Testing软件测试网$g*A-Z&N6X0o`${

51Testing软件测试网?2~ ]w"F4p

 -        Javadoc注释51Testing软件测试网\'Vw~lPf j

51Testing软件测试网H+z|;K4Q xCUo

 -        命名规范

/P X&^nqye0 51Testing软件测试网 Z\UYA,K

 -        Headers51Testing软件测试网!fg0}(a%G/J |Y7n?

%hd7]5{*[i0 -        Imports51Testing软件测试网2?n!U U9Z9C

51Testing软件测试网9F3d8n!s1@ngr|

 -        Size冲突和度量，如过长的方法

*Jm&hP3e'b e z0

8];g u`0O v0 -        Whitespace

Kl(wF O0 51Testing软件测试网YFzhqn/g@`

 -        Modifiers

PIdA v*DUdN0

1ER[2b0IQZ0 -        Blocks

t5iEC}E*e)o0J0

*Iy&^Ug$`h0 -        Coding Problems

AL0@jneX5cN0 51Testing软件测试网"G v`VvX(C7V+`D

 -        Class Design51Testing软件测试网C~ T-r)D.{&[{

1{9zZ @i]0S(XQ0 -        重复代码

blSYP2@0 51Testing软件测试网t.rjUQH0q]

 -        Miscellaneous Checks

kl-]6|/u0 51Testing软件测试网~@ty-IkgD

 -        Optional Checks51Testing软件测试网&T"SZnn!q
51Testing软件测试网Z!pF#S"z O1R

 51Testing软件测试网4O,M'D8B+v{(Q4x(v

51Testing软件测试网G*?A7?Bl*z:Nh

 51Testing软件测试网Ghj `;aG

5.1       PMD工具

8C'}0z{+bf0PMD工具目前最新版本是V3.3(下载网页)。

T/q mr*F?B0

9D([ u5}X0PMD的运行环境是j2se1.3或以后版本，安装过程同样也是解压即可。

3d p iZ U5na5q0

5.1.1 Ant task的使用

51Testing软件测试网(cI&]} I'Rr

（1）       把lib中所有的jar复制到项目的classpath中。51Testing软件测试网!^w ajD8N$dy

51Testing软件测试网` zl3?(?1_

（2）       将pmd-2.0.jar中的rulesets解压到指定目录，这里面定义了分析所需要的规则集合。

5O@+Q0e]U t-Ir;cx0

NKr p"x$W ob#XuD0（3）       修改build.xml文件。在这一版本中，提供了2个ant task。一个是pmd使用规则集合进行分析；另一个是检查代码中Copy & Paste代码。这2个任务对应的ant task使用：

8U\6](V&I }0

.z.}-Kg [ W0PMD任务：

U7q9R` {/Trh H0 51Testing软件测试网(L'FR;ne`S@R;@(AC

   

g*p { vO:uQ8tq N0

,k5km[B:QJ HG1}0   

2Qob#[y Uk0 51Testing软件测试网(z ^I4yU+byl

        51Testing软件测试网K}rX8`Bh K3|

51Testing软件测试网w*C(}1z!HHcA`8r-m

                        classpathref="classpath"/>

zQG)Hrh&y0 51Testing软件测试网U,Y1L8Z-~8s#o

    

n#A$D:@5iZd B1K9[0

m ~dW'Y8vB0        51Testing软件测试网#]0c+O5v:?3~A-}

51Testing软件测试网o1M#t5G;?w"q

         51Testing软件测试网-T9Z oF+N$\

51Testing软件测试网+mx"V"ik ^

            51Testing软件测试网 x| O"M[!? T

RYEB+d.\0        

;G*m'?HI0 51Testing软件测试网?(SlH#O5L

            51Testing软件测试网M B zAwMK*[

51Testing软件测试网G Zr9hx!r

        

a:Pvax'd j.^V0 51Testing软件测试网'] Gp!~#c

            51Testing软件测试网&L@tiO:Q

S2b]"a/\8| c*B/j^s0               

lF GAr J-p dS7m0 51Testing软件测试网%y:lAT3_Xfx

            51Testing软件测试网9_ p%N,@8U

51Testing软件测试网7w1Q3KqC"xx!A2\

       

}WC]Dy5u.AK0

%YD!jpQI]7vX0X ]0   

:t:R]_4oLr7p0 51Testing软件测试网GU(`8z%YZ

CPD任务：51Testing软件测试网!A!Tf4p y+q

51Testing软件测试网0tY:nHhXcU

+KozNH0F0

ww^F/M@|w/H;]0     51Testing软件测试网\(Q@w4Z(Y*X

,y p-L6nI0       

6k7]#U(dB`-Y,D0

9izP v/X Q0                            classpathref="classpath"/>51Testing软件测试网6z8q0n*R1_CA"I v

~hyP7fx O0     51Testing软件测试网0O(F6`'U*Q%{

51Testing软件测试网(@R9tL*a)QfCw4WFJ

        51Testing软件测试网YBS2k9\

/AV0wbxS:|1_0        

N;ev#{1]jj;k0

)M:~C z G Jy } A$^+Z0           

A:G7D j;x#A0 51Testing软件测试网+V6EE\)Y c tT_5K|O*B

                51Testing软件测试网 a(OAV FrIe

i(g8Z:JBV0           

pF1nK!@#r7x$?K,X0 51Testing软件测试网,vKr OK c

        51Testing软件测试网.BB9c4B1T

51Testing软件测试网#q F6u~I9Wv(t

   

2B!Z N2b3@+z n0

7K`Ao&Y0（4）       运行ant pmd和ant cpd即可。

B1lzJ3LD0

Q*b^0LF,M;Q0（5）       参数说明：

w0FEjy%zH0 51Testing软件测试网 O$v cq&y

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

a%k i6x+Cq0 51Testing软件测试网,eS0sP+l!w

-        rulesetfiles，指明分析所需的规则文件，不同文件使用逗号分隔。51Testing软件测试网_!N [.K0r/Cp

51Testing软件测试网N.g.On!R&akW c#G

-        failonerror，pmd执行出错是否中止构建过程。

N7g.sC(C&XE7s0

I;o3H.P*j#C0-        failOnRuleViolation，如果与规则冲突，是否中止构建过程。

,H |v \%S&m~p0 51Testing软件测试网x-b_t3?!IK

-        classpath，pmd所需的classpath。51Testing软件测试网^#d~ m9?*C,d_

f+Hom2t n0-        printToConsole，在发现问题时是否打印到ant log或控制台。51Testing软件测试网yQ_o4}

51Testing软件测试网0fX-F!JX _S"u"q

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

AGl0\(tCx|0

q_'w Le\Q0-        targetjdk13，是否把目标定为jdk13，如不能使用assert。

B6OepGs"\0 51Testing软件测试网&l1C*X2J"Z ^ VP

-        failuresPropertyName，在任务结束时，插入违反规则的号码

7\E8EdTL5fl0

'z.U-n7Icr0k0-        encoding，读源文件时所采用的编码，如utf-8。51Testing软件测试网r'g2nDF

51Testing软件测试网+hdC8a+a\&D

 51Testing软件测试网sK"Z9uBD

5.1.2 Text的使用

51Testing软件测试网k ] k(d;Fj

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

rFIVLpV0 51Testing软件测试网c2X\[0R#x

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.xml51Testing软件测试网bD9n s-_0Dl`

51Testing软件测试网\#V8nch4k#X VU

 51Testing软件测试网:U?S#t_%m

5.1      CheckStyle工具

51Testing软件测试网)H T(R9nQr;J8C^&`{

CheckStyle目前最新版本是: checkstyle-4.0-beta6（下载网页）。

"X6~*T&R3m0 51Testing软件测试网2P9R]1|d!U |q N

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

k}'e:{H]vd%T0

]BBV+at n*C|0 51Testing软件测试网8x*PT#g1n @eHJ)I

5.2.1    ant task的使用

&J5vAx8k#A0（1）       复制checkstyle-4.0-beta6.jar到项目的classpath中。

&yl$^T!kL]C`c0

{KN TQ,R0（2）       修改build.xml文件：51Testing软件测试网uU:V9UA9Ah/d

zN^'SJr1K}051Testing软件测试网}4DNp4H(n.T

.WpM"R`0       classpath="${weblib.dir}/checkstyle-all-3.3.jar"/>

olx4C m5~9b0

^K!Q%jETXi/k q051Testing软件测试网1_Hy4Z2p4EW I;e

51Testing软件测试网e4G4S ]Th:@%~

        51Testing软件测试网]_(A#Es };['s0Lq

51Testing软件测试网+?dsK'}&ad~PQ

       

`SA o4@`H0

J*] y!l7D:Mu9T9Q1o0           

!Mr0a.Gq u5V6~f,d0 51Testing软件测试网[w"TI'k/})o6E [6A

            51Testing软件测试网,Av&F-g5{,i?Y

51Testing软件测试网AcMn5D

            51Testing软件测试网mr1[6`a!|

Dp7^;M[,IZ|%C~$O0            51Testing软件测试网n!H[$e"^DL

S4J%d R)j5qj/}V-{ I0        51Testing软件测试网/ma S2D?V [E:v'b

C]srsZG0        51Testing软件测试网&m[D h#v&E8F

51Testing软件测试网 b8Mj.n(SqU