白话阿里巴巴 Java 开发手册高级篇

阿里巴巴发布了《阿里巴巴 Java 开发手册》,总结了阿里人多年一线实战中积累的研发流程规范,这些流程规范在一定程度上能够保证最终的项目交付质量。通过限制开发人员的编程风格、实现方式来避免研发人员在实践中容易犯的错误,同样的问题大家使用同样的模式解决,便于后期维护和扩展,确保最终在大规模协作的项目中达成既定目标。 无独有偶,笔者去年在公司里负责升级和制定研发流程、设计模板、设计标准、代码标准等规范,并在实际工作中进行了应用和推广,收效颇丰,也总结了适合支付平台的技术规范。由于阿里巴巴 Java 开发手册本身定位为规约和规范,语言简单、精炼,没有太多的解读和示例,有些条款对于一般开发人员理解起来比较困难。本场 Chat 借着阿里巴巴发布的 Java 开发手册,详细解读 Java 平台下开发规范和标准的制定和实施。 实录提要: 关于 DTO/DO/VO,有没有好的来源实现案例可以参考? 1.4 以下 JDK 已经解决了内存可见性的问题,请问是采用什么机制? Java Web 的项目,异常日志在哪一层记录? 一个方法里面既有数据库操作也有外部 API 接口调用,事务超时时间如何考虑? 开发手册怎么和 checkstyle 结合起来用? 有没有相关文档提供下? 支付和渠道风控的架构是什么? 当前内容版权归码字科技所有并授权显示,盗版必究。

文章正文

不久前,阿里巴巴发布了《阿里巴巴Java开发手册》,总结了阿里巴巴内部实际项目开发过程中开发人员应该遵守的研发流程规范,这些流程规范在一定程度上能够保证最终的项目交付质量,通过在时间中总结模式,并推广给广大开发人员,来避免研发人员在实践中容易犯的错误,确保最终在大规模协作的项目中达成既定目标。

无独有偶,笔者去年在公司里负责升级和制定研发流程、设计模板、设计标准、代码标准等规范,并在实际工作中进行了应用和推广,收效颇丰,也总结了适合支付平台的技术规范,由于阿里巴巴Java开发手册本身定位为规约和规范,语言简单、精炼,没有太多的解读和示例,有些条款对于一般开发人员理解起来比较困难,本文借着阿里巴巴发布的Java开发手册,详细解读Java平台下开发规范和标准的制定和实施,强调那些在开发过程中需要重点关注的技术点,特别是解决某类已识别问题的模式和反模式。

异常处理

【强制】Java 类库中定义的一类 RuntimeException 可以通过预先检查进行规避,而不应该通过 catch 来处理,比如: IndexOutOfBoundsException,NullPointerException等等。

说明: 无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过 catch NumberFormatException 来实现。

正例: if (obj != null) {…}

反例: try { obj.method() } catch (NullPointerException e) {…}

白话:

判空是一个永恒的话题,只要你不确定变量是否为空,都应该判空,否则后患无穷。 

【强制】异常不要用来做流程控制,条件控制,因为异常的处理效率比条件分支低。

白话:

禁止使用异常来封装业务逻辑,业务异常应该用错误码来表示,系统异常则使用Java原生异常。

异常处理是通过异常表查询来实现的,肯定没有跳转语句性能高。

【强制】对大段代码进行 try-catch,这是不负责任的表现。catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型,再做对应的异常处理。

白话:

做事要直切主题,不能一概而论。

不能简单的catch Throwable,然后打印日志,这是不负责任的表现,应该有针对的抓住和处理异常。

【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请 将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。

白话:    

禁止吃掉异常,吃掉异常就是捕获异常什么都没做,也没抛出,这也是不负责任的表现。

是在不能处理的异常抛出去,但是得让使用方知道这种情况,这是编程提供方契约的一种方式。

【强制】有 try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务。

白话:我们基本采用声明式事务,出现异常需要回滚的情况,建议继续抛出异常让声明式事务自动回滚,不建议代码中手工控制事务。

【强制】finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。 说明:如果 JDK7 及以上,可以使用 try-with-resources 方式。

白话:永恒的资源关闭原则。

【强制】不能在 finally 块中使用 return,finally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句。

白话:

确实会覆盖try块里面的return语句。

思维不混乱的话,没人会把return语句写在finally语句里。

【强制】捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。

如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。

白话:异常处理后,让异常变得更小,而不是变大,大而化小,小而化了。

【推荐】方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分 说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。

说明: 本规约明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象,对调用 者来说,也并非高枕无忧,必须考虑到远程调用失败,运行时异常等场景返回 null 的情况。

白话:如前面所说,只要不确定的变量,一定要判空,别自找麻烦。

