IntelliJ IDEA插件FindBugs-IDEA和QAPlug和Alibaba Java Coding Guidelines的使用

本文主要是介绍IntelliJ IDEA插件FindBugs-IDEA和QAPlug和Alibaba Java Coding Guidelines的使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

FindBugs-IDEA和QAPlug和Alibaba Java Coding Guidelines插件,都是用来帮助开发者规范代码,培养优良的编码习惯。

1、FindBugs-IDEA

FindBugs 是一个静态分析工具,它检查类或者 JAR 文件,将字节码与一组缺陷模式进行对比以发现可能的问题。有了静态分析工具,就可以在不实际运行程序的情况对软件进行分析。

1.1、插件安装方式

①、IDEA无法搜索到FindBugs-IDEA,通过离线方式下载
下载地址: FindBugs-IDEA代码规范插件下载.
在这里插入图片描述
②、导入下载的FindBugs-IDEA-1.0.1.zip包
在这里插入图片描述
③、重启IDEA
在这里插入图片描述

1.2、插件使用

①、运行插件
Analyze Selected File(s)————单个文件
Analyze Package(s) Files)————包下文件
Analyze Module Files)————整个module
Analyze Project Files)————整个工程
在这里插入图片描述

②、左下方红框代表安装完成,左侧中间红框代表运行,右测上方显示项目代码分析详情。
在这里插入图片描述
③、项目代码分析详情

分析详情分析详情
Bad pratice编程的坏习惯,主要是命名问题,比如类名最好以大写开头,字符串不要使用等号不等号进行比较,可能会有异常最好用try-catch包裹的代码,方法有返回值但被忽略等等,这些如果不想改可以直接忽略。
Malicious code vulnerability恶意代码漏洞,主要是一些属性直接使用public让别的类来获取,建议改为private并为其提供get/set方法。还有一些public的静态字段,可能会被别的包获取之类的。这些也需要根据项目具体情况来,个人意见,在有的不重要类,有时直接公开使用属性,可能更为便捷。如果你认为这些不需要修改,完全可以忽略。
Dodgy code糟糕的代码,比如一个double/float被强制转换成int/long可能会导致精度损失,一些接近零的浮点数会被直接截断,事实上我们应该保留。在类型转换的时候,我们应该为类型转换提供一个安全的转换方法。比如使用switch的时候没有提供default。多余的空检查,就是不可能为空的值,增加了不为空判断,这是没有必要的。属于代码冗余不安全的类型转换等等。
performance性能,主要是一些无用的代码,比如声明了没有用到的属性等等。
correctness代码的正确性,主要是没有对变量进行不为空判定,在特殊情况可能发生空指针异常。

2.4、检测之后的提示实例

①、除非两个字符串都是源文件中的常量,或者已经使用String.intern()方法进行了插入,否则相同的字符串值可能由两个不同的字符串对象表示。请考虑使用等量(object)方法。
在这里插入图片描述

2、QAPlug

在IDEA中搜索会发现有四种QAPlug,包含了PMD、FindBugs、CheckStyle和QAPlug。QAPlug 是一个 Intellij IDEA 插件,用于管理代码质量,它集成了 PMD、Checkstyle 和 Findbugs 等工具。

PMD
与findbug类似找bug用,还有规范,比如说注释不全
FindBugs
只寻找可能存在bug的地方,不注重样式或者格式,它试图只寻找真正的缺陷或者潜在的性能问题
CheckStyle
代码样式风格检查,专门check代码规范风格的,比如缩进,换行操作,命名大项目往往是有很多人一起完成的,然而每个人都有自己的style,导致整个项目的代码不仅存在不符合语言规范的情况,而且读起来非常困难。因此,这样的项目中都会引入Checkstyle,来规范大家的编码风格,尽量做到统一和合理。所以使用checkStyle检查到问题
QAPlug
这个插件集成了 PMD、Checkstyle 和 Findbugs 工具,1键运行3个同时汇总整合,非常方便,所以其他的不用装了,就用这个就行了!与sonar平台的功能类似!如果公司没有搭建sonarqube平台的话,本地使用这个最佳!

2.1、插件安装方式

①、在线方式,如图操作,直接去idea插件里面搜索即可
注意:只安装QAPlug,会提示错误消息,请至少安装一个QAPlug子模块,这边安装FindBugs子模块进行使用。
在这里插入图片描述

2.2、插件使用

①、选择项目,点击Analyze,在点击Analyze Code
在这里插入图片描述
②、勾选如下两个红框
在这里插入图片描述
③、代码分析结果
Efficiency————效能
Maintainability————可维护性
Reliability————可靠性
Usability————可用性
在这里插入图片描述

2.3、检测之后的提示实例

①、左侧显示结果以及对应类的所在位置,右侧显示纤细的问题描述
在这里插入图片描述

3、Alibaba Java Coding Guidelines

来自阿里的阿里巴巴开发公约。他会根据你的代码情况给出Blocker(极严重)、Critical(严重)、Major (警告)等,等级的提示,让程序员快速定位问题代码进行修改。

3.1、插件安装方式

①、在线方式,如图操作,直接去idea插件里面搜索即可在这里插入图片描述
②、离线方式,因为有时候会安装失败,去官网下载对应插件离线包;
下载地址: alibaba代码规范插件下载.
在这里插入图片描述

3.2、插件使用

