前言
目前正在出一个阿里巴巴Java开发手册
系列教程, 篇幅会较多, 喜欢的话,给个关注❤️ ~
在日常开发中,好的编码习惯和代码规范有助于提高代码可读性
,提升团队协作效率
,还利于维护与扩展
,在某些情况下还有利于优化性能
。今天就带着大家一起学习下手册中的内容,学习下Java
开发中的编码规范。
好了, 废话不多说直接开整吧~
OOP编码规范
OOP
就是大家常说的面向对象(Object Oriented Programming)
,下面就一起看下手册中给我们提供了哪些好的建议~
-
【强制】
避免通过一个类的对象引用
访问此类的静态
变量或静态
方法,无谓增加编译器解析成本,直接用类名
来访问即可。 -
【强制】
所有的覆写方法,必须加@Override
注解。
说明:getObject()
与 get0bject()
的问题。一个是字母的 O
,一个是数字的 0
,加@Override
可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。
【强制】
相同参数类型,相同业务含义,才可以使用Java
的可变参数,避免使用Object
。 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)
正例:
java
public List<User> listUsers(String type, Long... ids) {...}
-
【强制】
外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。接口过时
必须加@Deprecated
注解,并清晰地说明采用的新接口或者新服务是什么。 -
【强制】
不能使用过时的类或方法。 说明:
java
java.net.URLDecoder 中的方法 decode(String encodeStr)
这个方法已经过时,应该使用双参数decode(String source, String encode)。
接口提供方既然明确是过时接口,那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么。
【强制】
Object 的equals
方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals
。
正例:
java
"test".equals(object);
反例:
java
object.equals("test");
说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)
【强制
】所有整型包装类对象之间值的比较,全部使用equals
方法比较。
说明:对于 Integer var = ?
在-128 至 127 之间的赋值,Integer
对象是在 IntegerCache.cache
产生,会复用已有对象,这个区间内的 Integer
值可以直接使用==进行判断,但是这个区间之外的所有数据,都 会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用 equals
方法进行判断。
-
【强制】
任何货币金额,均以最小货币单位且整型类型来进行存储。 -
【强制】
浮点数之间的等值判断,基本数据类型不能用==
来比较,包装数据类型不能用equals
来判断。
说明:浮点数采用"尾数+阶码"的编码方式,类似于科学计数法的"有效数字+指数"的表示方式。二进制无法精确表示大部分的十进制小数
反例:
java
float a = 1.0f - 0.9f;
float b = 0.9f - 0.8f;
if (a == b) {
// 预期进入此代码快,执行其它业务逻辑
// 但事实上 a==b 的结果为 false
}
Float x = Float.valueOf(a);
Float y = Float.valueOf(b);
if (x.equals(y)) {
// 预期进入此代码快,执行其它业务逻辑
// 但事实上 equals 的结果为 false
}
正例: (1) 指定一个误差范围,两个浮点数的差值在此范围之内,则认为是相等的。
java
float a = 1.0f - 0.9f;
float b = 0.9f - 0.8f;
float diff = 1e-6f;
if (Math.abs(a - b) < diff) {
System.out.println("true");
}
(2) 使用 BigDecimal
来定义值,再进行浮点数的运算操作。
java
BigDecimal a = new BigDecimal("1.0");
BigDecimal b = new BigDecimal("0.9");
BigDecimal c = new BigDecimal("0.8");
BigDecimal x = a.subtract(b);
BigDecimal y = b.subtract(c);
if (x.equals(y)) {
System.out.println("true");
}
10.【强制】
定义数据对象DO
类时,属性类型要与数据库字段类型相匹配。
正例:数据库字段的 bigint
必须与类属性的Long
类型相对应。 反例:某个案例的数据库表 id
字段定义类型 bigint unsigned
,实际类对象属性为 Integer
,随着 id
越来越大,超过 Integer
的表示范围而溢出成为负数。
11.【强制】
禁止使用构造方法 BigDecimal(double)
的方式把 double
值转化为 BigDecimal
对象。 说明:BigDecimal(double)
存在精度损失风险,在精确计算或值比较的场景中可能会导致业务逻辑异常。
如:BigDecimal g = new BigDecimal(0.1f);
实际的存储值为:0.10000000149
正例:优先推荐入参为 String
的构造方法,或使用 BigDecimal
的 valueOf
方法,此方法内部其实执行了Double
的 toString
,而 Double
的 toString
按 double
的实际能表达的精度对尾数进行了截断。
java
BigDecimal recommend1 = new BigDecimal("0.1");
BigDecimal recommend2 = BigDecimal.valueOf(0.1);
12.关于基本数据类型与包装数据类型的使用标准如下: 1) 【强制
】所有的 POJO
类属性必须使用包装数据类型。 2) 【强制】RPC
方法的返回值和参数必须使用包装数据类型。 3) 【推荐】
所有的局部变量
使用基本
数据类型。
说明:POJO
类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE 问题,或者入库检查,都由使用者来保证。
正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:某业务的交易报表上显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC 服务,调 用不成功时,返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线-。所以包装数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出
13.【强制】
定义 DO/DTO/VO
等 POJO
类时,不要设定任何属性默认值。 反例:POJO
类的 createTime
默认值为 new Date()
,但是这个属性在数据提取时并没有置入具体值,在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。
14.【强制】
序列化类新增属性时,请不要修改 serialVersionUID
字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID
值。 说明:注意 serialVersionUID
不一致会抛出序列化运行时异常。
15.【强制】
构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init
方法中。
16.【强制】POJO
类必须写 toString
方法。使用 IDE 中的工具:source> generate toString
时,如果继承了另一个 POJO
类,注意在前面加一下 super.toString
。
说明:在方法执行抛出异常时,可以直接调用 POJO
的 toString()
方法打印其属性值,便于排查问题。
17.【强制】
禁止在 POJO
类中,同时存在对应属性 xxx
的 isXxx()
和 getXxx()
方法。
说明:框架在调用属性 xxx
的提取方法时,并不能确定哪个方法一定是被优先调用到,神坑之一。
18.【推荐】
使用索引访问用 String
的 split
方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException
的风险。
说明:
java
String str = "a,b,c,,";
String[] ary = str.split(",");
// 预期大于 3,结果是 3
System.out.println(ary.length);
19.【推荐】
当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便于阅读,此条规则优先于下一条。
20.【推荐】
类内方法定义的顺序依次是:公有方法或保护方法 > 私有方法 > getter / setter
方法。
说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类关心,也可能是"模板设计模式"下的核心方法;而私有方法外部一般不需要特别关心,是一个黑盒实现;因为承载的信息价值较低,所有Service
和 DAO
的 getter/setter
方法放在类体最后。
21.【推荐】setter
方法中,参数名称与类成员变量名称一致,this.成员名 = 参数名
。在getter/setter
方法中,不要增加业务逻辑,增加排查问题的难度。 反例:
java
public Integer getData () {
if (condition) {
return this.data + 100;
} else {
return this.data - 100;
}
}
22.【推荐】
循环体内,字符串的连接方式,使用 StringBuilder
的 append
方法进行扩展。 说明:下例中,反编译出的字节码文件显示每次循环都会 new
出一个 StringBuilder
对象,然后进行 append
操作,最后通过 toString
方法返回 String
对象,造成内存资源浪费。 反例:
java
String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}
23.【推荐】final
可以声明类、成员变量、方法、以及本地变量,下列情况使用 final
关键字: 1) 不允许被继承的类,如:String
类。 2) 不允许修改引用的域对象,如:POJO
类的域变量。 3) 不允许被覆写的方法,如:POJO
类的 setter
方法。 4) 不允许运行过程中重新赋值的局部变量。 5) 避免上下文重复使用一个变量,使用 final
可以强制重新定义一个变量,方便更好地进行重构。
24.【推荐】
慎用 Object
的 clone
方法来拷贝对象。 说明:对象 clone
方法默认是浅拷贝,若想实现深拷贝需覆写clone
方法实现域对象的深度遍历式拷贝。
25.【推荐】
类成员与方法访问控制从严: 1) 如果不允许外部直接通过new
来创建对象,那么构造方法必须是 private
。 2) 工具类不允许有 public
或 default
构造方法。 3) 类非 static
成员变量并且与子类共享,必须是 protected
。 4) 类非 static
成员变量并且仅在本类使用,必须是 private
。 5) 类 static
成员变量如果仅在本类使用,必须是 private
。 6) 若是 static
成员变量,考虑是否为 final
。 7) 类成员方法只供类内部调用,必须是 private
。 8) 类成员方法只对继承类公开,那么限制为 protected
。 说明:任何类、方法、参数、变量,严控访问范围。过于宽泛的访问范围,不利于模块解耦。思考:如果是一个 private
的方法,想删除就删除,可是一个public
的service
成员方法或成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。
结束语
下节给大家讲日期和时间
规范~
本着把自己知道的都告诉大家,如果本文对有所帮助,点赞+关注
鼓励一下呗~
阿里巴巴Java开发手册相关文章
MybatisPlus教程相关文章
往期Nginx教程相关文章
往期Docker教程相关文章
往前Shell脚本编程相关文章
- 一起来学Shell脚本编程(一)
- 一起来学Shell脚本编程(二)
- 一起来学Shell脚本编程(三)
- 一起来学Shell脚本编程(四)
- 一起来学Shell脚本编程(五)
- 一起来学Shell脚本编程(六)
- 一起来学Shell脚本编程(七)
往期Linux相关文章
- 一起来学Linux命令(一)
- 一起来学Linux命令(二)
- 一起来学Linux命令(三)
- 一起来学Linux命令(四)
- 一起来学Linux命令(五)
- 一起来学Linux命令(六)
- 一起来学Linux命令(七)
- 一起来学Linux命令(八)
- 一起来学Linux命令(九)
- 一起来学Linux命令(十)
往期面试题相关文章
- 查漏补缺第一期(Redis相关)
- 查漏补缺第二期(synchronized & 锁升级)
- 查漏补缺第三期(分布式事务相关)
- 查漏补缺第四期(Mysql相关)
- 查漏补缺第五期(HashMap & ConcurrentHashMap)
- 查漏补缺第六期(京东一面)
- 查漏补缺第七期(美团到店一面)
- 查漏补缺第八期(阿里一面)
- 查漏补缺第九期(阿里二面)
- 查漏补缺第十期(网易实习一面)
- 查漏补缺第十一期(网易实习二面)
- 查漏补缺第十二期(网易实习三面)
- 查漏补缺第十三期(滴滴实习一面)
- 查漏补缺第十四期(滴滴实习二面)
- 查漏补缺第十五期(华为一面)
- 查漏补缺第十六期(华为二面)
- 查漏补缺第十七期(华为三面)
- 查漏补缺第十八期(你了解class文件吗)
项目源码(源码已更新 欢迎star⭐️)
往期设计模式相关文章
- 一起来学设计模式之认识设计模式
- 一起来学设计模式之单例模式
- 一起来学设计模式之工厂模式
- 一起来学设计模式之建造者模式
- 一起来学设计模式之原型模式
- 一起来学设计模式之适配器模式
- 一起来学设计模式之桥接模式
- 一起来学设计模式之组合模式
- 一起来学设计模式之装饰器模式
- 一起来学设计模式之外观模式
- 一起来学设计模式之享元模式
- 一起来学设计模式之代理模式
- 一起来学设计模式之责任链模式
- 一起来学设计模式之命令模式
- 一起来学设计模式之解释器模式
- 一起来学设计模式之迭代器模式
- 一起来学设计模式之中介者模式
- 一起来学设计模式之备忘录模式
- 一起来学设计模式之观察者模式
- 一起来学设计模式之状态模式
- 一起来学设计模式之策略模式
- 一起来学设计模式之模板方法模式
- 一起来学设计模式之访问者模式
- 一起来学设计模式之依赖注入模式
设计模式项目源码(源码已更新 欢迎star⭐️)
Kafka 专题学习
- 一起来学kafka之Kafka集群搭建
- 一起来学kafka之整合SpringBoot基本使用
- 一起来学kafka之整合SpringBoot深入使用(一)
- 一起来学kafka之整合SpringBoot深入使用(二)
- 一起来学kafka之整合SpringBoot深入使用(三)
项目源码(源码已更新 欢迎star⭐️)
ElasticSearch 专题学习
项目源码(源码已更新 欢迎star⭐️)
往期并发编程内容推荐
- Java多线程专题之线程与进程概述
- Java多线程专题之线程类和接口入门
- Java多线程专题之进阶学习Thread(含源码分析)
- Java多线程专题之Callable、Future与FutureTask(含源码分析)
- 面试官: 有了解过线程组和线程优先级吗
- 面试官: 说一下线程的生命周期过程
- 面试官: 说一下线程间的通信
- 面试官: 说一下Java的共享内存模型
- 面试官: 有了解过指令重排吗,什么是happens-before
- 面试官: 有了解过volatile关键字吗 说说看
- 面试官: 有了解过Synchronized吗 说说看
- Java多线程专题之Lock锁的使用
- 面试官: 有了解过ReentrantLock的底层实现吗?说说看
- 面试官: 有了解过CAS和原子操作吗?说说看
- Java多线程专题之线程池的基本使用
- 面试官: 有了解过线程池的工作原理吗?说说看
- 面试官: 线程池是如何做到线程复用的?有了解过吗,说说看
- 面试官: 阻塞队列有了解过吗?说说看
- 面试官: 阻塞队列的底层实现有了解过吗? 说说看
- 面试官: 同步容器和并发容器有用过吗? 说说看
- 面试官: CopyOnWrite容器有了解过吗? 说说看
- 面试官: Semaphore在项目中有使用过吗?说说看(源码剖析)
- 面试官: Exchanger在项目中有使用过吗?说说看(源码剖析)
- 面试官: CountDownLatch有了解过吗?说说看(源码剖析)
- 面试官: CyclicBarrier有了解过吗?说说看(源码剖析)
- 面试官: Phaser有了解过吗?说说看
- 面试官: Fork/Join 有了解过吗?说说看(含源码分析)
- 面试官: Stream并行流有了解过吗?说说看