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

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

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


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



一、Alibaba Java Coding Guidelines

1、整体介绍:


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



阿里巴巴规约扫描包括:

  • OOP规约
  • 并发处理
  • 控制语句
  • 命名规约
  • 常量定义
  • 注释规范

2、安装步骤:

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


3、使用说明:

3.1、运行方式:


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


image.png


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


image.png


3.2、菜单功能:


编码规约扫描:开始扫描代码

打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能

切换语言至英文:中英文切换

3.3、运行结果:


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


image.png


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


image.png


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


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


image.png


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


image.png


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


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


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


image.png




3.4、工具栏功能介绍:

image.png


Rerun Inspection:重新运行一次扫描

Close:关闭真个AJCG面板

Expand All:展开结果的树状结构,整个结果是树状结构的。

Collapse All:收起结果的树状结构

Go Pre Problem:选择上一个问题

Go Next Problem:选择下一个问题

Help:帮助

Group by Serverity:(不知道如何描述)

Group by derectory:按目录分组/按类名分组间切换

Filter resoled items:过滤掉已经解决的项

Autoscroll to Source:自动滚动到源码

Export:导出,可以导出为XML和HTML两种格式

Edit Settings:编辑设置



二、CheckStyle:

1、整体介绍:

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


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


2、安装步骤:

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


3、使用说明:

image.png


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



相关文章
|
1月前
|
Java
轻松上手Java字节码编辑:IDEA插件VisualClassBytes全方位解析
本插件VisualClassBytes可修改class字节码,包括class信息、字段信息、内部类,常量池和方法等。
101 6
|
3天前
|
前端开发 Java 开发者
这款免费 IDEA 插件让你开发 Spring 程序更简单
Feign-Helper 是一款支持 Spring 框架的 IDEA 免费插件,提供 URL 快速搜索、Spring Web Controller 路径一键复制及 Feign 与 Controller 接口互相导航等功能,极大提升了开发效率。
|
2月前
|
存储 缓存 Java
java基础:IO流 理论与代码示例(详解、idea设置统一utf-8编码问题)
这篇文章详细介绍了Java中的IO流,包括字符与字节的概念、编码格式、File类的使用、IO流的分类和原理,以及通过代码示例展示了各种流的应用,如节点流、处理流、缓存流、转换流、对象流和随机访问文件流。同时,还探讨了IDEA中设置项目编码格式的方法,以及如何处理序列化和反序列化问题。
90 1
java基础:IO流 理论与代码示例(详解、idea设置统一utf-8编码问题)
|
2月前
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
39 6
|
2月前
|
Java 应用服务中间件 Maven
【终极解决方案】IDEA maven 项目修改代码不生效。
【终极解决方案】IDEA maven 项目修改代码不生效。
454 1
|
2月前
|
Java Linux 开发工具
IDEA中git提交前如何关闭code analysis以及开启格式化代码
【10月更文挑战第12天】本文介绍了在 IntelliJ IDEA 中关闭代码分析和开启代码格式化的步骤。关闭代码分析可通过取消默认启用检查或针对特定规则进行调整实现,同时可通过设置 VCS 静默模式在提交时跳过检查。开启代码格式化则需在 `Settings` 中配置 `Code Style` 规则,并通过创建 Git 钩子实现提交前自动格式化。
643 3
|
2月前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
67 0
|
2月前
|
IDE Java Maven
分享几个实用的IDEA插件,提高你的工作效率!
分享几个实用的IDEA插件,提高你的工作效率!
155 0
IDEA之自定义快捷编程代码(代码模板)
IDEA之自定义快捷编程代码(代码模板)
184 0
IDEA之自定义快捷编程代码(代码模板)