收藏本站 劰载中...网站公告 | 吾爱海洋论坛交流QQ群:835383472

腾憬文化科技香港科技事业部 | 五款IDEA 插件,堪称代码质量检查利器!

[复制链接]
( w0 i( F, L3 m- N" @4 B, q

原标题:腾憬文化科技香港科技事业部 | 五款IDEA 插件,堪称代码质量检查利器!

) Q0 O7 P+ i7 p" w& N( Q/ O. }3 W/ e. _5 T

随着业务的发展,系统会越来越庞大,原本简单稳定的功能,可能在不断迭代后复杂度上升,潜在的风险也随之暴露,导致最终服务不稳定,造成业务价值的损失。而为了减少这种情况,其中一种比较好的方式就是提高代码质量,比如通过代码审查,从而降低错误风险,但是,代码审查难度大,代码缺陷、漏洞不易发现,且审查工作随着代码量增加而增加,审查效率低。

+ N( j; \: E$ }$ ?" J8 @

工欲善其事,必先利其器,因此,这篇文章给大家介绍几种检查代码质量的利器,Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint,让你在关注代码质量的同时,减少 code review 的工作量,提高 code review 的效率,并通过代码质量分析去反向提升我们的代码编写能力

+ Q8 d0 Z0 B& B$ B$ e( u

一、Alibaba Java Coding Guidelines

% u) Z; }+ S& l9 f# @

1、整体介绍:

) E# v4 v& Q# ~ Z

Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。

9 y9 ~' i# W9 _/ y

阿里巴巴规约扫描包括:

6 }6 f/ j( { |6 _& v. W+ K$ n. S$ |/ C3 B& b7 h$ o OOP规约 2 e7 j/ o" E/ V9 U1 h9 g" I 并发处理 5 V7 g6 [) ~, y 控制语句 & E4 V" A! l, C- M6 C" W' } 命名规约! k$ x- \4 {/ o# q& X- u2 Y( p. | 常量定义 4 X4 E& u9 P' D; u% a6 O9 e8 y 注释规范 8 c% u; \9 Y. R R' L3 s! D' e0 |! k% U6 x) c( {

2、安装步骤:

; h, s+ ]+ _9 O+ H7 n

File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。

* T: x. A0 K8 _& r/ E" F% j' A' h

3、使用说明:

1 V6 K- q8 ?, s/ @" g8 @

3.1、运行方式:

7 b' G: O1 m0 H. S( \. L

(1)可以Tools > 阿里编码规约 > 编码规约扫描

- p# Q9 X* C. o- m( X+ Q

# i" d4 g% ~) B1 `; f! k

(2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可:

" E+ b2 ]; G+ R7 h: y( L

! J, e! t& m- K9 N) v! \! r

3.2、菜单功能:

$ t7 P$ K- T) K; _1 f$ k( s" p7 v9 d8 [+ u- J 编码规约扫描:开始扫描代码 2 S- i9 X) ]; S. b P 打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能 ' t y$ |- n0 } 切换语言至英文:中英文切换3 x: ~' J4 Z, v$ ?+ _9 C6 m # O& K. l5 {0 M: ^: S

3.3、运行结果:

; `, `% q# P9 `2 _

扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。

' U/ ^( {; K7 D. g0 ?; G% }% a

, ^# k# i$ j7 [6 ?; e8 U i" b

选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到):

7 J& a1 K# L% ]- F0 d0 }: i. S

% Y2 n8 o) h+ P a2 P

(1)指定区域搜索同一类问题:

, [, m' [, V% w# K4 S3 c& b0 ]( X

当点击③处的按钮时,会弹出如下按钮:

0 e. e8 W0 p B. r0 @

8 x7 W' N5 Y$ s8 W& W& k" R$ z

这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示:

. _; ]1 z/ R0 w

- r, k7 \; r0 X0 g/ V

这里我们可以看到,显示了整个Project中的所有该类的问题。

* I n' B4 t# Y

(2)预览具体的不规范代码:

X9 z5 Q' [& z

如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。

' b" h3 i3 H2 g& |) i/ {" ]

& R y4 w; {) V+ A q

3.4、工具栏功能介绍:

3 i8 S* j# V: k8 e, [- l! O

