阿里巴巴泰山版《Java 开发者手册》,也是一份防坑指南

语言: CN / TW / HK

精选30+云产品,助力企业轻松上云!>>>

我是风筝,公众号「古时的风筝」。 文章会收录在 JavaNewBee 中,更有 Java 后端知识图谱,从小白到大牛要走的路都在里面。

4月22日,阿里巴巴发布了泰山版《Java 开发手册》,以前以为终极版就真的是终极版了,没想到还是想的太简单了,继终极版之后又发布了详尽版、华山版,这不,泰山版又来了。想想也对,行业一直在发展,JDK 也一直在更新,怎么可能有终极版。

自从2017年阿里发布终结版发布以来,我就把这个手册当做开发规范使用,放在电脑中最显眼的地方,时不时就翻出来看一看,并且在团队中推广,还顺便安利给了一些朋友。每次有新版本发布都第一时间拿下来再重新读一遍。

本次泰山版发布,对比上一版本有如下几个更新:

  1. 发布错误码统一解决方案。
  2. 新增 34条新规约,比如,日期时间的闰年、闰月问题,三目运算的自动拆箱,SQL 查询的表别名限定,Collectors 类的 toMap()方法使用注意等。
  3. 修改描述 90处,比如,阻塞等待锁、建表的小数类型等。
  4. 完善若干处示例,比如,ISNULL 的示例等 。

为什么要经常拿出来读一读呢?

手册涉及从项目设计到编码、部署的各个方面。但是对于开发者个人来说,有些方面其实不常接触,比如并发控制有很多人接触的机会有限。再比如异常定义、MySQL 管理,可能是项目开始的时候被核心开发人员或者架构师统一定制好了,有些同学也就直接拿来主义了,也不关心具体的设计原理和实现细节。

手册也不长,这一版正文只有 57 页,读一遍也花不了多长时间。其中有些方面是我们平时也经常说到的,比如命令风格、常量定义等,也有一些方面可能平时就没那么注意了,比如注释规约,注释怎么写,写在哪里,什么格式。不夸张的说,很多时候,能写注释的都已经很不错了, 更不要说把注释写清楚,甚至有很多人根本就不怎么写注释,觉得这是浪费时间。

这个手册是阿里巴巴多年开发经验的结晶,除了上面说到的命名、注释等提升代码可读性、易读性的规约,还包括了正确的建表、良好的工程结构、良好的异常处理、安全控制,还有一些平时常用 JDK 功能的防坑指南。

命名风格、常量定义、代码格式

这几个基本上写过几年代码的都会有一套差不多的规范,基本上和阿里巴巴开发者手册相差无几。

OOP 规约

6.【强制】Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。

正例:"test".equals(object); 反例:object.equals("test"); 说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)。

反例中的 object 是一个变量,并且这个变量为 null,就会抛出异常。推荐使用 Objects.equals(s1, s2)。

8. 【强制】任何货币金额,均以最小货币单位且整型类型来进行存储。

比如说人民币的最小单位是分,那假设一个商品的价格是1元钱,那就存到数据库的 price 字段,字段类型是 int 或者 bigint,值为 100,单位是分,也就是100分。

我就在这个问题上入过坑,几年前一个系统中的价格字段用的是浮点数,单位还是元,后面在价格计算上很是麻烦,而且浮点数的计算并不是完全准确的,尤其是涉及到小数位的时候。最后还是把字段调成了 int 类型,代码上涉及到价格的地方都重构了。

所以,后来当我看到手册中的这条规约的时候,有种相见恨晚的感觉。我用了惨痛的经验才换来这个教训,如果早点看到呢,岂不是省了很多事。

9. 【强制】浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用 equals 来判断。

反例:

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
}

没写过浮点数计算之前,觉得这不就是数学计算吗,计算机最高出来不就是为了干这个的吗。直到接触了浮点数计算才发现和想象的完全不一样,就像上面的反例那样,原因是计算机采用二进制,没办法完全精确的表示十进制,有兴趣的同学可以搜一搜,了解一下背后原理。

正确的做法是用高精度的 BigDecimal,它的目的就是用来做浮点数做不来的高精度计算的。

日期格式

有好多同学对于日期的处理都不是很熟悉,经常好久不用,用到了就去网上查,其实我也不常用,要让我现在手写一个日期处理的方法也得查 API,为此专门写了一个日期处理工具类。但是注意要及时升级,比如 JDK 8 之后出的 LocalDateTime 就可以替换之前的 Date 了。

手册中还专门提到了**【强制】不允许在程序任何地方中使用:1)java.sql.Date2)java.sql.Time3) java.sql.Timestamp**,赶紧翻翻你的代码中是不是还在用这三个类型,反正我已经在用 LocalDateTime。

集合处理

集合使我们开发中使用频率非常高的数据结构,建议每一条都仔细阅读,然后应用到我们的项目中。这哪里是开发手册,这是在告诉我们如何正确的使用Java 集合。

并发处理

如何正确的使用线程池、SimpleDateFormat 不是线程安全的、正确的使用 ThreadLocal。每一条背后都是经验教训。

异常处理

try-catch 如何使用、同一模块如何处理异常、不同服务如何处理异常等等。

MySQL

如何建表、何时分表,如何命名表名、字段名,合适的选择字段类型,如何建立索引、良好的 SQL 语句,ORM 映射,每一条都能深挖下去。

工程结构

项目标准的分层结构是怎么样的,依赖库的管理方式,服务器的重点调优指标等等。

设计规约

从架构师的角度规范一个项目文档编写、设计过程等等。

错误码

错误码用来友好的反应逻辑问题或者系统错误。每个平台都应该有且仅有一份错误码,不能多也不能少。在手册最后还公布了一份完整的错误码列表。

能一次性把手册读明白的,那绝对是高手了,大多数人可能对其中的一部分规约不太理解。但其实这些都是基础的内容,所以说,看那些云山雾罩的面试宝典之前,先把这个手册完全搞明白,那对你的编程水平也会有很大提高。

阿里巴巴编码规范 IDEA 插件

阿里巴巴还出了一个开发规约的 IDEA 插件,配合开发手册就完美了。可以在 IDEA 插件管理界面搜索"Alibaba Java Code Guidelines"进行安装。

之后在 IDEA 的 tools 菜单下可以看到这个插件,有动态开启或者关闭,还可以切换语言。

开启之后,当我们在代码里写了违反规约的代码时,就会给出提示,比如我在代码里用 ==比较两个 Integer,就会在 ==下面出现警告提示,并且告诉你正确的姿势是什么。

手册下载

没有下载的同学赶紧下载下来读两遍吧。

官方下载地址,需要登录阿里云。

https://developer.aliyun.com/topic/java2020

没有阿里云的同学,在公众号内回复「阿里」,获取下载地址


送给你

种一棵树最好的时间是十年前,其次是现在。送给各位,也送给自己。

公众号「古时的风筝」,Java 开发者,全栈工程师,人称迟到小王子,bug 杀手,擅长解决问题。 一个兼具深度与广度的程序员鼓励师,本打算写诗却写起了代码的田园码农!坚持原创干货输出,你可选择现在就关注我,或者看看历史文章再关注也不迟。长按二维码关注,跟我一起变优秀!

分享到: