|
3 u# d) C! S: _2 U, A/ R V 原标题:腾憬文化科技香港科技事业部 | 五款IDEA 插件,堪称代码质量检查利器! , d6 e3 f0 ^- Q
5 c% b! g" g# x8 h) M 随着业务的发展,系统会越来越庞大,原本简单稳定的功能,可能在不断迭代后复杂度上升,潜在的风险也随之暴露,导致最终服务不稳定,造成业务价值的损失。而为了减少这种情况,其中一种比较好的方式就是提高代码质量,比如通过代码审查,从而降低错误风险,但是,代码审查难度大,代码缺陷、漏洞不易发现,且审查工作随着代码量增加而增加,审查效率低。 5 M7 a) [2 \9 V; U' v
工欲善其事,必先利其器,因此,这篇文章给大家介绍几种检查代码质量的利器,Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint,让你在关注代码质量的同时,减少 code review 的工作量,提高 code review 的效率,并通过代码质量分析去反向提升我们的代码编写能力
8 [) ?" @ j+ H* s# a' Q% c3 q 一、Alibaba Java Coding Guidelines
, N' @4 R& T3 }8 \3 q q3 ` 1、整体介绍: $ u- }& b+ R! l! ^! c/ e# ^% d, n
Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。
8 C6 ]7 o. \, `$ v' { H6 I# z- K# ? 阿里巴巴规约扫描包括:
. W( h6 u! q# d; G' N: q1 E- x, ~8 _$ R- g: y2 r
OOP规约
# O9 S- y( f- J6 o) c9 p. K 并发处理
9 U2 L; x' D# k, k8 P 控制语句* U% g I& ^0 @& x% ?! R
命名规约2 F! B' _8 b) c0 G
常量定义" o! P9 Y& \# a* @$ @
注释规范, `: C) Q3 F+ D6 r% f& C+ l8 |
7 {, q7 ?: U$ \& y( C
2、安装步骤:
# M$ U9 ?& g; |0 ]: ?# v5 P File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。
2 t [) I# F: O0 m 3、使用说明: ) T" N2 X3 r: f' a, f
3.1、运行方式: * q3 a i3 }! W Z3 a
(1)可以Tools > 阿里编码规约 > 编码规约扫描
# \0 |" h- }1 i, ~ 
1 |3 N2 L. O# a [) Z; i (2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可: ; X$ M4 h1 m7 p# x

* i+ W9 n- L% _9 W 3.2、菜单功能: ) ], N( ~( {% r! f' B3 H
8 Z4 v* r7 E9 o! q7 k% p2 M
编码规约扫描:开始扫描代码+ \, l- F8 u1 }- `" j
打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能
; w" Z% [' g$ V; P7 n 切换语言至英文:中英文切换" u; f0 d& O9 d& f+ _0 _
# I6 W8 l1 V' K T) M4 g+ m
3.3、运行结果: 7 D% E$ T( \9 G- C4 Y. x
扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。
3 R/ g U S& x0 e+ U! G  - ~2 ~; x R1 h7 h8 [- Y9 B
选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到): " K* |8 Z# Z6 V9 G, p) O1 z

' J. _9 P' d# _ _( a- L) g (1)指定区域搜索同一类问题: 9 P: {5 P1 r3 L/ W
当点击③处的按钮时,会弹出如下按钮:
1 r0 h3 {, a" O5 u7 R# O+ d: a  ?& c- f/ @! r* L+ s. D
这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示:
' V0 v# p* {* p3 C: u 
: T$ f% [' J) L! k) i! z 这里我们可以看到,显示了整个Project中的所有该类的问题。
' x4 F: r' c7 ]! e3 m (2)预览具体的不规范代码:
! B; F. R% N2 @3 h+ t 如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。
) f+ M ~! }. Q4 @9 B  7 u5 S8 Y ^5 |6 M
3.4、工具栏功能介绍:
' q, w) q1 e$ Z  0 S8 V) _5 W: c* I$ f! E+ w
8 V# o; k: a& v/ d Rerun Inspection:重新运行一次扫描; l" l+ u9 y4 W3 X: Z+ V2 X
Close:关闭真个AJCG面板
. ]! n& W3 c1 D* r6 r6 ? Expand All:展开结果的树状结构,整个结果是树状结构的。5 q d) x; x1 @% e% e0 Z
Collapse All:收起结果的树状结构
4 [) l2 V3 G. a3 y; C2 N Go Pre Problem:选择上一个问题
6 m$ e% x6 P+ {# [( R- F. ]8 ` P Go Next Problem:选择下一个问题
2 S, {# x9 u- k& E$ k5 [ Help:帮助
, N# ?! M; D' A" {; h3 b Group by Serverity:(不知道如何描述)* J" \6 l, b$ q+ j2 O
Group by derectory:按目录分组/按类名分组间切换$ ~8 ~2 |3 T& l3 Z
Filter resoled items:过滤掉已经解决的项
1 H6 I* g6 [0 P& P, r Autoscroll to Source:自动滚动到源码. d! U& L9 P4 g! m: L9 J" U1 C7 x6 o- ]
Export:导出,可以导出为XML和HTML两种格式
( o0 D+ g8 @% k. W Edit Settings:编辑设置5 P- ~4 z6 t1 v0 C/ G
# r1 ]1 M' [: H
二、CheckStyle: 2 C, y1 M' k' m& s: h" p. ~# M
1、整体介绍: / }# w3 E1 n! @% R2 f; j
CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。
6 s7 w4 W1 e/ ?5 O; \2 r: p3 R/ i Checkstyle插件中默认内置有2个执行代码检查的配置文件(Sun Checks 和 Sun Checks),但是这两个文件检查的非常详细严格,即使优秀的开源项目也会检查出来有非常多的错误告信息,所以需要导入我们自定义的配置文件。 5 j5 C+ h9 K! F
2、安装步骤: 0 T! E: M; J& O) B
通过 File > Settings > Plugins > Marketplace 搜索 “CheckStyle”,按照提示进行安装,然后重启即可。
9 I0 \1 }! G0 U [ 3、使用说明:
' ?/ d; @, T9 _' E/ x5 m0 w 
& p" ]2 p* H* j# Y$ |3 F# n' Z# v/ _ 可以看到基本都是一些缩进啥的编码规范,可以不用太关注
5 f! D( K0 u d$ S1 r 三、PMD 6 @6 g' S; F& f, f! f* @- g, }
1、整体介绍:
" D ~ O* Y) u4 }4 X3 n1 u PMD侧重面向安全编码规则,且具备一定的数据流分析和路径分析能力,能力比CheckStyle稍微强点,并且 PMD 支持自定义规则,PMD可以直接使用的规则包括以下内容: 7 w8 Q/ F( Q4 k$ I9 k3 K/ a
" E/ Y& @7 b- x4 J1 x/ X1 E0 V
潜在的bug:空的try/catch/finally/switch语句6 I# Q! T. j1 k0 e4 Y* j1 ~+ K6 d
未使用的代码(Dead code):未使用的变量、参数、私有方法等
: k4 R- M5 V( b5 c: s* F6 J 可选的代码:String/StringBuffer的滥用
7 {: D1 L9 Q8 V o6 A+ U0 T* e& N0 ~* P d 复杂的表达式:不必须的if语句、可被while替代的for循环% s; x2 i% u T% v9 ^% W6 e
重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs' G K3 p9 S( L" \9 I7 k( v
循环体创建新对象:尽量不要在循环体内实例化新对象
" p4 J/ U. \+ k5 P, | 资源关闭:Connect,Result,Statement等使用之后确保关闭掉, p+ }+ h: ~2 D, G
5 d: B/ E" l" D& ^6 Z$ i
2、安装步骤: 8 Y4 k( R* `" Z/ G3 m
通过 File > Settings > Plugins > Marketplace 搜索 “PMDPlugin”,按照提示进行安装,然后重启即可 - w, T. o8 \) M+ X4 b8 t
3、使用说明: 8 [2 p$ r, A; P$ p5 y$ H- M
" b; S& r+ O8 F: ^ 参考文章:http://wjhsh.net/andy-songwei-p-11830812.html/ F5 I7 W# o& v% t
b. N- R3 ?$ I1 b" w: t& ~
3.1、运行方式:
* J9 r( y; I2 p (1)从Tools菜单中启动: - f4 h# _5 K1 Q+ W
通过 Tools > Run PMD 可以看到如下的界面,如果通过该方式启动,扫描的范围就是整个项目中的文件了。 / l. m# [8 z: ?6 m- [% U/ w
3 E) [3 ^0 t) G Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。( f! I, j& o* V' V
Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。
! W- O4 y$ p/ y Y/ C: I0 U B2 k, y) k( y. a" G: Q
(2)从右键菜单中启动:
" H( P% \" Y* k2 J: b/ s. e 在文件或者编辑器中点击右键,也可以看到“Run PMD”选项,如果通过该方式启动, 检测范围取决于鼠标或光标当前所选中的区域。 4 o9 _6 w9 F: j8 E
3.2、运行结果:
( m& ?) V% ]) X5 a  ) D# M3 E( Q& k$ W
运行后会出现如上所示的面板,左边工具栏,鼠标停留在上面会提示其功能;右边显示了检测结果,当点击具体某一问题项时,会跳转到对应的源码中。
1 Z( ?+ s4 [, ~* Y 3.3、配置检测规则:
, v: B: u$ M! @; i' d 通过 File > Settings > Other Settings > PMD 可以打开检测规则的设置界面:
4 u ]2 X0 A" V$ D+ G$ W* t  5 O' I. R. Y6 p0 N0 k, {7 a
在 “RuleSets(规则设置)” 界面可以管理自定义的检测规则。因为在实际工作中,可能需要根据实际情况自定义检测规则,就可以通过这里导入,如果要使用它,需要在启动PMD进行检测时选择该自定义规则。 7 F4 @& y( E3 N( T
点击“Options”选项卡,在其中可以配置一些检测规则选项: 0 O; x. |% q; l

Z7 y' F8 w1 z' T1 { 其中重点需要留意的是“Skip TestSource”这一项,因为在项目中有不少Android Studio自动生成的测试代码,如下所示,选择上述选项后可以将其过滤掉。 + Q" U& j& J5 @9 X- h
四、FindBugs:
( m& c' V% D3 h; f' N 1、整体介绍:
8 o& |2 Y( i; t( _; O' Y, O) r FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考 ' z! u9 [1 q+ A/ h
2、安装步骤:
! a+ z) e; l& O) G6 N% R0 z 通过 File > Settings > Plugins > Marketplace 搜索 “FindBugs”,按照提示进行安装,然后重启即可
& d& b7 i- @8 d# _ S# N 3、使用说明:
9 w" ~( N1 N, o& d& r FindBugs 可以分析单个文件、包下面的所有文件、整个module下的文件、整个project下的文件,右键想要分析的文件名/包名/module名/project
; h4 i9 ]* {* m  * f5 L0 ?2 P, m, H
分析完之后就会出现结果面板
, }9 ]. \$ r% u; x2 h! B4 G  / |5 i" v" G* Y; E( _ ^# Q
点击对应的item在右边会定位到具体的代码,这是根据提示进行处理修改就行 & @6 Y& k* P7 c+ v6 M# x/ U/ S
+ B2 b6 L6 \2 T0 X6 L5 u
4、附:常见的错误信息
' H) `+ }5 d5 R6 g5 L' z& B 4.1、Bad practice 代码坏习惯: $ u# H3 h# w- D; Z# h) o7 v
8 E& y/ M6 `, @' z' D: m
图片
' Z, q$ I: s1 ]$ z1 I; C, M4 g 4.2、Dodgy code 糟糕的代码: ! C; ~+ P) N: Z+ k. P) r
- I. T9 T) b' R2 K1 S6 W9 D, W 4.3、Internationalization 代码国际化相关: 0 t2 q2 I+ X+ t
4.4、Performance 代码性能相关:
- v: |7 V+ ]3 X( _ {, d7 t% d) a$ i2 }$ K5 L. P; V N% ?
4.5、Experimental:
$ ]3 K0 E8 p0 A5 h ?; i* }- g5 q c- [; Y: M- E
4.6、Malicious code vulnerability 恶意破坏代码相关:
& s* `: t1 l r1 R; p+ s4 o. s5 N. D4 c9 G2 e1 W! T: F
4.7、Multithreaded correctness 多线程代码正确性相关: 6 G% l' Y% I- [- Q. b) I/ }
4.8、Correctness 代码正确性相关: , ^* ^( G j0 Z
( u! a/ x( O3 [1 O" T
五、SonarLint: ; N* ?# g7 s6 b: Y
1、整体介绍: - a# e: S/ m! H/ ~0 P
sonar 比 Findbugs 高了一个层级,它不仅关注常规静态BUG,还关注到了如代码质量、包与包、类与类之间的依赖情况,代码耦合情况,类、方法、文件的复杂度,代码中是否包含大量复制粘贴的代码,关注的是项目代码整体的健康情况。sonar 有两种使用方式:插件和客户端,sonar 的插件名称为 sonarLint。 - ^/ B5 n, J: H" a( ]" m9 S/ Y0 Q
2、安装步骤:
% O; Z* w$ ^& v' h 通过 File > Settings > Plugins > Marketplace 搜索 “SonarLint”,按照提示进行安装,然后重启即可
, K! M! k y1 V# j 3、使用说明:
$ o1 Z4 o& ~% Y7 l! H4 n' T6 Z8 r5 a. J ]1 P
右键项目或者文件进行如上图所示操作,执行之后可以看到如下信息,如果代码中有不合理的地方会在report中显示,同时点击错误的地方在右边会给出建议的修改供参考。
* p x& |* c+ k; O) F& a
- B8 `; m8 }8 H. m 4、配置 SonarLint 服务端: - Z# W, d' S! R1 y% } I9 {) ]4 N
4.1、配置 Sonar 服务器:
3 t9 m# O0 f3 z. w" y sonarLint 插件的使用场景是自用自审,但 sonar 也提供了平台版本,使用场景则是他审,sonar 平台的搭建就不在这篇文章介绍了,感兴趣的读者可以自己上网查看,我们这里主要介绍如何在 sonarLint 插件中配置关联 sonar 平台服务器的工程,进行本地检查:
$ S7 n; d7 U6 i! P% B' D
( ^3 \+ c* V7 Q9 p4 i2 r 点击新增按钮,输入Configuration Name,配置sonarlint 服务器的地址,然后下拉框选择 Login/Password,输入 sonarlint服务器的账号密码 7 _1 q* T& e1 W0 }. G; {! {8 h
[4 y% ?! T! {; P& M
4.2、具体 Sonar工程配置: ' M. F8 I" l* R1 m' v
配置完服务器之后,需要针对具体工程进行配置,点击 connection下拉框,选择上面配置好的服务器连接,然后点击 Search in list,找到对应的工程: # O0 _2 P8 c) H* p1 E
/ s/ ^! ?2 Z9 ^5 V0 Q n% A
4.3、使用 SonarLint 检查: 7 E0 Y, o, ]% i" ^; V# u: h! ?
配置完上面两步之后,接下来就可以选择要进行检查的类或者目录进行 sonarlint 检查了(跟第3点的使用方式一致),同时,在 commit 代码的时候,勾选 “Perform Sonarlint analysis”,会针对你要提交的代码进行sonarlint检查 5 W4 }6 T$ N& {7 E, g& x
* `8 N, i- L' T% T! Q( s
总结 1 R- v+ z q: v
2 J5 `$ j! K; G8 R9 w0 g3 I1 z# j' j
检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了$ y7 t7 {) J. K6 p# c# x3 F& l; i
找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充:3 c6 `2 ?1 d( h( U2 J2 g @ w
PMD 自定义能力强,用来自定义项目BUG规则非常好用+ p. }; ^( T- O9 @: V
Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。
: k5 C1 a# ]5 G% m( ^+ |& @: n7 \5 _ SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景
6 [/ g" I! T- J: _: _ u3 G2 F" ]/ E. r4 R( g
文章由重庆腾憬文化科技有限公司新闻事业部整理,仅用于学习交流,版权归原作者所有,如有问题,请及时与我们联系,我们将第一时间做出处理。返回搜狐,查看更多 . R% ~5 L/ ~ o0 G: v) S9 W
4 l4 M% t! p# ]/ W! S9 C2 _( M 责任编辑:
2 J3 U1 v) ?2 f5 [( l1 z; |! G1 x: @+ E4 ~1 ]5 h, u+ @
' N" M+ i; E1 y3 J
+ d6 n0 Z; H; \. ]# ]& J* C% y8 b F5 Z* D
|