【推荐】防止 NPE,是程序员的基本修养,注意 NPE 产生的场景:

  • 返回类型为包装数据类型,有可能是null,返回int值时注意判空。

    反例: public int f() { return Integer 对象}; 如果为 null,自动解箱抛 NPE。

  • 数据库的查询结果可能为null。

  • 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。

  • 远程调用返回对象,一律要求进行NPE判断。

  • 对于Session中获取的数据,建议NPE检查,避免空指针。

  • 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。

正例: 可以使用 JDK8 的 Optional 类来防止 NPE 问题。

白话:判空,判空,缓存的数据,别人的数据,都要判空。

【推荐】在代码中使用“抛异常”还是“返回错误码”,对于公司外的 http/api 开放接口必须 使用“错误码”;而应用内部推荐异常抛出;跨应用间 RPC 调用优先考虑使用 Result 方式,封 装 isSuccess、“错误码”、“错误简短信息”。

说明: 关于 RPC 方法返回方式使用 Result 方式的理由:

使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。

如果不加栈信息,只是new自定义异常,加入自己的理解的error message,对于调用端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。

白话:

业务异常使用Result模式,系统异常用Java原生异常。

RPC建议使用Result模式,不想让一个异常在系统间跳来跳去的,异常是包含调用栈的。

【推荐】定义时区分unchecked/checked 异常,避免直接使用RuntimeException抛出, 更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。推荐业界已定义 过的自定义异常,如:DAOException / ServiceException 等。

白话:

不要所有异常都集成自Runtime异常,希望调用方处理的异常一定用checked异常。

【参考】避免出现重复的代码(Don’t Repeat Yourself),即DRY原则。

说明: 随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副 本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是共用模块。

正例: 一个类中有多个 public 方法,都需要进行数行相同的参数校验操作,这个时候请抽取: private boolean checkParam(DTO dto) {...}

白话:如果不知道DRY原则,但是回顾你以前写的代码都是这样写的,那么恭喜你,你是个好程序员,也为你发愁。

并发处理

【强制】获取单例对象需要保证线程安全,其中的方法也要保证线程安全。

说明: 资源驱动类、工具类、单例工厂类都需要注意。

白话:

如果延迟加载实现的单例需要并发控制;如果初始化的时候new单例对象,本身是线程安全的,取得实例方法不需要同步。 

【强制】创建线程或线程池时请指定有意义的线程名称,方便出错时回溯。

正例:

public class TimerTaskThread extends Thread { 
    public TimerTaskThread() {
        super.setName("TimerTaskThread"); 
        ... 
    }
}


白话:写代码的时候就要想到查bug的时候要用到什么信息,然后决定如何命名、打印日志等。    

【强制】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。

说明: 使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销,解决资 源不足的问题。如果不使用线程池,有可能造成系统创建大量同类线程而导致消耗完内存或者 “过度切换”的问题。

白话:一个是使用线程池缓存线程可以提高效率,另外线程池帮我们做了管理线程的事情,提供了优雅关机、interrupt等待IO的线程,饱和策略等功能。

【强制】线程池不允许使用 Executors 去创建,而是通过 ThreadPoolExecutor 的方式,这样的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。

说明: Executors 返回的线程池对象的弊端如下:

  • FixedThreadPool 和 SingleThreadPool: 允许的请求队列长度为 Integer.MAX_VALUE,可能会堆积大量的请求,从而导致 OOM。

  • CachedThreadPool 和 ScheduledThreadPool: 允许的创建线程数量为 Integer.MAX_VALUE,可能会创建大量的线程,从而导致 OOM。

    白话:

    线程池如果没有限制最大数量,线程池撑开的时候,由于内存不够或者系统配置的最大线程数超出,都会产生oom: unalbe to create native thread。

一个组件的核心参数最好要显式的传入,不要默认,就像你交给属下一个任务,任务的目标、原则、时间点、边界都要明确,不能模糊处理一样,免得扯皮。

【强制】SimpleDateFormat 是线程不安全的类,一般不要定义为static变量,如果定义为 static,必须加锁,或者使用 DateUtils 工具类。

正例: 注意线程安全,使用 DateUtils。亦推荐如下处理:

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() { 
    @Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd");
    } 
};

说明: 如果是 JDK8 的应用,可以使用 Instant 代替 Date,LocalDateTime 代替 Calendar, DateTimeFormatter 代替 Simpledateformatter,官方给出的解释: simple beautiful strong immutable thread-safe。

白话:

记住,打死你,我也不会把SimpleDateFormat共享到类中。

【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁; 能锁区块,就不要锁整个方法体; 能用对象锁,就不要用类锁。

白话:

优先无锁,不用锁能解决的一定不要用锁,即使用锁也要控制粒度,越细越好。

【强制】对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会造 成死锁。

说明: 线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作,那么线程二的加锁顺序也必须是 A、B、C,否则可能出现死锁。

白话:

解决死锁的方法:按顺序锁资源、超时、优先级、死锁检测等。

可参考哲学家进餐问题学习更深入的并发机制。

【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存加 锁,要么在数据库层使用乐观锁,使用 version 作为更新依据。