①、手动扫描(即绿色图标编码规范约束)
可进行单个类、或者整体项目的的扫描。
②、自动扫描(即蓝色图标实时检测功能)
可开启实时检测功能
![在这里插入图片描述](https://img-blog.csdnimg.cn/c949bde79dd24c338f5d184aa16cd407.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAemp6LW91bmk=,size_19,color_FFFFFF,t_70,g_se,x_16

3.3、提示文档

①、查阅所有提示
在Settings中打开Editor选中Inspections搜索Ali-Check,会显示出所有的提示,包含了Blocker(极严重)、Critical(严重)、Major (警告)等。
在这里插入图片描述
②、可对提示取消勾选
有的提示并不是很必要的,不看这些提示,是可以自定义的。如下图,我已标注,写了 create by 等,但是插件还是提示缺少作者。
在这里插入图片描述
取消勾选后就不会有提示
在这里插入图片描述
③、可对提示等级进行修改
调整对应注释的等级,根据自身的需求。
在这里插入图片描述
④、可对范围进行调控
调整规范的检索范围,默认In All Scope全局。
在这里插入图片描述

3.4、检测之后的提示实例

①、例如Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。
在这里插入图片描述
②、不允许任何魔法值(即未经定义的常量)直接出现在代码中。
在这里插入图片描述
③、集合初始化时,指定集合初始值大小。
在这里插入图片描述

这篇关于IntelliJ IDEA插件FindBugs-IDEA和QAPlug和Alibaba Java Coding Guidelines的使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/838703

相关文章

Spring @Scheduled注解及工作原理

《Spring@Scheduled注解及工作原理》Spring的@Scheduled注解用于标记定时任务,无需额外库,需配置@EnableScheduling,设置fixedRate、fixedDe... 目录1.@Scheduled注解定义2.配置 @Scheduled2.1 开启定时任务支持2.2 创建

SpringBoot中使用Flux实现流式返回的方法小结

《SpringBoot中使用Flux实现流式返回的方法小结》文章介绍流式返回(StreamingResponse)在SpringBoot中通过Flux实现,优势包括提升用户体验、降低内存消耗、支持长连... 目录背景流式返回的核心概念与优势1. 提升用户体验2. 降低内存消耗3. 支持长连接与实时通信在Sp

Spring Boot 实现 IP 限流的原理、实践与利弊解析

《SpringBoot实现IP限流的原理、实践与利弊解析》在SpringBoot中实现IP限流是一种简单而有效的方式来保障系统的稳定性和可用性,本文给大家介绍SpringBoot实现IP限... 目录一、引言二、IP 限流原理2.1 令牌桶算法2.2 漏桶算法三、使用场景3.1 防止恶意攻击3.2 控制资源

Mac系统下卸载JAVA和JDK的步骤

《Mac系统下卸载JAVA和JDK的步骤》JDK是Java语言的软件开发工具包,它提供了开发和运行Java应用程序所需的工具、库和资源,:本文主要介绍Mac系统下卸载JAVA和JDK的相关资料,需... 目录1. 卸载系统自带的 Java 版本检查当前 Java 版本通过命令卸载系统 Java2. 卸载自定

springboot下载接口限速功能实现

《springboot下载接口限速功能实现》通过Redis统计并发数动态调整每个用户带宽,核心逻辑为每秒读取并发送限定数据量,防止单用户占用过多资源,确保整体下载均衡且高效,本文给大家介绍spring... 目录 一、整体目标 二、涉及的主要类/方法✅ 三、核心流程图解(简化) 四、关键代码详解1️⃣ 设置

Java Spring ApplicationEvent 代码示例解析

《JavaSpringApplicationEvent代码示例解析》本文解析了Spring事件机制,涵盖核心概念(发布-订阅/观察者模式)、代码实现(事件定义、发布、监听)及高级应用(异步处理、... 目录一、Spring 事件机制核心概念1. 事件驱动架构模型2. 核心组件二、代码示例解析1. 事件定义

SpringMVC高效获取JavaBean对象指南

《SpringMVC高效获取JavaBean对象指南》SpringMVC通过数据绑定自动将请求参数映射到JavaBean,支持表单、URL及JSON数据,需用@ModelAttribute、@Requ... 目录Spring MVC 获取 JavaBean 对象指南核心机制:数据绑定实现步骤1. 定义 Ja

python使用库爬取m3u8文件的示例

《python使用库爬取m3u8文件的示例》本文主要介绍了python使用库爬取m3u8文件的示例,可以使用requests、m3u8、ffmpeg等库,实现获取、解析、下载视频片段并合并等步骤,具有... 目录一、准备工作二、获取m3u8文件内容三、解析m3u8文件四、下载视频片段五、合并视频片段六、错误

javax.net.ssl.SSLHandshakeException:异常原因及解决方案

《javax.net.ssl.SSLHandshakeException:异常原因及解决方案》javax.net.ssl.SSLHandshakeException是一个SSL握手异常,通常在建立SS... 目录报错原因在程序中绕过服务器的安全验证注意点最后多说一句报错原因一般出现这种问题是因为目标服务器

gitlab安装及邮箱配置和常用使用方式

《gitlab安装及邮箱配置和常用使用方式》:本文主要介绍gitlab安装及邮箱配置和常用使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装GitLab2.配置GitLab邮件服务3.GitLab的账号注册邮箱验证及其分组4.gitlab分支和标签的