$ N* U9 o0 }* t$ K% S* ]4 G9 o3 H% w) \2 Q& @. ] Rerun Inspection:重新运行一次扫描6 B8 [, s2 \$ ^4 h! h' }7 M" K Close:关闭真个AJCG面板6 l# A5 N4 n% s( @6 d9 w6 N- v# S Expand All:展开结果的树状结构,整个结果是树状结构的。 5 ^: S, O- u' A3 w1 y2 B0 P" I Collapse All:收起结果的树状结构- {! v0 c% p8 i# F, ` Go Pre Problem:选择上一个问题 9 ^/ S2 n" l0 U Go Next Problem:选择下一个问题 & v( E) S, J; C9 V7 P Help:帮助$ {' L/ N3 w! { Group by Serverity:(不知道如何描述)' t5 h S0 ?1 T; [/ q9 K" u Group by derectory:按目录分组/按类名分组间切换 3 l1 |( Y8 _) q1 p1 G6 ^! Z Filter resoled items:过滤掉已经解决的项1 Q# U5 [0 R+ g0 [5 r6 Z% T- V Autoscroll to Source:自动滚动到源码 q3 y% Y& ?* J: n Export:导出,可以导出为XML和HTML两种格式. N, X# E1 m7 V. l& ~ Z Edit Settings:编辑设置 ! s# x8 V$ X9 [. q+ M: L, p % J1 m' R1 ^! [# S6 _ u

二、CheckStyle:

, R$ i& }5 M; a! Q; t, s P

1、整体介绍:

/ O* `- p: {: |% _ i- D0 _

CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。

; Z2 ]. ?! H' d. S- _) c

Checkstyle插件中默认内置有2个执行代码检查的配置文件(Sun Checks 和 Sun Checks),但是这两个文件检查的非常详细严格,即使优秀的开源项目也会检查出来有非常多的错误告信息,所以需要导入我们自定义的配置文件。

7 h& [. v) T% {$ M0 G! [1 R

2、安装步骤:

. H2 U U6 h/ q, ]* T5 R: Y* _

通过 File > Settings > Plugins > Marketplace 搜索 “CheckStyle”,按照提示进行安装,然后重启即可。

- F3 B. B! w, b- ]. j, p

3、使用说明:

* P$ O6 A3 Q4 r7 a3 S; S$ i3 Z5 c0 D

" `) T$ `+ _8 [

可以看到基本都是一些缩进啥的编码规范,可以不用太关注

/ E0 p4 C7 d: W0 N

三、PMD

( M0 r& n# K) V

1、整体介绍:

M7 @* T/ s0 [9 S

PMD侧重面向安全编码规则,且具备一定的数据流分析和路径分析能力,能力比CheckStyle稍微强点,并且 PMD 支持自定义规则,PMD可以直接使用的规则包括以下内容:

* p0 A- F6 y7 P2 y3 A% k% s $ y7 n8 ]" u9 W7 \/ b 潜在的bug:空的try/catch/finally/switch语句 9 J# ]" z! x2 [8 p! I 未使用的代码(Dead code):未使用的变量、参数、私有方法等 5 g6 y: w7 N0 D6 ?' P 可选的代码:String/StringBuffer的滥用/ B: y1 d. C- g2 ?4 J l 复杂的表达式:不必须的if语句、可被while替代的for循环 / ]; e6 l; X3 Y5 {2 c 重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs- m2 e% w; A& n+ }6 Q8 F0 M. S# i 循环体创建新对象:尽量不要在循环体内实例化新对象 ) B0 w9 q% y: q* d 资源关闭:Connect,Result,Statement等使用之后确保关闭掉 h* e/ I+ K S) x$ p, v ]% T* D9 ~2 J

2、安装步骤:

K* T/ c ^9 a _. M( w. [

通过 File > Settings > Plugins > Marketplace 搜索 “PMDPlugin”,按照提示进行安装,然后重启即可

: w4 }! b8 G' u

3、使用说明:

5 @' O# L' u% w% ] # H. s% _8 { V/ ` 参考文章:http://wjhsh.net/andy-songwei-p-11830812.html ! Q- ?% o7 j' q) p4 ?- v ' [' X6 u' o. r* D" N6 a5 m2 N

3.1、运行方式:

d' i% c3 e3 M6 c& X" f

(1)从Tools菜单中启动:

H& N. @$ r. s( `% |$ N. T

通过 Tools > Run PMD 可以看到如下的界面,如果通过该方式启动,扫描的范围就是整个项目中的文件了。

2 t+ @0 f0 d# D' e7 ^* N" p& N; P# G m5 i8 @6 l Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。( x- v: t: l) P9 W* F Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。* J: U, p. u# I- g W. r" T 2 D6 b' r# b7 v2 `. V) F0 W

(2)从右键菜单中启动:

u! O* e5 E6 q5 U2 W }* {

在文件或者编辑器中点击右键,也可以看到“Run PMD”选项,如果通过该方式启动, 检测范围取决于鼠标或光标当前所选中的区域。

0 H& k* E0 A' f

3.2、运行结果:

7 ^, D; Q7 j# _0 d: p0 u; Y9 z

$ ?0 x- Z, l. f x, ?8 Z

运行后会出现如上所示的面板,左边工具栏,鼠标停留在上面会提示其功能;右边显示了检测结果,当点击具体某一问题项时,会跳转到对应的源码中。

& A) `+ J3 |& C7 _

3.3、配置检测规则:

; ~! u1 m+ F: _

通过 File > Settings > Other Settings > PMD 可以打开检测规则的设置界面:

4 X! O! \/ j, j! U, F

4 X% z S* v1 K: [' x2 d. D

在 “RuleSets(规则设置)” 界面可以管理自定义的检测规则。因为在实际工作中,可能需要根据实际情况自定义检测规则,就可以通过这里导入,如果要使用它,需要在启动PMD进行检测时选择该自定义规则。

7 M# i! {& m; s- ?- U3 z9 _

点击“Options”选项卡,在其中可以配置一些检测规则选项:

- C. L( d( i& [& B5 q+ m

# n3 E, E+ {- ~$ U' t6 |

其中重点需要留意的是“Skip TestSource”这一项,因为在项目中有不少Android Studio自动生成的测试代码,如下所示,选择上述选项后可以将其过滤掉。

- T9 c& k1 q! s- l

四、FindBugs:

. Q4 l1 q3 h ` d( [

1、整体介绍:

/ N) X/ n* V i3 U0 G5 i

FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考

2 x+ Z0 g: \2 J1 c# m

2、安装步骤:

) Y* L! t+ \# |; @7 [# G

