如何写出高质量规范的代码,是我们日常开发过程中需要考虑的。最近看了相关的规范,这里总结记录下。主要分为两部分,一个是阿里巴巴Java开发手册,是我们日常开发的规范指南;另一个是idea 中一个插件,方便检测项目中的不规范的代码,引导我们日常的开发,且当作一个是理论指导,一个是时间监督。
一,阿里Java 代码规范
阿里巴巴Java开发手册终极版
手册涉及到编程规约(命名风格,常量定义,集合处理,并发处理等一些常见开发内容),异常处理,mysql 数据库建表规约,索引规约等,指导我们在日常开发中规范自己的代码。
具体一些规范,手册里面讲解很清晰,可以根据自己的弱项纠正。
二,阿里代码规范插件
idea中安装阿里的代码规范插件,可以在日常开发中约束自己的代码。
1.安装步骤
https://blog.csdn.net/weixin_39220472/article/details/80077803
参考了一个博客,讲解的很详细,但是第一步,一些博客中都是File——>settting,来找plugin,但是我的mac本,安装的2018版本的在File中找不到呢,哎。
mac版的idea,正确步骤是:IntelliJ IDEA ——>Preferences——>Plugins,然后Browse Repositories,在Browse Repositories搜索栏搜索Alibaba,然后安装, Restart IntelliJ IDEA重启就可以了。
在idea的菜单栏就显示出来了
2.使用
安装好了,使用方法是:打开IDEA,点击tools--->安装的阿里编码规约,可以选择中英文切换,项目右键选择编码规约扫描就可以进行查看自己编码哪些地方不够好,进行修改。
如果想检测某个模块,某个包下的,或者某个类,选择一个模块(包,类),然后鼠标右键,然后选择编码规约扫描,扫描后,不规范的代码就会进行如下显示
关于这些阿里文章有介绍:
https://mp.weixin.qq.com/s/IbibsXlWHlM59kfXJqRvZA#rd
扫描出来的有三个等级,Blocker/Critical/Major
在Snoar 中对代码规则有五个级别,这是前三个,崩溃/严重/重要 ,也就是说前两级别是必须要处理掉的。
三,总结
我看了一边手册,安装了插件在项目中做了检测,发现还是挺多不规范的,对照着规范,修改了一些。好好加油吧,让自己写出高质量规范的代码。
四,实践记录,不断丰富
(1)@Override 注解以前好多都没写,现在注意见到了,就会补上去
(2)创建实体属性时候,建议一般用包装类型
原文档中说:1)所有的pojo类属性必须使用包装数据类型。2)RPC方法的返回值和参数必须使用包装数据类型。3)所有的局部变量使用基本数据类型
(3)试题中表识状态的布尔值,不用is标
(4)注释的规范,不在行尾,日志逐渐的规范。
(5) 常量名全部大些,单词间必须用下划线隔开,力求名称的表达完整。
(6)抽象的类命名使用Abstract 或者Base 。
(7) 数组的定义 String[ ] args。
(8) 所有的相同的包装类对象之间值的比较,全部使用equals 方法比较。
(9) SimpleDateFormat 是线程不安全的类,一般不要定义为static,如果定义为static,必须加锁。
Java 8的应用,Instant 代替date ,LocalDateTime 代替Calendar,DateTimeformatter 代替simDateFormat。
----------------------------2020年9月4日--------------