|
+ u$ k/ X; F2 q; m* T+ I
原标题:腾憬文化科技香港科技事业部 | 五款IDEA 插件,堪称代码质量检查利器! 4 z% U/ T- ]' [2 r
: f7 d q y/ M+ } 随着业务的发展,系统会越来越庞大,原本简单稳定的功能,可能在不断迭代后复杂度上升,潜在的风险也随之暴露,导致最终服务不稳定,造成业务价值的损失。而为了减少这种情况,其中一种比较好的方式就是提高代码质量,比如通过代码审查,从而降低错误风险,但是,代码审查难度大,代码缺陷、漏洞不易发现,且审查工作随着代码量增加而增加,审查效率低。 ) S2 m9 E3 W! B x* Y
工欲善其事,必先利其器,因此,这篇文章给大家介绍几种检查代码质量的利器,Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint,让你在关注代码质量的同时,减少 code review 的工作量,提高 code review 的效率,并通过代码质量分析去反向提升我们的代码编写能力 4 s! ]4 d7 T* l7 l8 s( J
一、Alibaba Java Coding Guidelines
3 @6 [, f' h8 A: @& N 1、整体介绍: - x, l3 u4 p6 {) f% u" _
Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。
5 n O, O# g0 F# _; }) t, T 阿里巴巴规约扫描包括: ' @8 H4 ` n& ]% W
4 x* z4 [2 ^& V: W7 q7 h
OOP规约7 ~. y9 u& Q/ J! \8 l* O
并发处理0 t/ b/ O& A8 d S4 Q$ M3 A
控制语句
, ^* L- _# q5 x$ H$ G 命名规约1 Z( m# u+ _1 k' U" n
常量定义
, \ R& E8 ~3 t) Q( w. z6 o 注释规范
2 c& [& d" h1 V' n. Q d( o* @0 l
: j: K2 o$ ^- S# \ 2、安装步骤: , T9 |+ t* l) N! _+ o9 A9 D( W
File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。
3 f* K6 \" A4 X 3、使用说明: : N) a+ D( ] _+ Z% x
3.1、运行方式: . T+ k. P9 P( s+ i# C9 c! D/ r
(1)可以Tools > 阿里编码规约 > 编码规约扫描
! E6 [" h, l9 s* f: w8 E# V% d 
0 \' s$ l3 B y3 z& i (2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可: 2 p8 i) E( q8 I; y2 S) e
 6 |9 O' O. i6 h8 }7 |2 L
3.2、菜单功能: - ?7 k6 p1 z7 x( d" d* g
/ Z- g2 R, I; f 编码规约扫描:开始扫描代码
5 Z1 p. T) g! r- V 打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能; m( Y$ B- L/ d
切换语言至英文:中英文切换
$ R# `8 G4 C, g3 ^7 A0 c! D$ m* T
% s5 w0 H9 K: |' n 3.3、运行结果: " h% h/ ?& o. t% c$ j' ~7 L' d' D
扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。
( J8 e, ^) g! I# s  ) J& B& S. T' l' X
选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到): : A+ L8 @% l- ^5 u5 Z# ]$ K2 F

" O0 x9 H& |$ i/ e5 ]& L0 x- H+ s; Q (1)指定区域搜索同一类问题: - |5 x/ ^# Q; x$ B
当点击③处的按钮时,会弹出如下按钮:
; ?$ H( O0 w# V6 d4 P5 o  3 }* | I2 O( a- T; J7 A
这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示: " X1 Q; r: m2 \& q" F

+ ?! H; ]$ [) n9 |* T: g/ ~5 J 这里我们可以看到,显示了整个Project中的所有该类的问题。
N3 ?0 K2 H7 M% O (2)预览具体的不规范代码:
# k3 ~5 {' w: C1 j1 W) \, @1 |0 [ 如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。
2 Z7 W l1 Z3 h+ e 
+ Q) E( o3 Z/ J 3.4、工具栏功能介绍:
- \) F4 w- z$ _$ K0 _  % x3 _" C, I W
( u+ r" b9 y; h3 q Rerun Inspection:重新运行一次扫描
9 K/ k- N( g) t5 c. y" J Close:关闭真个AJCG面板
& [. F: }) y0 ~: t. Q) k# F Expand All:展开结果的树状结构,整个结果是树状结构的。
, I! ~3 H: d X; i1 s; D Collapse All:收起结果的树状结构/ E8 O: @* W! u5 G
Go Pre Problem:选择上一个问题1 b2 J- W: S5 C6 y& k+ z7 K3 g) B8 q
Go Next Problem:选择下一个问题6 y" l* h. ~2 l2 B# w- i+ a) B) d
Help:帮助
+ Y: s z, s E9 Q) L, [6 | Group by Serverity:(不知道如何描述)- S0 Z- D7 \) ~3 f
Group by derectory:按目录分组/按类名分组间切换
( W5 E3 [# X7 m/ B Filter resoled items:过滤掉已经解决的项, \3 b3 V, ~$ _2 T
Autoscroll to Source:自动滚动到源码
9 R" ]& b4 u2 w) L Export:导出,可以导出为XML和HTML两种格式
8 @. X; d$ C1 x, c/ i1 \ Edit Settings:编辑设置
9 I! f) i" Z5 ^" g5 }4 E0 n+ p: a! A; ]* g
二、CheckStyle:
$ P3 J6 B3 A& e/ u6 j 1、整体介绍:
$ x0 {' J* |, D3 Y& s CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。 7 n. m% F$ E" W
Checkstyle插件中默认内置有2个执行代码检查的配置文件(Sun Checks 和 Sun Checks),但是这两个文件检查的非常详细严格,即使优秀的开源项目也会检查出来有非常多的错误告信息,所以需要导入我们自定义的配置文件。 & x6 Q" D- I& j: t
2、安装步骤:
/ n, ?/ I L. B3 z* c. s$ m 通过 File > Settings > Plugins > Marketplace 搜索 “CheckStyle”,按照提示进行安装,然后重启即可。
' ^" o: j8 j/ S9 S 3、使用说明: . U+ q# I- m5 l: t" R+ T1 Y4 f! ~

" [6 B5 N# W {" S. _$ q 可以看到基本都是一些缩进啥的编码规范,可以不用太关注 3 P* h1 a, W% V3 c8 ~# P
三、PMD
$ {% M% B0 | Q2 M; l 1、整体介绍: # G. [, H) x! M1 \& o
PMD侧重面向安全编码规则,且具备一定的数据流分析和路径分析能力,能力比CheckStyle稍微强点,并且 PMD 支持自定义规则,PMD可以直接使用的规则包括以下内容: ! {1 j0 J- ?9 @6 @0 Y; e6 K
/ I2 \0 K( b( S 潜在的bug:空的try/catch/finally/switch语句
& P" w, y/ Q5 o; ^% }7 j6 S 未使用的代码(Dead code):未使用的变量、参数、私有方法等
A# `5 y2 j( S( O. d. n# I 可选的代码:String/StringBuffer的滥用- N4 d. {% d# ~! o. Y3 A- x! j
复杂的表达式:不必须的if语句、可被while替代的for循环
2 I, R- X" _* o& T, _- R! h 重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs
) O3 g) N- j/ g4 q/ H2 t' T 循环体创建新对象:尽量不要在循环体内实例化新对象8 i# r! ?! z2 l6 W9 C' A
资源关闭:Connect,Result,Statement等使用之后确保关闭掉
* S& ~! p# O5 z9 Z6 W2 g- O$ p! N- p
2、安装步骤:
4 V1 y, K5 v+ ^6 r: b8 i5 R, a 通过 File > Settings > Plugins > Marketplace 搜索 “PMDPlugin”,按照提示进行安装,然后重启即可
9 K4 j2 B% i8 C! j/ Z, q4 ^. k 3、使用说明: 2 s. z6 U2 W' A |9 E
: J: z; K$ d: f
参考文章:http://wjhsh.net/andy-songwei-p-11830812.html
7 D- @0 r" q$ H3 A! H- N+ }- s0 [4 z5 f( m
3.1、运行方式: $ q% Y) C, d7 I6 o& Y
(1)从Tools菜单中启动: 1 u2 b& G$ z" ?5 W' D
通过 Tools > Run PMD 可以看到如下的界面,如果通过该方式启动,扫描的范围就是整个项目中的文件了。 / h. R7 z" Z8 Y: L s* k2 k
1 D- |% R" }! Q8 s% \2 Y; |6 W
Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。
C; M: r t. J; ^) |" g, W7 J/ k Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。
; _' u5 s9 a8 y/ q1 k" m' o# \3 r- ]7 U. S. U" f! a5 v. E q; _
(2)从右键菜单中启动:
+ {$ f Y" E5 ]; X 在文件或者编辑器中点击右键,也可以看到“Run PMD”选项,如果通过该方式启动, 检测范围取决于鼠标或光标当前所选中的区域。 3 K- x' c7 P5 ]5 y
3.2、运行结果: 6 X4 B" v4 F* O7 V/ |( N
 - _1 {: |5 U2 u) V, U& }' \, i N
运行后会出现如上所示的面板,左边工具栏,鼠标停留在上面会提示其功能;右边显示了检测结果,当点击具体某一问题项时,会跳转到对应的源码中。 9 G( Z/ |& l+ P8 |% ]0 ^1 p
3.3、配置检测规则: ( N8 T1 e0 l$ W0 }: i7 J5 v
通过 File > Settings > Other Settings > PMD 可以打开检测规则的设置界面: 7 M+ u: u9 D7 H6 D. r4 c
 $ V) O3 m" K5 O# ?
在 “RuleSets(规则设置)” 界面可以管理自定义的检测规则。因为在实际工作中,可能需要根据实际情况自定义检测规则,就可以通过这里导入,如果要使用它,需要在启动PMD进行检测时选择该自定义规则。 % [( Z6 ?) o' x* j2 C# W( x
点击“Options”选项卡,在其中可以配置一些检测规则选项: # g+ {4 b' Z# {6 g; T' P
 4 t/ U% Y: ^& a- H, x7 y. l
其中重点需要留意的是“Skip TestSource”这一项,因为在项目中有不少Android Studio自动生成的测试代码,如下所示,选择上述选项后可以将其过滤掉。
' ?# w& @/ B+ O; F 四、FindBugs:
! o5 q9 g$ d8 u 1、整体介绍: 2 ?( w( {4 H( d$ G& J) b- h
FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考 6 e2 j) S! w' u N1 U0 g$ c4 @* ^0 V
2、安装步骤:
8 ^% O2 a+ n2 k 通过 File > Settings > Plugins > Marketplace 搜索 “FindBugs”,按照提示进行安装,然后重启即可 0 y( x3 K x0 J8 k$ ?
3、使用说明: F7 M' h6 g# |# d4 h
FindBugs 可以分析单个文件、包下面的所有文件、整个module下的文件、整个project下的文件,右键想要分析的文件名/包名/module名/project
5 f5 [, [4 s% ?$ E5 H" j) n7 { 
. y8 L( N0 w: N2 w 分析完之后就会出现结果面板
2 B3 u( @- D8 P! j* H' D) G- ^/ M1 C  2 w7 r9 v. u* b Y
点击对应的item在右边会定位到具体的代码,这是根据提示进行处理修改就行
& _4 w4 _! [! ?; R1 |1 D6 c6 o8 i8 i, ^, n& h% H' M, R& c
4、附:常见的错误信息 ; S- n( U7 n# \8 M4 V
4.1、Bad practice 代码坏习惯: ! P, x; A8 \. ~: b2 D
) B) A l& A+ J j- f
图片
7 @8 e# v- n. l) q" @5 N 4.2、Dodgy code 糟糕的代码: : C0 |* J7 T1 V( g
& g3 }4 ]' m6 |% u u 4.3、Internationalization 代码国际化相关: 9 W. k' H4 e& Q2 j
4.4、Performance 代码性能相关: ( b5 N$ @; |4 x; o t7 R
* G0 Y) }8 o) Z8 s% | 4.5、Experimental:
" g# ?# z4 f% w5 p0 G: F1 [/ I9 k, O% z8 K
4.6、Malicious code vulnerability 恶意破坏代码相关: e) k5 a; u& O8 k
& Y5 X# t" ]1 \3 n( e9 c @, {- g! Z
4.7、Multithreaded correctness 多线程代码正确性相关:
8 Q4 a$ i- \$ t& O 4.8、Correctness 代码正确性相关: 5 P5 t5 a% U1 R# x$ T$ S0 L7 J" Q
, a5 Q2 ]. m" h: f& s7 J2 O. k
五、SonarLint:
& z; C/ ]% O1 U 1、整体介绍:
+ `8 ~3 x% l; l0 f ]: C+ P sonar 比 Findbugs 高了一个层级,它不仅关注常规静态BUG,还关注到了如代码质量、包与包、类与类之间的依赖情况,代码耦合情况,类、方法、文件的复杂度,代码中是否包含大量复制粘贴的代码,关注的是项目代码整体的健康情况。sonar 有两种使用方式:插件和客户端,sonar 的插件名称为 sonarLint。 7 i" K0 k0 c$ c& H
2、安装步骤:
A' j# i8 l L$ r8 x9 c a9 r 通过 File > Settings > Plugins > Marketplace 搜索 “SonarLint”,按照提示进行安装,然后重启即可
+ C4 J, E; ^* b" Q7 o 3、使用说明: ' ?5 G8 P: }& [
* E7 A: B" `" z4 g6 G. U! z5 h' q/ q+ x
右键项目或者文件进行如上图所示操作,执行之后可以看到如下信息,如果代码中有不合理的地方会在report中显示,同时点击错误的地方在右边会给出建议的修改供参考。 " W$ Z) D% f; ~# u3 E, \& H
4 W! |+ N G( ]& H
4、配置 SonarLint 服务端:
6 m E% ~' e3 P8 @& O, h. P, K 4.1、配置 Sonar 服务器: . V$ }) ^* C( ^
sonarLint 插件的使用场景是自用自审,但 sonar 也提供了平台版本,使用场景则是他审,sonar 平台的搭建就不在这篇文章介绍了,感兴趣的读者可以自己上网查看,我们这里主要介绍如何在 sonarLint 插件中配置关联 sonar 平台服务器的工程,进行本地检查:
5 q3 n" E! G6 m# l* Q) Q6 s. `4 V1 x1 R A
点击新增按钮,输入Configuration Name,配置sonarlint 服务器的地址,然后下拉框选择 Login/Password,输入 sonarlint服务器的账号密码 7 z# Q3 z- ]; v
9 j, ^( A# s4 [+ _4 ~& c
4.2、具体 Sonar工程配置:
$ G. b$ f+ y" s2 U% ? 配置完服务器之后,需要针对具体工程进行配置,点击 connection下拉框,选择上面配置好的服务器连接,然后点击 Search in list,找到对应的工程:
" C& S) k- e3 t! ?. {. |( N9 x% @; b/ `3 Z2 p r, q6 ?
4.3、使用 SonarLint 检查:
; V0 @4 ^# L$ a6 T0 O+ r 配置完上面两步之后,接下来就可以选择要进行检查的类或者目录进行 sonarlint 检查了(跟第3点的使用方式一致),同时,在 commit 代码的时候,勾选 “Perform Sonarlint analysis”,会针对你要提交的代码进行sonarlint检查 ) q$ [! X2 b2 F) |, ^$ L
$ o; C! j* A: a9 |9 K0 N
总结 3 u& m/ _; I3 ~4 j: o' Z
6 O; C" A) P9 a) p0 J1 I) s 检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了
' u: J$ e6 w7 ^ 找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充:; s, I% q" ~- e% I: e9 P) Q. V$ B+ O
PMD 自定义能力强,用来自定义项目BUG规则非常好用! W9 ?& W- p4 o+ z% H* @
Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。. \. V# V$ t0 g! |8 r
SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景
3 }+ {& m$ Z4 |7 D- k2 j% F) p/ s% N1 F- a# y1 Q1 v! ~" t
文章由重庆腾憬文化科技有限公司新闻事业部整理,仅用于学习交流,版权归原作者所有,如有问题,请及时与我们联系,我们将第一时间做出处理。返回搜狐,查看更多
4 o. `5 A Q. P1 O# c! |/ R% L. F c, m* F% a& J$ H
责任编辑:
k' e4 M/ n1 x. c2 e$ ?4 ?, ~
( C4 Q( D4 j6 E- C* R0 p! d/ [* U4 S5 X q
. f& N2 k, O/ Y, u
) Y; ?' _; t; }% E) m2 E( ] |