通过 File > Settings > Plugins > Marketplace 搜索 “FindBugs”,按照提示进行安装,然后重启即可

$ Q* g! Y7 b W; A

3、使用说明:

8 Z; W2 i! R9 ~; E% [; r* J9 T

FindBugs 可以分析单个文件、包下面的所有文件、整个module下的文件、整个project下的文件,右键想要分析的文件名/包名/module名/project

, Z# f' F+ f( l/ D3 K

' e4 `# P! p2 V! e- b( ~$ f- N" G

分析完之后就会出现结果面板

1 n8 [+ g+ b3 F/ x, s" @" s

6 e6 x; n7 @& y

点击对应的item在右边会定位到具体的代码,这是根据提示进行处理修改就行

2 d" ]' N! N+ E& Y9 H& o/ [9 Q( x2 O. e1 [6 Y$ I) H/ ]/ k: _" A

4、附:常见的错误信息

- H9 B1 }. H4 N j

4.1、Bad practice 代码坏习惯:

; B8 N1 D- I2 D, Q " G$ N: m* Z: b7 G+ o# T

图片

7 l7 @; |0 o: }* H

4.2、Dodgy code 糟糕的代码:

7 k% T, ]& } Q, {) y9 J 8 p E2 E" F2 a8 A3 @! C

4.3、Internationalization 代码国际化相关:

8 j" n" X/ X# q; q; U$ ^

4.4、Performance 代码性能相关:

) W- T2 q8 w+ {. B; R4 }2 f/ X7 W e! `. v2 l

4.5、Experimental:

$ ]. h7 {6 ^8 e2 D( o- L3 E3 i" f7 T

4.6、Malicious code vulnerability 恶意破坏代码相关:

7 |/ z0 W6 | a; u1 l5 j" V( P ! J g7 a. d; z% K

4.7、Multithreaded correctness 多线程代码正确性相关:

( G. `% v9 E) Y2 i2 |" v

4.8、Correctness 代码正确性相关:

$ g9 u6 j: p0 j- f' y ) f+ d7 v# u# }9 o; S

五、SonarLint:

