java开发工具(5)你的代码规范么?快用阿里规约插件扫描下吧

在写代码的过程中,我们为了业务需要快速迭代,快速开发,但是一个不规范的代码会让代码的易读性,可复用性,可维护性都大打折扣。一个公司如果想长久发展,而不是写了一次业务便不再变更,规范代码是非常重要的。
阿里前几年出了一份编码规约,里面涵盖了从数据库,代码编写,模块划分等多个方面的规范。

一、编码规约示例

下面就几条规约示例展示如下:

【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。
【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。
说明:对子类的实现要求,或者调用注意事项,请一并说明。
【强制】日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。
【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
说明:新增代码及时补充单元测试,如果新增代码影响了原有单元测试,请及时修正。

强制表示必须要依照此规则去执行,推荐是建议你按照此规则执行。

这套编码规约非常实用,一个有经验的程序员也要对自己的编码有一个规范,《阿里编码规约》的内容还是非常多的,一次性记忆也不现实,就算你背下来,真正使用的时候也未必能遵守用上,楼主有一条经验是,在有问题的时候经常翻阅,这样也能加深记忆,毕竟伟大的领袖曾说过“实战是检验真理的唯一标准”。

即使你常常翻阅,也难免遇到有时候写的代码违反了规约,这个时候如果有一个插件能时刻监测你的代码提醒是是否规范,那就无后顾之忧了。而阿里也开发了一个代码规约的插件

二、阿里代码规约插件

安装方式:在idea的插件库中搜索安装即可,截图如下:
Idea插件库
安装完成后就会在你的Idea上方,出现这两个标志阿里规约插件标志功能如下:

  • 绿色的按钮:你可以通过此功能进行项目的代码扫描,扫描哪些代码不符合编码规范,但说实话,我一般都是实时监测,主动扫描基本不用。
  • 蓝色的圆圈:这个是实时扫描的按钮,下面我举例说明如何检测代码:
    代码不符合规约
    标记1处,我的代码不符合驼峰命名的规范,此时界面上会有两个地方展示异常
  1. 类名下面会有一个波浪线,把鼠标悬停在波浪线处会告诉你代码不符合驼峰命名规范。
  2. 界面最右面的标记2处,会出现一个细细的黄线,这个黄线出现说明你的代码规范有一些问题,此时鼠标悬停在黄线处,也会展示代码不符合驼峰命名规范。

这样,有了代码的实时监测功能,你代码中的不规范的地方,就可以及时解决。如果你的代码完全符合规范,在代码界面的右上角就会有一个“✔️”出现,如下:
完美的代码

三、敏捷开发,业务快速迭代,代码规范是不是不重要?

  • 首先当然要说明,我们做任何的开发任务,业务永远是第一位的,其他的任何编码技巧,代码规范都次之。
  • 其次,业务开发,快速迭代,时间来不及无法估计代码规范,这短期内看是提升了效率,但是有一个问题,你开发的代码,此后就一成不变了么?我至今尚未见过,代码开发完后就放在那里,不需要后续的迭代或者维护的代码。就算是自己维护自己写的代码,过了几个月你也忘得差不多了。没有统一的编码规范,代码写的凌乱不堪,后期的维护怎么做?当然你大可以大袖一甩,反正挖的坑是给后面的人的,但是在更上的层面,这是公司的时间与效率的损失。
  • 最后,规范代码,codereview,应该是公司层面的事情,因为不规范的代码影响的并不是当前的编码人员,而是后续补坑的人,应该在整个公司内部开展codeReview的工作,否则编码规范则无法推行,造成的损失也是公司的。

总结

写这一篇文章的目的是因为,许多的程序员并不注重编码规范,仅仅是将编码规范当做是可有可无的东西,原因很简单,利不关己,但是却事关整个公司。
所以编码规范的推行只能是从公司层面,技术总监支持,由上到下,降维打击,才可施行。
关于规约插件的安装与使用,非常简单,重要的是要理解为什么要这么做。

重点:
我的java开发工具专栏上线了,我会每周持续更新,告诉你java开发工具中,你可能不知道的细节,有兴趣的朋友可以关注我的专栏《java开发工具》,关注方式:点击博文左侧的分类专栏,点击java开发工具,进入页面点击关注即可,当我有文章更新,会第一时间通知你。
Alt

发布了188 篇原创文章 · 获赞 117 · 访问量 38万+

猜你喜欢

转载自blog.csdn.net/lz710117239/article/details/104447399