别再写狗屎代码了,推荐这 5 款 IDEA 插件,让你的代码质量直接起飞!(2)

简介: 别再写狗屎代码了,推荐这 5 款 IDEA 插件,让你的代码质量直接起飞!

三、PMD

1、整体介绍:


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


  • 潜在的bug:空的try/catch/finally/switch语句
  • 未使用的代码(Dead code):未使用的变量、参数、私有方法等
  • 可选的代码:String/StringBuffer的滥用
  • 复杂的表达式:不必须的if语句、可被while替代的for循环
  • 重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs
  • 循环体创建新对象:尽量不要在循环体内实例化新对象
  • 资源关闭:Connect,Result,Statement等使用之后确保关闭掉

2、安装步骤:

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


3、使用说明:

参考文章:http://wjhsh.net/andy-songwei-p-11830812.html

3.1、运行方式:


(1)从Tools菜单中启动:


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

image.png



Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。

Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。

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


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


3.2、运行结果:


image.png


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


3.3、配置检测规则:


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


image.png


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


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


image.png


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


image.png


另外,IDEA 正版激活方法,可参考我之前分享的教程:https://www.javastack.cn/intellij-idea-reactivation-succeed/


四、FindBugs:

1、整体介绍:

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


2、安装步骤:

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


3、使用说明:

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


image.png


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


image.png


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


image.png


4、附:常见的错误信息

4.1、Bad practice 代码坏习惯:


image.png


4.2、Dodgy code 糟糕的代码:


image.png


4.3、Internationalization 代码国际化相关:


image.png


4.4、Performance 代码性能相关:


image.png


4.5、Experimental:


image.png


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


image.png


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


image.png


4.8、Correctness 代码正确性相关:


image.png


五、SonarLint:

1、整体介绍:

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


2、安装步骤:

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


3、使用说明:


image.png

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


image.png


4、配置 SonarLint 服务端:

4.1、配置 Sonar 服务器:


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


image.png


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

image.png



4.2、具体 Sonar工程配置:


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


image.png


4.3、使用 SonarLint 检查:


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


image.png


总结

检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了


找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充:


PMD 自定义能力强,用来自定义项目BUG规则非常好用

Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。

SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景

版权声明:本文为CSDN博主「张维鹏」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。原文链接:https://blog.csdn.net/a745233700/article/details/126202100



相关文章
|
10小时前
idea的yapi插件使用详解
idea的yapi插件使用详解
10 0
|
10小时前
|
uml
【经验分享】如何在IDEA中快速学习|审查|复习代码工程?
在IDEA中加速工程学习与审查,提升代码质量和维护性,关键操作包括:使用"Structure"浏览工程结构,通过"Find Usages"查找类、方法或变量引用,借助"Show Local Changes As UML"展示UML图。遵循从整体到局部的UML图学习,再到具体代码的详细探索,可系统理解设计理念。详情参考[IDEA UML教程](https://blog.csdn.net/weixin_44701426/article/details/124598053)。
18 1
【经验分享】如何在IDEA中快速学习|审查|复习代码工程?
|
10小时前
|
JSON Java Maven
IDEA开发过程中常用插件必备
本文介绍了提升IntelliJ IDEA开发效率的几个插件:Codota用于强大代码补全;Auto filling Java call arguments自动填充函数参数,节省手动填充时间;GsonFormat能快速将JSON转换为Java实体类;Rainbow Brackets帮助识别括号所属代码块;Maven Helper提供高效查看和分析Maven依赖树功能;Key Promoter X提醒使用快捷键代替鼠标操作;最后还分享了如何设置背景图片以提升编码心情。
|
10小时前
|
XML SQL Java
IntelliJ IDEA 插件 MybatisX 在mapper和xml间跳转
IntelliJ IDEA 插件 MybatisX 在mapper和xml间跳转
|
10小时前
|
人工智能 自然语言处理 Java
用智谱 GLM-4大模型开发自己的IDEA插件
V 哥建议研究大模型先从研究开放 API 开始,作为程序员的你觉对不是什么难事,通过研究 API 的过程中,可以让你更加了解大模型的原理,当然想要更深入的理解,需要对开源大模型的源码进行研究,根据个人的技术能力,量力而行。研究 API 是第一步,目前热招的岗位中,就有基于大模型开放 API 做应用开发的,大家可以在招聘站点上具体看看职位要求。
用智谱 GLM-4大模型开发自己的IDEA插件
|
10小时前
|
人工智能 自然语言处理 IDE
如何让阿里云AI001号员工帮我写代码(含IDEA插件使用)
AI 智能时代,将改变所有人的思维方式,学习方式,更注重人的创造力和思考力,如果你懒,你将会被 AI 替代,如果你只想干简单不用动脑的活,你将会被 AI 替代,如果你只会打螺丝,更会被 AI 替代。当下的 AI 人工智能时代,被认为是第四次工业革命的到来,我们更应该看到的是机会,而非跳进焦虑、困惑、悲观的一群人潮中。
|
10小时前
|
人工智能 Java 数据库连接
推荐51个 IDEA 常用的插件
在日常撸代码的时候,相信兄弟们在IDEA 中用到不少插件,利用插件,不仅可以提高工具效率,撸起代码来,也格外的娃哈哈……
|
前端开发 Java 开发工具
从零单排之 IDEA 插件开发,没你想的那么难!
从零单排之 IDEA 插件开发,没你想的那么难!
190 0
从零单排之 IDEA 插件开发,没你想的那么难!
|
XML 开发框架 Dubbo
8条经验轻松上手IDEA插件开发
本文从IDEA插件的基本概念讲起,通过一个简单的开发实例,介绍IDEA插件开发的过程,并总结了8条实战经验。更详细的IDEA插件开发介绍,可参见官方说明或到官方论坛讨论。
8条经验轻松上手IDEA插件开发
|
10小时前
|
安全 Java 数据库连接
在IntelliJ IDEA中通过Spring Boot集成达梦数据库:从入门到精通
在IntelliJ IDEA中通过Spring Boot集成达梦数据库:从入门到精通