8 w8 ^4 o ?+ L( `

1、整体介绍:

4 l, P! f/ k' ]% F4 p

sonar 比 Findbugs 高了一个层级,它不仅关注常规静态BUG,还关注到了如代码质量、包与包、类与类之间的依赖情况,代码耦合情况,类、方法、文件的复杂度,代码中是否包含大量复制粘贴的代码,关注的是项目代码整体的健康情况。sonar 有两种使用方式:插件和客户端,sonar 的插件名称为 sonarLint。

3 d, q7 b, `2 N

2、安装步骤:

! O% G4 k7 B! M1 b

通过 File > Settings > Plugins > Marketplace 搜索 “SonarLint”,按照提示进行安装,然后重启即可

) U- q, U/ H d5 K% i, o4 a3 j

3、使用说明:

4 E1 a; \# u) x, z6 z$ W9 e9 D, z" ]& w; k- e: s/ e

右键项目或者文件进行如上图所示操作,执行之后可以看到如下信息,如果代码中有不合理的地方会在report中显示,同时点击错误的地方在右边会给出建议的修改供参考。

5 o. F3 }2 n1 i$ r 9 B \- ?! P3 E n

4、配置 SonarLint 服务端:

8 i8 g- G9 J6 ^# J

4.1、配置 Sonar 服务器:

/ }- |4 A: e0 y# S* M

sonarLint 插件的使用场景是自用自审,但 sonar 也提供了平台版本,使用场景则是他审,sonar 平台的搭建就不在这篇文章介绍了,感兴趣的读者可以自己上网查看,我们这里主要介绍如何在 sonarLint 插件中配置关联 sonar 平台服务器的工程,进行本地检查:

5 P' P3 x% z: E" F4 Q+ h# E 4 g( y$ ?' E- C( b& y# M, U- ]

点击新增按钮,输入Configuration Name,配置sonarlint 服务器的地址,然后下拉框选择 Login/Password,输入 sonarlint服务器的账号密码

* r4 a: o% {4 h4 i1 I# \1 T" W6 d 7 i) d7 C* d1 z4 X' B+ z! i

4.2、具体 Sonar工程配置:

2 `1 h& t+ U( ~4 \6 Q5 ]6 \8 A0 M$ w' J

配置完服务器之后,需要针对具体工程进行配置,点击 connection下拉框,选择上面配置好的服务器连接,然后点击 Search in list,找到对应的工程:

- a" E3 X0 f2 Q& C; `2 l ; c% y5 |' c; O/ \& g/ `$ T6 V" g

4.3、使用 SonarLint 检查:

- l/ o+ R8 r9 a+ N/ `

配置完上面两步之后,接下来就可以选择要进行检查的类或者目录进行 sonarlint 检查了(跟第3点的使用方式一致),同时,在 commit 代码的时候,勾选 “Perform Sonarlint analysis”,会针对你要提交的代码进行sonarlint检查

# M4 G9 E6 e; x* \' W * X7 Q8 f1 u+ A* r4 F

总结

1 |; z. \. e6 [! g& R$ T * f7 s) o B& L2 K R0 z 检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了 " @, E) }9 o$ M: o" j- a 找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充: - K3 L. {% M$ |, x6 s/ ^% ^" z PMD 自定义能力强,用来自定义项目BUG规则非常好用9 f. K/ h9 g$ i! i" |+ V* o Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。 2 o [$ T/ g7 H( V SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景 $ K* v" ]$ x; Y 4 f y' T7 m! {0 h( X

文章由重庆腾憬文化科技有限公司新闻事业部整理,仅用于学习交流,版权归原作者所有,如有问题,请及时与我们联系,我们将第一时间做出处理。返回搜狐,查看更多

# b& V) H2 r( J# g' x / Q1 ?7 C U( @& f) ~. c1 t

责任编辑:

5 n; h8 W5 _! _2 o. Z9 I; l : r# z! @% I0 t, R" V) d4 Z- \/ |2 F" f" W ) L; I1 X! o' h$ g6 R5 |/ x6 Y$ m: b/ Z
回复

举报 使用道具

相关帖子

全部回帖
暂无回帖,快来参与回复吧
懒得打字?点击右侧快捷回复 【吾爱海洋论坛发文有奖】
您需要登录后才可以回帖 登录 | 立即注册
家国依稀残梦里
活跃在3 天前
快速回复 返回顶部 返回列表