|
# T2 P+ w0 N: `7 r$ D9 p0 {- ^
原标题:腾憬文化科技香港科技事业部 | 五款IDEA 插件,堪称代码质量检查利器! 2 Q1 P% P$ D2 f- O
2 P% k H$ {# y3 P 随着业务的发展,系统会越来越庞大,原本简单稳定的功能,可能在不断迭代后复杂度上升,潜在的风险也随之暴露,导致最终服务不稳定,造成业务价值的损失。而为了减少这种情况,其中一种比较好的方式就是提高代码质量,比如通过代码审查,从而降低错误风险,但是,代码审查难度大,代码缺陷、漏洞不易发现,且审查工作随着代码量增加而增加,审查效率低。
! M. u2 d1 Z/ q, y8 q7 I) @ 工欲善其事,必先利其器,因此,这篇文章给大家介绍几种检查代码质量的利器,Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint,让你在关注代码质量的同时,减少 code review 的工作量,提高 code review 的效率,并通过代码质量分析去反向提升我们的代码编写能力
, h' {1 q2 l/ O1 s1 F0 D/ m3 _# N 一、Alibaba Java Coding Guidelines
+ D( G2 w6 b* ~. _, ?- n 1、整体介绍: & t" d4 `# G' F3 g4 k g4 }
Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。 2 L. N# p+ R( M. T7 | R4 P" M
阿里巴巴规约扫描包括:
& L2 k& [" x; e$ ?) C8 F' h& q/ M9 [: N
OOP规约
2 S" P* Q6 I; q4 x 并发处理
. C+ B/ N6 n t; o. J+ C4 v 控制语句
& Q- r! Y; h( L0 B0 q! [ 命名规约
+ j4 M8 i# c9 J% H+ O& o 常量定义+ Y9 Q0 _+ V" N+ p' v
注释规范0 `# `1 |; U/ w) H$ I- m4 S q* g
! n$ k( S* c9 E* l! \ 2、安装步骤: * c1 I+ s$ X% ~1 s" ^3 D( N
File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。 - s1 Y- Y5 A2 P) f* T. f* \0 ]
3、使用说明:
! m6 Y' B3 G6 S* R5 r$ D 3.1、运行方式:
' k! `6 z. f2 y1 ?$ a" t& X (1)可以Tools > 阿里编码规约 > 编码规约扫描
9 o" a- }( i* P) ]) M4 K4 h  ) e: N5 [ X2 [ f- U
(2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可: $ h8 m9 ~4 J+ W2 e9 `, o
 - U8 Z5 a, k. {2 R K0 n O
3.2、菜单功能:
9 e" r$ v. d' [! Y& _7 Y4 y2 G% @$ h& }$ L2 ?: O: C
编码规约扫描:开始扫描代码
. d- t' M' e' d9 F' Y" K# s 打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能+ X9 l9 o. _4 ?/ p% z! Z
切换语言至英文:中英文切换
' Q; d: n0 t7 P/ L& @& S6 @: T
4 K/ D. Q9 P. @/ K2 }2 v- n 3.3、运行结果:
/ v: i% m6 a# s E- { 扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。
: T1 H! X% A! h' o" J* @ d! ~& k 
& B" E$ p3 O4 ? 选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到):
/ F; Q! g- R; S- k. t: p% J& H" C- M1 X2 p 
m7 y8 N6 G' ^$ B! R, H (1)指定区域搜索同一类问题:
+ R; P& I- h# \4 _! b 当点击③处的按钮时,会弹出如下按钮:
" c- f* k; b( R3 _3 v 
# e2 a' _0 w; c 这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示:
' t2 Q/ d' g# E1 ] 
8 P4 Y1 h! O# h, I% l 这里我们可以看到,显示了整个Project中的所有该类的问题。 7 g# ?, X6 K) B
(2)预览具体的不规范代码: - t- B/ r0 v: ?" X- j
如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。
. F6 F! | l/ o# W B  , ~: L% Z7 ~3 I1 }- y1 F
3.4、工具栏功能介绍: ) \$ B% L8 Y7 M% S
 4 r. _9 k- J; E2 x& O
. k- O/ r. y2 B5 H, t( @
Rerun Inspection:重新运行一次扫描- Q2 [: L L! T8 ~4 q# ]3 r
Close:关闭真个AJCG面板3 U9 \7 F+ J: P1 T7 i7 v
Expand All:展开结果的树状结构,整个结果是树状结构的。
- ?3 p7 {. m) o2 K! l8 o Collapse All:收起结果的树状结构# z# G- ]1 {+ f+ _ C
Go Pre Problem:选择上一个问题
4 m9 q. m- b0 Z) t2 |. q# \8 r Go Next Problem:选择下一个问题. Z' ]% e6 k9 W. L9 c+ s
Help:帮助) H. a$ k/ ~1 V4 q" U
Group by Serverity:(不知道如何描述). F* {0 O, e. {0 n6 a/ K0 K& Z# X
Group by derectory:按目录分组/按类名分组间切换4 H4 o c: T t- L) S" b
Filter resoled items:过滤掉已经解决的项
. l% l6 A U4 P& { Autoscroll to Source:自动滚动到源码
5 x4 [# g+ N3 C' J m, n& N* j Export:导出,可以导出为XML和HTML两种格式0 i6 I0 s; F- i/ B5 X+ X8 i3 i
Edit Settings:编辑设置- ~% e; V3 Y7 @8 B
4 @; n! o# }' a3 m" ^# i6 e
二、CheckStyle:
% b5 `3 M* U) y, ^ 1、整体介绍:
* R. p6 p( e) V; @5 B1 I' G CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。
& l3 b3 N B6 m Checkstyle插件中默认内置有2个执行代码检查的配置文件(Sun Checks 和 Sun Checks),但是这两个文件检查的非常详细严格,即使优秀的开源项目也会检查出来有非常多的错误告信息,所以需要导入我们自定义的配置文件。
# B5 l) f$ I" H- L 2、安装步骤:
4 T& ]( F0 E5 m4 {& ^5 `7 v2 r 通过 File > Settings > Plugins > Marketplace 搜索 “CheckStyle”,按照提示进行安装,然后重启即可。 * b; H+ P0 R( e0 r" T
3、使用说明: 4 r! I7 ~' ]6 p* g3 B) A
 : K2 T7 a9 @7 q U( w$ L/ Z: F5 z
可以看到基本都是一些缩进啥的编码规范,可以不用太关注 4 Y8 J* Y0 Q' Q) z% _
三、PMD " V m& `( h& \/ }
1、整体介绍:
. y) k+ b7 `; p$ @6 u Z- F PMD侧重面向安全编码规则,且具备一定的数据流分析和路径分析能力,能力比CheckStyle稍微强点,并且 PMD 支持自定义规则,PMD可以直接使用的规则包括以下内容:
$ S7 Z' L) N. k: W! @- L3 c
) A0 F& O& M D7 }, X) |# K 潜在的bug:空的try/catch/finally/switch语句0 z- m6 U& i, A- Z" r1 |
未使用的代码(Dead code):未使用的变量、参数、私有方法等) w7 @2 |& w5 v8 [( g Z
可选的代码:String/StringBuffer的滥用
6 R. w3 _0 j- h9 Y3 U! _6 T 复杂的表达式:不必须的if语句、可被while替代的for循环
6 K# k4 T( ~/ a/ q 重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs
1 F( T( {; _ W6 z 循环体创建新对象:尽量不要在循环体内实例化新对象+ z, i) A! w. t2 I r3 P
资源关闭:Connect,Result,Statement等使用之后确保关闭掉
' Y4 _9 \% f8 V2 x/ p; I+ t7 s# T4 \+ ?1 e9 N
2、安装步骤:
! _ w9 e; u) E' w 通过 File > Settings > Plugins > Marketplace 搜索 “PMDPlugin”,按照提示进行安装,然后重启即可 3 ~- k4 v- E: d( g' {2 V
3、使用说明:
: l# p( q: c; s' B* x- l3 V6 o4 R) w2 E" O+ [: _) D( {5 p
参考文章:http://wjhsh.net/andy-songwei-p-11830812.html- C# J3 \8 T# _ r& |8 W0 `
/ T# g8 ]. I: p: T$ d2 A& X
3.1、运行方式: " \3 s# o9 A( ?: S3 _- _
(1)从Tools菜单中启动:
/ |5 @6 ?) R" {2 F% x2 o 通过 Tools > Run PMD 可以看到如下的界面,如果通过该方式启动,扫描的范围就是整个项目中的文件了。
" l. ]1 @8 J# V' @# G9 [0 g! ~' [ E; ]% P% W R
Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。
2 ]; ]4 R3 u7 R c9 @+ R: `% n Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。
9 Y( M4 `# Y9 J' E
0 m! A9 |* @1 ^5 r$ x, q; ` (2)从右键菜单中启动: " p8 I% S) M' O8 h, _
在文件或者编辑器中点击右键,也可以看到“Run PMD”选项,如果通过该方式启动, 检测范围取决于鼠标或光标当前所选中的区域。
7 Y. H0 O: ~# l" {# j$ b1 r 3.2、运行结果: % E' U" |/ O% r9 i: H$ A: {

: g- j( Z- M+ ?# ^8 L- J" N% M 运行后会出现如上所示的面板,左边工具栏,鼠标停留在上面会提示其功能;右边显示了检测结果,当点击具体某一问题项时,会跳转到对应的源码中。 0 E" W, i, Z% }' y1 M, H
3.3、配置检测规则: 9 M5 k! H5 g) @4 G- r+ j
通过 File > Settings > Other Settings > PMD 可以打开检测规则的设置界面:
& `4 \! C: @. F$ q) }3 \0 Q* O  5 f! \" K: H E4 \# D9 h
在 “RuleSets(规则设置)” 界面可以管理自定义的检测规则。因为在实际工作中,可能需要根据实际情况自定义检测规则,就可以通过这里导入,如果要使用它,需要在启动PMD进行检测时选择该自定义规则。 & F' X& V2 `* c* C2 T( C t
点击“Options”选项卡,在其中可以配置一些检测规则选项:
7 }. A$ L$ p R1 M5 m7 w8 N4 P 
4 [/ |' e/ ?4 ^9 @* y# ` 其中重点需要留意的是“Skip TestSource”这一项,因为在项目中有不少Android Studio自动生成的测试代码,如下所示,选择上述选项后可以将其过滤掉。
. b5 t: {- l5 J' m 四、FindBugs:
2 T5 S$ u8 ]* w& T' c6 v' z+ m& Y" l 1、整体介绍:
0 B' U$ b# s5 w6 M3 i# F* B& } FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考
: S" L1 \# ?1 g1 y9 O 2、安装步骤: # Y6 ?- t7 e4 k0 d9 T) d
通过 File > Settings > Plugins > Marketplace 搜索 “FindBugs”,按照提示进行安装,然后重启即可 * E* ^: i/ m- x+ l$ L. e$ r
3、使用说明: , b& S8 @( t' z8 s$ y% P5 x
FindBugs 可以分析单个文件、包下面的所有文件、整个module下的文件、整个project下的文件,右键想要分析的文件名/包名/module名/project - q) w/ i; b( h* P+ O0 k

9 s8 o" O$ b. T' K# h 分析完之后就会出现结果面板
5 B' q/ E' H6 ^ e$ _ 
3 h4 y7 R V. W, p5 ?. ?2 _! _2 y4 c 点击对应的item在右边会定位到具体的代码,这是根据提示进行处理修改就行 1 o( t- e9 z, E: E0 ^
$ `- i# v/ z( S8 p
4、附:常见的错误信息 * s( l$ \, {9 \. r
4.1、Bad practice 代码坏习惯:
! _- a) V" n3 Q3 G, o* p j! l; @8 w, @; q
图片
\# r$ r0 |6 u 4.2、Dodgy code 糟糕的代码: % Z# n6 V' D, H4 I' E
" t; }. M+ k/ \3 F0 s% O# d" m 4.3、Internationalization 代码国际化相关: 3 K x3 j& b* ~# X1 r4 X) F
4.4、Performance 代码性能相关:
- s* ~& z' w$ g% H
& l, }. `: E1 t9 E) B/ p9 T 4.5、Experimental:
$ p" g5 l+ G# V& N' d4 k- B0 S! N0 i
8 B8 W- j! X9 `" @ 4.6、Malicious code vulnerability 恶意破坏代码相关:
' N2 t$ ?- O3 k
+ r- k5 V/ S# S3 x$ S- w' {1 E 4.7、Multithreaded correctness 多线程代码正确性相关:
, @0 k k' q! Q1 V. p 4.8、Correctness 代码正确性相关:
7 m" e$ v- Q6 d5 t5 L& R
( s/ j( X* s9 I# |( t& ]" j% S 五、SonarLint:
* i7 m8 J1 ~" J& } 1、整体介绍: , J, n& l/ G% C* V
sonar 比 Findbugs 高了一个层级,它不仅关注常规静态BUG,还关注到了如代码质量、包与包、类与类之间的依赖情况,代码耦合情况,类、方法、文件的复杂度,代码中是否包含大量复制粘贴的代码,关注的是项目代码整体的健康情况。sonar 有两种使用方式:插件和客户端,sonar 的插件名称为 sonarLint。
2 i) V; q/ y, J- ~8 A" o 2、安装步骤: * T/ P0 J6 D& y [& t
通过 File > Settings > Plugins > Marketplace 搜索 “SonarLint”,按照提示进行安装,然后重启即可 # E. k: ]7 Z( [ D; k
3、使用说明: 5 F) A! D P! ?
" [- q8 Q4 l* [! a( g2 L
右键项目或者文件进行如上图所示操作,执行之后可以看到如下信息,如果代码中有不合理的地方会在report中显示,同时点击错误的地方在右边会给出建议的修改供参考。
" i( W# {, l3 k- z9 o. W' ?3 e4 [, ?1 W# Z6 T7 f
4、配置 SonarLint 服务端: + h" H4 O% n8 }3 g i/ a% U
4.1、配置 Sonar 服务器:
5 {, P K( w* _* q" G/ A2 t& | _/ v sonarLint 插件的使用场景是自用自审,但 sonar 也提供了平台版本,使用场景则是他审,sonar 平台的搭建就不在这篇文章介绍了,感兴趣的读者可以自己上网查看,我们这里主要介绍如何在 sonarLint 插件中配置关联 sonar 平台服务器的工程,进行本地检查:
4 k+ H% p0 v+ _. ]- m/ x2 x9 D& ]; X5 i
点击新增按钮,输入Configuration Name,配置sonarlint 服务器的地址,然后下拉框选择 Login/Password,输入 sonarlint服务器的账号密码
1 U: ?) J* O* R. }/ N+ N
; c, B6 p/ ^& H) E: { 4.2、具体 Sonar工程配置: $ ?0 Y/ k1 |* @% s" r7 L+ ?# N
配置完服务器之后,需要针对具体工程进行配置,点击 connection下拉框,选择上面配置好的服务器连接,然后点击 Search in list,找到对应的工程: ! R. x, s( t/ x5 f% i2 e9 E) E
9 y" |) ?" E( Y9 X$ U* B7 g
4.3、使用 SonarLint 检查: # q Y2 a8 x z: J. v- M3 ]
配置完上面两步之后,接下来就可以选择要进行检查的类或者目录进行 sonarlint 检查了(跟第3点的使用方式一致),同时,在 commit 代码的时候,勾选 “Perform Sonarlint analysis”,会针对你要提交的代码进行sonarlint检查
* |; A$ v2 j) D+ F' C5 d( d+ [* ]$ z& S5 W
总结 # x/ Y5 g7 w: M2 O3 l" E' Q. E
/ r$ u1 {( d! Q# i/ c+ G3 Z
检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了
/ O0 V$ G" M) N$ L I: r 找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充:
2 J/ J. [- w" V5 Y# M PMD 自定义能力强,用来自定义项目BUG规则非常好用
" `/ M8 L7 R; T" O Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。
: s- s& y9 t+ _. [/ M3 f l) | SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景
! P8 Y9 Q& N5 K' N: b1 E6 i1 m( B% Q; H
文章由重庆腾憬文化科技有限公司新闻事业部整理,仅用于学习交流,版权归原作者所有,如有问题,请及时与我们联系,我们将第一时间做出处理。返回搜狐,查看更多
. `+ H4 S, X" j0 f; A; f$ |* l! c
责任编辑:
3 F- h+ U, s/ G' z0 ?) l: p( ]/ u2 M+ t) _. Y! X! p
3 ?) H" k- y& ~# e4 H2 c/ ^# V" ]' t1 O, ^
+ |" y2 t2 M3 p/ a( {, a/ i
|