阿里规范扫描插件使用推广
一、良好的Coding习惯,从P3C开始–阿里P3C代码规范扫描插件
1、说明
代码规范检查插件p3c,是根据《阿里巴巴Java开发手册》转化而成的自动化插件。
(高级黑:P-3C“Orion”,反潜巡逻机,阿里大概取p3c先进,监测,发现潜在问题的意思)
二、源码地址
https://github.com/alibaba/p3c
三、阿里巴巴开发规范手册
- 1、说明
《阿里巴巴Java开发手册》旨在码出高效,码出质量。 - 2、目的
标准化,正规化,高效协同。 - 3、下载地址
四、阿里代码规范插件配置
intellij idea 篇
1、安装插件最新版——安装步骤
安装成功后会出现扫描选项
使用(推荐开启实时扫描功能)
它能帮助我们做什么?
1、会帮我们检测命名规范
在我们的日常开发中,经常会碰到简写或者随意命名的变量、方法、类名,这样是不对的,除非是工人的简写单词,否则尽量写全称,不要高估别人的智商,有时候你全程命名的变量有可能别人都看不懂,所以能全称尽量写全称。尽量做到见名知意。
2、帮我们检测空指针
空指针是我们在开发中碰到最多,也是最难避免的问题,因为稍微不小心就会出现。但是有了阿里插件,妈妈再也不用担心我写的代码出现空指针了。哈哈说笑了,阿里插件虽然不能保证100%不会出现空指针,但是可以保证你写的代码里面有空指针异常逻辑,会立马告诉你,如上,非常明显的黄色提示,当你把鼠标放到该区域,就会提示空指针异常警告。
3、帮我们检测重复代码
当我们写的业务需求越来越多,业务又臭又长的时候,你会发现,你的代码这里好像写过了,哪里好像又重复了。这个就是代码重复问题。这个是每一个程序猿随着代码量的增加,业务的增加就会出现的问题。所以为了降低代码冗余,我们需要处理重复代码。
4、帮助我们规范注释
非java Bean的public方法都需要注释,您总不会要别人读您的源码才能调用您的代码吧?即使您的英文非常好,命名十分规范,您总不能期待别人都英文好,需要一视同仁,多站在别人的角度想想吧。
5、给我们一个干净的编码环境,让我们的眼睛更舒适
经过阿里插件的扫描修改后的代码、项目,我们的代码会变得更加的干净,赏心悦目。
扫描出来的对应问题等级
问题级别 | 处理要求 |
---|---|
BLOCKER | 程序崩溃级别(一定要修复) |
CRITICAL | 严重级别(需要修复) |
MAJOR | 重要级别(建议修复) |
五、使用这个给我们带来的好处
- 统一代码规范,使我们的编码可读性更高
- 优化代码,使我们的代码更加的优美
- 减少代码错误,实时监测代码逻辑,如空指针等问题
- 减少项目崩溃问题,增强项目代码健壮性
- 帮助我们增强规范代码意识,编写优秀的代码