说明: 如果每次访问冲突概率小于 20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次 数不得小于 3 次。

白话:

状态流转、维护可用余额等最好直接利用数据库的行级锁,不需要显式的加锁。

【强制】多线程并行处理定时任务时,Timer 运行多个 TimerTask 时,只要其中之一没有捕获抛出的异常,其它任务便会自动终止运行,使用 ScheduledExecutorService 则没有这个问题。

白话:

线程执行体、任务最上层等一定要抓住Throwable并进行相应的处理,否则会使线程终止。

【推荐】使用 CountDownLatch 进行异步转同步操作,每个线程退出前必须调用 countDown 方法,线程执行代码注意 catch 异常,确保 countDown 方法可以执行,避免主线程无法执行至 await 方法,直到超时才返回结果。

说明: 注意,子线程抛出异常堆栈,不能在主线程 try-catch 到。

白话:

请在try...finally语句里执行countDown方法,与关闭资源类似。

【推荐】避免 Random 实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一 seed 导致的性能下降。

说明: Random 实例包括 java.util.Random 的实例或者 Math.random()实例。

正例: 在 JDK7 之后,可以直接使用 API ThreadLocalRandom,在 JDK7 之前,可以做到每个线程一个实例。

白话:

可以把Random放在ThreadLocal里,只在本线程中使用。

【推荐】在并发场景下,通过双重检查锁(double-checked locking)实现延迟初始化的优 化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration),推荐问 题解决方案中较为简单一种(适用于 JDK5 及以上版本),将目标属性声明为 volatile 型。

反例:

class Foo {
    private Helper helper = null; 
    public Helper getHelper() {
        if (helper == null) 
            synchronized(this) { 
                if (helper == null)
                    helper = new Helper();
            }
            return helper; 
    }
    // other functions and members...
}


白话:

网上对双检锁有N多讨论,这里很负责任的告诉大家,只要不是特别老的JDK版本(1.4以
                        

2017年5月17日晚8点30分,支付平台架构师李艳鹏老师带来了主题为《白话阿里巴巴Java开发手册高级篇》的交流。以下是主持人张爽整理的问题精华,记录了作者和读者间问答的精彩片段。


内容提要:

  • 关于DTO/DO/VO,有没有好的来源实现案例可以参考?特别是在做微服务化的时候,如何合理使用它们?
  • 状态流转、维护可用余额等最好直接利用数据库的行级锁,不需要显式的加锁。可否举例一些适合使用乐观锁的例子?
  • 1.4以下JDK已经解决了内存可见性的问题,请问是采用什么机制,让使用者不用显式使用volatile或者类变量等手段达到happened-before原则?
  • 强制POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString 时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString。 每次修改POJO的时候,都需要执行一次generate toString,如果忘了怎么办,无疑增加出错概率,是否在toString方法中用toJson比较好?
  • Java Web的项目,异常日志在哪一层记录?
  • 一个方法里面既有数据库操作也有外部API接口调用,请问事务超时时间如何考虑?
  • 开发手册怎么和checkstyle结合起来用?
  • 有没有相关文档提供下?
  • 可以简单介绍一下支付和渠道风控的架构吗?阿里有自己的风控体系,那么风控这个岗位是不是对数据分析和挖掘方面有极高的要求?
  • A应用调用B服务接口,B服务调用C服务接口,如果C接口出现异常,该如何处理?
  • self4j API 通过占位符的方式可是代码更加清晰,那么占位符的方式是否会有性能问题?底层的实现应该是查找占位符后替换,是否在记录日志时直接拼接会更好?
  • 日志目前没有一个规范的要求,我一般是在这几个地方打印日志:外部接口调用的前后;本地对外接口的入参;本地对外出参 ,这样可以吗?

问:关于DTO/DO/VO,有没有好的来源实现案例可以参考?特别是在做微服务化的时候,如何合理使用它们?

答: 由于这一系列名词的简写有些相似,容易产生混淆,是实际的生产中也会混用,因此,我们先定义下各个名词的含义,这样下面说起来,大家在同一个水平线上,也请注意不同的文章和不同的人对同一个名词解释也会不同。

这里我们只需要领会要领即可,下面我们先普及一下名词:

DTO(Data Transfer Object):用于在服务化系统中服务间传递信息或者在同一个应用的不同层次使用的对象。

VO(Value Object):指的是领域对象模型中,带着业务逻辑的数据对象。

DO(Domain Object):领域对象,系统内表达业务领域对象的实体。

另外,还有几个名词,也是相似的概念,我们一并列出:

POJO(Plain Ordinary

隐藏内容 支付可见
购买文章 ¥10
订阅频道首月仅需 12 元/月,预计可省 1288 元
¥10
¥10购买
订阅频道免费读
× 订阅 Java 精选频道
首次订阅 ¥ 元/月 15元/月
订阅即可免费阅读所有精选内容