|
2 l4 J& R* O6 ?8 g5 X" B/ l& D
原标题:腾憬文化科技香港科技事业部 | 五款IDEA 插件,堪称代码质量检查利器! * j+ l9 Y0 d; @7 o K9 N" \: o
8 B5 V# G9 G2 S/ U4 T9 p4 a# K
随着业务的发展,系统会越来越庞大,原本简单稳定的功能,可能在不断迭代后复杂度上升,潜在的风险也随之暴露,导致最终服务不稳定,造成业务价值的损失。而为了减少这种情况,其中一种比较好的方式就是提高代码质量,比如通过代码审查,从而降低错误风险,但是,代码审查难度大,代码缺陷、漏洞不易发现,且审查工作随着代码量增加而增加,审查效率低。
: A0 l$ ~5 x: h `$ n. ^ 工欲善其事,必先利其器,因此,这篇文章给大家介绍几种检查代码质量的利器,Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint,让你在关注代码质量的同时,减少 code review 的工作量,提高 code review 的效率,并通过代码质量分析去反向提升我们的代码编写能力 ; \' G6 j# D4 a6 L! Y) O
一、Alibaba Java Coding Guidelines
7 E" Z1 N' ?# B5 C2 j8 w5 d+ r 1、整体介绍: 9 j7 m* N" D( M e8 ?% s
Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。 & b7 P, |1 @! b
阿里巴巴规约扫描包括: + t4 i# t. I" f3 ~
. ~3 t- B6 q* F/ P# L# [/ X
OOP规约
- w1 J: z! w! V I* \ 并发处理
& a: u6 Q: u5 t9 v! F% X 控制语句
: l; c, b3 @& k9 Q% }' Q: R 命名规约0 S. ?/ Q S/ G8 T; ^
常量定义
{' y) u; D+ I! {4 S! u 注释规范9 Y0 q0 l- a! W/ Z7 \/ F; y
# U9 [$ w2 ~$ B2 {$ ?
2、安装步骤: & q+ k! `4 B+ g
File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。 3 H0 o1 N V c8 o
3、使用说明:
! }( @0 R* A6 y6 v8 x 3.1、运行方式:
1 n1 I+ `( \2 | (1)可以Tools > 阿里编码规约 > 编码规约扫描
( {& H6 {8 o% p# Q  ( }6 _/ X$ |9 E% {9 R2 ^! ~# }5 o( L1 a+ j
(2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可:
9 F( w" \: a' z# ]  . k u: h9 U4 C! [! s4 V
3.2、菜单功能:
; F, w8 D* ?& q0 L. k5 Y# q, o0 C) r' F v
编码规约扫描:开始扫描代码
5 n& [; c, w; U9 v6 ?9 e' d 打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能9 i8 e4 ], c# Z" s* q4 @! B
切换语言至英文:中英文切换
& \3 a9 \* H. N( b( D2 T X% R% u% D; }6 e9 A
3.3、运行结果:
; V: t+ X. }! t0 z W 扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。
9 W) m* l9 Z) M- E6 [  7 R$ h+ _5 e/ n% N, K* M
选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到): : N8 h( s+ I; T. V, a5 a) N
 , c/ O$ A/ A; l
(1)指定区域搜索同一类问题:
, I% Y3 C9 O4 j* u3 y: b 当点击③处的按钮时,会弹出如下按钮:
, t1 n$ f- E. o) D% R' Q. ^  ' f1 j! b% F g
这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示: 9 T: C) t V7 V; p" T' M
 9 n6 z& U- z0 ^6 Q
这里我们可以看到,显示了整个Project中的所有该类的问题。
2 l% ~" q3 a9 Y4 z5 e0 a. ?" }( r (2)预览具体的不规范代码:
8 t( B6 [+ M; y0 A 如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。 * r: y2 R# M7 e0 A: A

5 o+ A- t$ A$ L" x 3.4、工具栏功能介绍:
$ k& T* `, `9 Y  ; E# ]2 M( o7 s: e8 `+ P U; d1 Y2 X
$ b o$ |) H& s
Rerun Inspection:重新运行一次扫描' A0 S- F/ B3 F" j0 w" ]+ J
Close:关闭真个AJCG面板
7 u( t7 N- V6 ^& S2 O' N& G8 | Expand All:展开结果的树状结构,整个结果是树状结构的。- w+ Q1 L; [) d# h" `
Collapse All:收起结果的树状结构
: j0 e7 q; C' v4 v1 S Go Pre Problem:选择上一个问题
1 X6 r- x+ ^; G, S3 t Go Next Problem:选择下一个问题
, B* a, x- `/ K6 X# E Help:帮助
, z2 Z" i" |! Q7 Y/ ? Group by Serverity:(不知道如何描述). \6 j8 [+ K: v6 y$ r
Group by derectory:按目录分组/按类名分组间切换
, X8 U3 l, j+ V$ j3 k3 E Filter resoled items:过滤掉已经解决的项
0 f4 j/ [4 V! R. {- X9 U Autoscroll to Source:自动滚动到源码
- g, e) R) M8 n" F6 R4 } Export:导出,可以导出为XML和HTML两种格式6 H* t! q& \. B# q4 L* E- _, P, a
Edit Settings:编辑设置
, }1 e w9 {2 B F
# V: u. q9 b( \+ A7 [ 二、CheckStyle:
' E* [5 ]! F9 o' E 1、整体介绍: : x* F5 r+ l) y" T
CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。 & x; D- Y6 B4 R, Z6 b, ~' o2 Z
Checkstyle插件中默认内置有2个执行代码检查的配置文件(Sun Checks 和 Sun Checks),但是这两个文件检查的非常详细严格,即使优秀的开源项目也会检查出来有非常多的错误告信息,所以需要导入我们自定义的配置文件。
2 }; E6 t" r3 N5 M 2、安装步骤:
. P8 u: u& O* a5 q7 C u, o 通过 File > Settings > Plugins > Marketplace 搜索 “CheckStyle”,按照提示进行安装,然后重启即可。
5 }6 [6 ~$ D8 q+ W6 Q/ a4 N3 v 3、使用说明: ) L' P3 V7 I" Y/ F; b

, V& T* ?& f: a2 R 可以看到基本都是一些缩进啥的编码规范,可以不用太关注 7 B, h ^. H7 L9 g0 J0 m/ i$ G- P/ P
三、PMD
7 K- ~( v: {# {+ ?" U 1、整体介绍:
: L( W+ d6 L$ x4 I* d. J PMD侧重面向安全编码规则,且具备一定的数据流分析和路径分析能力,能力比CheckStyle稍微强点,并且 PMD 支持自定义规则,PMD可以直接使用的规则包括以下内容:
) n2 v# x. @; N; R' [$ E* {' \7 O: {- ?! ]* v9 m
潜在的bug:空的try/catch/finally/switch语句
* S% [+ y% a! p 未使用的代码(Dead code):未使用的变量、参数、私有方法等
4 p- C9 X% T1 H) Q; c 可选的代码:String/StringBuffer的滥用
6 y3 [/ I0 ]. h3 s+ J, P( @! R 复杂的表达式:不必须的if语句、可被while替代的for循环) Y! G2 E/ I1 I y
重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs
1 Q: \; M5 f! R( _: } 循环体创建新对象:尽量不要在循环体内实例化新对象
, B5 T$ x& h3 \2 l9 [. h 资源关闭:Connect,Result,Statement等使用之后确保关闭掉
1 h9 _( p+ b n& Y
5 P6 D8 Q4 u. t7 f' n6 x 2、安装步骤: 6 l7 W0 S) a, ]6 ?* P& F
通过 File > Settings > Plugins > Marketplace 搜索 “PMDPlugin”,按照提示进行安装,然后重启即可
, l# n i% |' c 3、使用说明: 3 T; z( q( F3 ^$ H
) P4 a- C2 J+ _
参考文章:http://wjhsh.net/andy-songwei-p-11830812.html
2 `) u) R4 b" M& y# s
3 i& `# E/ ~( V+ g" i7 Y 3.1、运行方式: 2 F! X7 ?+ a( Z& v# \. b& n8 ?, o
(1)从Tools菜单中启动:
6 p/ Y9 a s. A+ c) ~ 通过 Tools > Run PMD 可以看到如下的界面,如果通过该方式启动,扫描的范围就是整个项目中的文件了。
8 X, h! |8 a2 f% I% y$ F0 y
& j* c2 j9 i2 i" E, M) ? S Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。
" G, @, S0 B- _/ \; K$ o& t3 [ Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。; w; g; V V: y9 S# l9 v
. O7 S) V* [6 F1 _
(2)从右键菜单中启动:
# W1 W1 f9 f% \( {3 p/ b; t 在文件或者编辑器中点击右键,也可以看到“Run PMD”选项,如果通过该方式启动, 检测范围取决于鼠标或光标当前所选中的区域。
# \2 h( r* V/ Y1 g( Z% ^ 3.2、运行结果:
1 I2 W* K. G$ z" u& G" O 
1 w! C& e% t+ q 运行后会出现如上所示的面板,左边工具栏,鼠标停留在上面会提示其功能;右边显示了检测结果,当点击具体某一问题项时,会跳转到对应的源码中。
' Y2 o; c* G, a+ e1 f& ? 3.3、配置检测规则:
4 P- m' M4 v* f$ {( e* M* m 通过 File > Settings > Other Settings > PMD 可以打开检测规则的设置界面:
$ k! m3 g( i( V2 j9 L5 P 
1 p8 A* s/ C/ I 在 “RuleSets(规则设置)” 界面可以管理自定义的检测规则。因为在实际工作中,可能需要根据实际情况自定义检测规则,就可以通过这里导入,如果要使用它,需要在启动PMD进行检测时选择该自定义规则。
: W/ t1 B, Z9 ^* n ^ 点击“Options”选项卡,在其中可以配置一些检测规则选项: . H% |! t6 D( H( J: I- A3 c5 v

7 J1 c" ]; L) _1 w) D+ F( u2 @ 其中重点需要留意的是“Skip TestSource”这一项,因为在项目中有不少Android Studio自动生成的测试代码,如下所示,选择上述选项后可以将其过滤掉。
6 N! \% p) G; h& ^3 A4 G 四、FindBugs: ' d) M w# k- `* o3 j/ F, l5 V
1、整体介绍: ; e+ Y+ |6 U3 r7 e4 p
FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考 / v7 R/ }: ^$ W4 m/ A
2、安装步骤:
. L/ }' ], p% ]7 u- \* { t, {" B 通过 File > Settings > Plugins > Marketplace 搜索 “FindBugs”,按照提示进行安装,然后重启即可
7 ~+ `4 W: t' ^! h. F: L4 J; s 3、使用说明: 2 N( m1 u8 U( t
FindBugs 可以分析单个文件、包下面的所有文件、整个module下的文件、整个project下的文件,右键想要分析的文件名/包名/module名/project 5 K* I* o9 o9 @0 y4 {5 X

( d# }* _( S" J 分析完之后就会出现结果面板 9 }' L3 z$ C4 m* k$ ^* G+ Q

) G5 j0 P4 V& J6 f$ [: f( F 点击对应的item在右边会定位到具体的代码,这是根据提示进行处理修改就行
0 ` M; M- Q: |3 V8 F6 U" L6 |% t( @1 s( r% H8 @
4、附:常见的错误信息
B8 @1 a) d; B% B X+ A2 V* Y 4.1、Bad practice 代码坏习惯: & s- Y0 I- \) f; ^) _( J5 ~9 U; b
4 F8 [3 m1 V& g: i D9 F 图片
$ Z( x! n: D. S: P/ K! N' X" @) ^ 4.2、Dodgy code 糟糕的代码:
" r" N' V8 S( Z1 R
$ d: J3 K& h" K0 a* M. g+ b 4.3、Internationalization 代码国际化相关: 8 s+ J' T$ b, i
4.4、Performance 代码性能相关:
3 L- r, b# N5 }3 R# d, V, k1 T; a H
( h N- W3 p/ V5 d) D 4.5、Experimental:
7 v: t! D5 ~9 u6 e+ z
; b- w! M1 \0 F/ H4 v( }8 P 4.6、Malicious code vulnerability 恶意破坏代码相关:
V6 o) J. k$ a5 _/ g' V W) C
4.7、Multithreaded correctness 多线程代码正确性相关: & n+ E2 ?% ]; F$ |: F* P
4.8、Correctness 代码正确性相关: ( K: T1 T R# R* Y+ ?5 A/ m+ N, o
1 Q$ w$ o' S" @( M) k: s" w' E, l
五、SonarLint:
6 ] S7 J" Q& N8 u7 A9 W( p 1、整体介绍: 9 k/ B4 x# i% R% A
sonar 比 Findbugs 高了一个层级,它不仅关注常规静态BUG,还关注到了如代码质量、包与包、类与类之间的依赖情况,代码耦合情况,类、方法、文件的复杂度,代码中是否包含大量复制粘贴的代码,关注的是项目代码整体的健康情况。sonar 有两种使用方式:插件和客户端,sonar 的插件名称为 sonarLint。
, D7 S" { L8 w 2、安装步骤:
% I+ z% a: j5 V7 ~: a 通过 File > Settings > Plugins > Marketplace 搜索 “SonarLint”,按照提示进行安装,然后重启即可 e; y; H; t0 `7 ^7 g; ?) {
3、使用说明:
4 Q) m9 z; i( M$ }7 ^( Y) r7 h6 Y% B- Q7 a Q+ C" l& t
右键项目或者文件进行如上图所示操作,执行之后可以看到如下信息,如果代码中有不合理的地方会在report中显示,同时点击错误的地方在右边会给出建议的修改供参考。
9 P3 n* g9 `1 n
- J5 n4 G* ~/ H. G$ J# ]* m 4、配置 SonarLint 服务端: / F; F9 D' w8 o; ~) S0 }
4.1、配置 Sonar 服务器: 2 P% [/ s3 }& \1 v1 b% y
sonarLint 插件的使用场景是自用自审,但 sonar 也提供了平台版本,使用场景则是他审,sonar 平台的搭建就不在这篇文章介绍了,感兴趣的读者可以自己上网查看,我们这里主要介绍如何在 sonarLint 插件中配置关联 sonar 平台服务器的工程,进行本地检查: ! r: Q2 d. ~, G; T% ]
" i K* @# X$ X; w, T; r
点击新增按钮,输入Configuration Name,配置sonarlint 服务器的地址,然后下拉框选择 Login/Password,输入 sonarlint服务器的账号密码 2 S3 t+ v- G% P9 P& e4 s
4 P4 l2 b8 _; ?
4.2、具体 Sonar工程配置: 0 B8 n' K4 b9 T- P/ T
配置完服务器之后,需要针对具体工程进行配置,点击 connection下拉框,选择上面配置好的服务器连接,然后点击 Search in list,找到对应的工程:
) b c3 O3 @" `7 Y! t
3 G/ o/ o5 w( E, p, I 4.3、使用 SonarLint 检查: 1 a! |9 X$ X/ w% v/ L( k
配置完上面两步之后,接下来就可以选择要进行检查的类或者目录进行 sonarlint 检查了(跟第3点的使用方式一致),同时,在 commit 代码的时候,勾选 “Perform Sonarlint analysis”,会针对你要提交的代码进行sonarlint检查 : P8 G2 M. d9 h2 |1 ~% j6 _, e
! X8 E0 [- {- Q/ B6 a g
总结 ' d2 T3 U+ D& k( [5 r( t: i% v8 K
& m u0 y/ g3 o) b9 j& S. k
检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了
' V; B' M6 X+ h1 T$ s* s. E* o# N 找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充:" K+ d* H; M; K; E+ v8 x
PMD 自定义能力强,用来自定义项目BUG规则非常好用1 d7 X2 i* N3 p8 h2 `% a
Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。
/ E9 q% N8 M1 B# w2 J8 Y SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景8 z* r L1 u2 i+ o! z( n4 L
/ j% c0 `2 Q+ n2 F: A7 z
文章由重庆腾憬文化科技有限公司新闻事业部整理,仅用于学习交流,版权归原作者所有,如有问题,请及时与我们联系,我们将第一时间做出处理。返回搜狐,查看更多 ! k- c% R+ k, P+ l; i
8 Z2 K. X* d$ a, H: N! F
责任编辑: 1 E' ]% q8 K3 o( m# D
. ~6 L# t H, p5 m9 E% q' _* h* Z" M! d% d( r& a0 l
+ `, {, _" s/ w3 u# J/ q
: R) l3 J$ Z5 _; Z2 ?/ z5 F! p0 l |