欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

阿里新版《Java 开发手册(泰山版)》来了,很多规范值得学习

程序员文章站 2024-03-24 15:30:58
...

阿里新版《Java 开发手册(泰山版)》来了,很多规范值得学习

 

 

阿里的《Java开发手册》距离上次发布已经过去了 10 个月了,而这次发布也增加了很多干货内容,比如:新增 34 条规约,修改描述 90 处,其中错误码规则更是第一次提出完整的解决方案,发布日志如下图所示:

阿里新版《Java 开发手册(泰山版)》来了,很多规范值得学习

 

 

新增内容概览

本次更新主要更新的内容有:

  1. 新增了错误码规范;
  2. 扩充了日期(闰年、闰月等)处理方案;
  3. 表别名规范;
  4. 三目运算符规范等。

接下来我们来看这些新增内容的具体含义。

 

阿里新版《Java 开发手册(泰山版)》来了,很多规范值得学习

 

 

1.错误码规范

之前版本中是没有关于「错误码」的整体说明的,而这个版本增加了很大的篇幅,来把这个前后端配合的重要环节「错误码」部分,做了详细的规范和说明,可谓非常的香,具体规范如下:

  • 【强制】错误码的制定原则:快速溯源、简单易记、沟通标准化。
  • 【强制】错误码不体现版本号和错误等级信息。
  • 【强制】全部正常,但不得不填充错误码时返回五个零:00000。
  • 【强制】错误码为字符串类型,共 5 位,分成两个部分:错误产生来源 + 四位数字编号。

说明:错误产生来源分为 A/B/C:

  • A:表示错误来源于用户,比如参数错误,用户安装版本过低,用户支付超时等问题;
  • B:表示错误来源于当前系统,往往是业务逻辑出错,或程序健壮性差等问题;
  • C:表示错误来源于第三方服务,比如 CDN 服务出错,消息投递超时等问题;四位数字编号从 0001 到 9999,大类之间的步长间距预留 100,详情可见《Java开发手册》正文。

2.扩充了日期处理方案

一个写死为 365 天的年份天数,在闰年里让大家尝尽了悲伤痛楚,比如,缓存有效期 = 3652460*60 秒,结果提前一天所有缓存同时失效,高并发访问时数据库就跪了。

【强制】不要在程序中写死一年为 365 天,避免在公历闰年时出现日期转换错误或程序逻辑错误。

正例:

// 获取今年的天数
int daysOfThisYear = LocalDate.now().lengthOfYear();
// 获取指定某年的天数
LocalDate.of(2011, 1, 1).lengthOfYear();
复制代码

反例:

// 第一种情况:在闰年 366 天时,出现数组越界异常
int[] dayArray = new int[365];
// 第二种情况:一年有效期的会员制,今年 1 月 26 日注册,硬编码 365 返回的却是 1 月 25 日
Calendar calendar = Calendar.getInstance();
calendar.set(2020, 1, 26);
calendar.add(Calendar.DATE, 365);
复制代码

3.表别名规范

【强制】对于数据库中表记录的查询和变更,只要涉及多个表,都需 表名)进行限定。 说明:对多表进行查询记录、更新记录、删除记录时,如果对操作列没有限定表的别名(或表名),并且 操作列在多个表中存在时,就会抛异常。 正例:select t1.name from table_first as t1 , table_second as t2 where t1.id=t2.id;

反例:在某业务中,由于多表关联查询语句没有加表的别名(或表名)的限制,正常运行两年后,最近在 某个表中增加一个同名字段,在预发布环境做数据库变更后,线上查询语句出现出 1052 异常:Column 'name' in field list is ambiguous。

【推荐】SQL 语句中表的别名前加 as,并且以 t1、t2、t3、...的顺序依次命名。 说明:

  • 别名可以是表的简称,或者是根据表出现的顺序,以 t1、t2、t3 的方式命名。
  • 别名前加 as 使别名更容易识别。 正例:select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

4.三目运算符规范

原来在三目运算符中:

condition ? 表达式1 : 表达式2

表达式 1 和 2 在涉及算术计算或数据类型转换时,会触发自动拆箱。拆箱操作本来没有问题,但是当其中的操作数为 null 值时,一个大大的 NPE 就砸到了我滴脸上,如下代码所示:

Integer a = 1;
Integer b = 2;
Integer c = null;
Boolean flag = false;
Integer result = (flag ?  a * b  :  c);
复制代码

注意:a*b 的结果是 int 类型,那么 c 会强制拆箱成 int 类型,抛出 NPE 异常。

【强制】三目运算符 condition? 表达式 1 : 表达式 2 中,高度注意表达式 1 和 2 在类型对齐时,可能抛出因自动拆箱导致的 NPE 异常。

说明:以下两种场景会触发类型对齐的拆箱操作:

  • 表达式 1 或表达式 2 的值只要有一个是原始类型。
  • 表达式 1 或表达式 2 的值的类型不一致,会强制拆箱升级成表示范围更大的那个类型。