侧边栏壁纸
博主头像
孔子说JAVA博主等级

成功只是一只沦落在鸡窝里的鹰,成功永远属于自信且有毅力的人!

  • 累计撰写 352 篇文章
  • 累计创建 135 个标签
  • 累计收到 10 条评论

目 录CONTENT

文章目录

IDEA Java代码规范插件 Alibaba Java Coding Guidelines 的安装配置与使用

孔子说JAVA
2022-11-06 / 0 评论 / 0 点赞 / 45 阅读 / 2,593 字 / 正在检测是否收录...
广告 广告

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

1、安装方式

IDEA版的插件已发布至IDEA官方仓库中(最低支持版本14.1.7,JDK1.7+)。你只需打开 Settings >> Plugins >> Browse repositories 输入 Alibaba 搜索,看到对应插件后即可安装。

1.1 在线安装方式

第一种方式,是在IDEA上搜索插件进行安装,会适配当前IDEA的版本。打开File -> Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Marketplace 页签下,搜索 “alibaba”,可以找到相关的插件,如下图所示,选择 Alibaba Java Coding Guidelines,点击 Install 进行安装即可。

image-1667354403917

1.2 离线安装方式

第二种安装方式是使用离线插件进行安装。插件下载页面:https://plugins.jetbrains.com/idea ,在搜索框中输入插件名称 “alibaba” 搜索,点击出现的下拉提示中的 Alibaba Java Coding Guidelines,即可进入插件下载页面,选择对应安装版本下载即可。也可以通过下方链接直接进入下载页面。

image-1667354460269

下载完成后,进入插件市场,选择本地安装

同样是在 Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Installed 页签右方有个齿轮图标,点击展开菜单后选择 “Install Plugin from Disk…”,此时会打开本地文件选择框,选择你下载的插件包安装即可。

安装完成后重启IDEA。在菜单 Tools 下可以看到多了个阿里编码规约的功能,表示插件安装成功。

image-1667354792415

在idea中的项目/包/文件上鼠标右键也可以看到多了两个功能菜单,【编码规约扫描】、【关闭实时检测功能】。

image-1667354891675

2、插件使用

阿里巴巴规约扫描包括:(1)OOP规约 (2)并发处理 (3)控制语句 (4)命名规约 (5)常量定义 (6)注释规范

2.1 全局扫描

点击菜单 Tools -> 阿里编码规约 -> 编码规约扫描 可以对当前idea中的项目进行全局扫描,另外也可以在idea的项目上右键,在弹出的菜单中选择 编码规约扫描。可以在Inspection Result这个视图中看到整个项目的检测结果:

image-1667355348470

2.2 部分扫描

在idea中的项目上鼠标右键,点击绿色的【编码规约扫描】,即可开始扫描全局代码。如果不想全部扫描,只扫描某一文件夹下的所有文件或者单一文件的话,选中该目录或者单一文件右键也会出现此功能按钮,效果就是扫描出该文件所包含的bug或者不规范。扫描结果如下:

image-1667355458564

2.3 检测之后的提示实例

① 例如Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。

image-1667356454594

② 不允许任何魔法值(即未经定义的常量)直接出现在代码中。

image-1667356479576

③ 集合初始化时,指定集合初始值大小。

image-1667356501359

2.4 结果分析及修改

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

image-1667434185824

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

image-1667434207104

上图可以看到,对扫描结果中部分不规范的代码,单击右键支持一键修复。

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

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

image-1667434297996

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

image-1667434308821

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

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

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

image-1667434344968

2.5 工具栏功能介绍

image-1667434366992

  • (1)Rerun Inspection: 重新运行一次扫描
  • (2)Close:关闭真个AJCG面板
  • (3)Expand All:展开结果的树状结构,整个结果是树状结构的。
  • (4)Collapse All:收起结果的树状结构
  • (5)Go Pre Problem:选择上一个问题
  • (6)Go Next Problem:选择下一个问题
  • (7)Help:帮助
  • (8)Group by Serverity:(不知道如何描述)
  • (9)Group by derectory:按目录分组/按类名分组间切换
  • (10)Filter resoled items:过滤掉已经解决的项
  • (11)Autoscroll to Source:自动滚动到源码
  • (12)Export:导出,可以导出为XML和HTML两种格式
  • (13)Edit Settings:编辑设置

3、检查规范的配置

3.1 查阅所有检查规范

在菜单 Settings-> Editor 下选中 Inspections 搜索 Ali-Check 后选中,会显示出所有的检查规范,包含了Blocker(极严重)、Critical(严重)、Major (警告)等。

image-1667355875288

3.2 配置检查规范

可对规范取消勾选,即可取消对该类规范的检查。有的检查规范并不是很必要的,不看这些检查规范对应的结果提示,是可以自定义的。如下图插件提示缺少作者。

image-1667355998483

取消“所有的类都必须添加创建者信息”勾选后就不会有上面的提示了。

image-1667356182043

3.3 配置检查等级

可以根据自身的需求调整对应注释的等级(检查规范)。

image-1667356299917

3.4 配置检索范围

可以根据自身的需求调整规范的检索范围,默认In All Scope全局。

image-1667356361197

代码规范检测,有助于我们进行代码排错、提高编码效率、以及提升项目整体的运行速度。

0

评论区