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

不久前，阿里巴巴发布了《阿里巴巴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 df = new ThreadLocal() { 
    @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以下)，双检锁是没问题的。

【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题， 但是如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现: AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推荐使用 LongAdder 对象，比 AtomicLong 性能更好(减少乐观锁的重试次数)。

白话：
    
volatile只有内存可见性语义，synchronized有互斥语义，一写多读使用volatile就可以，多写就必须使用synchronized，fetch-mod-get也必须使用synchronized。

【参考】 HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中注意规避此风险。

白话：
    
开发程序的时候要预估使用量，根据使用量来设置初始值。

resize需要重建hash表，严重影响性能，会让程序产生长尾的响应时间。

【参考】ThreadLocal 无法解决共享对象的更新问题，ThreadLocal 对象建议使用 static 修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只 要是这个线程内定义的)都可以操控这个变量。

白话：
    
ThreadLocal实际上是一个从线程ID到变量的Map，每次取得ThreadLocal变量，实际上是先取得当前线程ID，再用当前线程ID取得关联的变量。

ThreadLocal使用了WeakHashMap，在key被回收的时候，value也被回收了，不用担心内存泄露。

日志规约

【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API，而应依赖使用日志框架 SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);

白话：
	
使用slf4jAPI更爽更清新。

通过占位符的方式不但代码清晰，对象的toString等方法也是根据日志等级来调用的。

【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。

白话：
	
其实需要更长，有的线上事故复盘周期更长，需要更长的日志保存。

这其实不是开发的职责，应该构建大数据日志系统，比如：ELK等。

【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式: appName_logType_logName.log。

logType: 日志类型，推荐分类有stats/desc/monitor/visit 等;

logName: 日志描述。

这种命名的好处: 通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

正例: mppserver 应用中单独监控时区转换异常，如: mppserver_monitor_timeZoneConvert.log

说明: 推荐对日志进行分类，错误日志和业务日志尽量分开存放，便于开发人员查看，也便于 通过日志对系统进行及时监控。

白话：
	
逻辑上分开更利于日志管理。

性能上，机械硬盘如果是单文件写可以一定程度利用磁盘顺序写提高性能。

【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方 式。

说明: logger.debug("Processing trade with id: " + id + " symbol: " + symbol); 如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象， 会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。

正例: (条件)

java
if (logger.isDebugEnabled()) {
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
}

正例: (占位符)

logger.debug("Processing trade with id: {} symbol : {} ", id, symbol);

白话：
	
一定不要用字符串相加，一定要用占位符。

【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置additivity=false。

正例:

白话：
	
日志需要CPU处理，缓存的时候需要占用内存，打印过程中要占用IO带宽，存储到磁盘又需要存储空间，要绿色环保。

【强制】异常信息应该包括两类信息: 案发现场信息和异常堆栈信息。如果不处理，那么通过 关键字 throws 往上抛出。

正例: logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

白话：
	
打印日志一定要包含环境，否则找bug的时候日志对不上，勤奋爱干活的人一下就听懂我在说啥了。

【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使 用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

说明: 大量地输出无效日志，不利于系统性能升，也不利于快速定位错误点。记录日志时请思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

白话：
	
我常常和小伙伴们说，写代码的时候就要想到查bug的时候怎么查，需要哪些日志，打印日志只需要打印核心内容，不要随便就把对象json序列化打印出来，如果是列表会很大。	

【参考】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适 从。注意日志输出的级别，error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必要，请不要在此场景打出 error 级别。

白话：
	
合理利用warn级别日志，error级别日志最重要，理想情况下生产上产生的error和warn日志开发要定期的梳理。

安全规约

【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。

说明: 防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。

白话：
	
面向用户的所有服务都要有权限校验。

后端服务没有权限校验，也要有服务化平台下的调用权限管理。

【强制】用户敏感数据禁止直接展示，必须对展示数据脱敏。

说明: 查看个人手机号码会显示成:158****9119，隐藏中间 4 位，防止隐私泄露。

白话：
	
除了手机号，在金融领域会有更多的敏感信息。

防泄露必须加密，防篡改必须签名，防抵赖必须非对称签名。

【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入， 禁止字符串拼接 SQL 访问数据库。

白话：
	
这条一般用代码检查工具都会检查出来。

开发人员千万不要做字符串连接SQL。

【强制】用户请求传入的任何参数必须做有效性验证。

说明:

忽略参数校验可能导致:

• page size过大导致内存溢出。

• 恶意order by导致数据库慢查询。

• 任意重定向。

• SQL注入。

• 反序列化注入。

• 正则输入源串拒绝服务ReDoS.

说明: Java 代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题， 但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。

白话：
	
一般在框架层都要做特殊字符的过滤，包括：大于号、小于号、单引号等。

任何使用集合的时候，输入参数是集合的时候，返回是集合的时候，一定要有条数的限制，不能无限大。

【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。

白话：
	
系统的入口要堵住特殊字符，入口可能是web界面，也可能是开发的接口。

系统的出口也要堵住特殊字符，出口一般指的是web界面。

【强制】表单、AJAX 提交必须执行 CSRF 安全过滤。

说明: CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在 CSRF 漏洞的应用/网站，攻击者可以事先构造好 URL，只要受害者用户一访问，后台便在用户 不知情情况下对数据库中用户参数进行相应修改。

白话：堵住系统的入口！

【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放限制， 如数量限制、疲劳度控制、验证码校验，避免被滥刷、资损。

说明: 如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。

白话：针对用户输入，一定要做防御式编程。

【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。

白话：这个一般是大数据部门提供决策数据，各个业务方埋点。

OOP 规约

【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成 本，直接用类名来访问即可。

白话：也不直观，看调用代码看不出来是静态方法，容易误解。

【强制】所有的覆写方法，必须加@Override 注解。

反例:getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

 白话：
    
Java和C++不一样，C++是在父类先声明虚拟函数子类才覆写，Java是任何方法都能覆写，也可以不覆写，所以覆写不覆写是没有编译器检查的，除非接口中某一个方法完全没有被实现才会编译报错。

【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。

说明: 可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)

正例: public User getUsers(String type, Integer... ids)

白话：用处不大，可以用重载方法或者数组参数代替。

一般应用在日志的 API 定义上，用于传不定的日志参数。

【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生 影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

白话：
    
设计时没有考虑周全，需要改造接口，需要通过增加新接口，迁移后下线老接口的方式实现。

REST接口只能增加参数，不能减少参数，返回值的内容也是只增不减。

【强制】不能使用过时的类或方法。

说明: java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口; 作为调用方来说，有义务去考证过时方法的新实现是什么。

白话：
    
明确了责任和义务，接口提供方也有义务推动接口使用方尽早迁移，不要积累技术负债。

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

正例: "test".equals(object);

反例: object.equals("test");

说明: 推荐使用java.util.Objects#equals (JDK7引入的工具类)

白话：常量比变量，永远都不变的原则。

【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

说明: 对于Integer var = ?在-128至127之间的赋值，Integer对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行 判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑， 推荐使用 equals 方法进行判断。

白话：
    
Java世界里相等请用equals方法，==表示对象相等，一般在框架开发中会用到。

关于基本数据类型与包装数据类型的使用标准如下:

• 【强制】所有的POJO类属性必须使用包装数据类型。

• 【强制】RPC方法的返回值和参数必须使用包装数据类型。

• 【推荐】所有的局部变量使用基本数据类型。

说明: POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。

正例: 数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

反例: 比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示:0%，这是不合理的，应该显示成中划线-。所以包装数据类型的 null 值，能够表示额外的信息，如:远程调用失败，异常退出。

白话：
    
其实包装数据类型与基本数据类型相比，增加了一个null的状态，可以携带更多的语义。

【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

反例: POJO类的gmtCreate默认值为new Date(); 但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

白话： 
    
虽然这里反例不太容易看懂，但是要记得持久领域对象之前由应用层统一赋值gmtCreate和gmtModify字段。

【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败; 如 果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

白话：   
    
不到万不得已不要使用JDK自身的序列化，机制很重，信息冗余有版本。

【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

白话： 
    
这样做一种是规范，代码清晰，还有就是异常堆栈上更容易识别出错的方法和语句。

【强制】POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

说明: 在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排 查问题。

白话：
    
这里还有一个大坑，写toString的时候要保证不会发生NPE，有的时候toString调用实例变量的toString，实例变量由于某些原因为null，导致NPE，代码没有处理好就终止，这个问题坑了好多次。

【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明:

String str = "a,b,c,,";			
String[] ary = str.split(","); //预期大于 3，结果是 3 
System.out.println(ary.length);	

白话： 
    
编程要留心眼，任何不确定的地方都要判断、处理，否则掉到坑里了自己爬出来很费劲。
    
Java编程判空的思想要实施萦绕在每个开发人员的脑海里。 

【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读。

白话： 这规范说的咋就和我的习惯一模一样呢！

【推荐】 类内方法定义顺序依次是: 公有方法或保护方法 > 私有方法 > getter/setter 方法。

说明: 公有方法是类的调用者和维护者最关心的方法，首屏展示最好; 保护方法虽然只是子类 关心，也可能是“模板设计模式”下的核心方法; 而私有方法外部一般不需要特别关心，是一个黑盒实现; 因为方法信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最 后。

白话：
        
我推荐把一套逻辑的共有方法、保护方法、私有方法放在一起，所有getter/setter放在最后，这样感觉更有逻辑！

【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在 getter/setter 方法中，尽量不要增加业务逻辑，增加排查问题的难度。

反例:

public Integer getData() { 
    if (true) {
        return data + 100; 
    } else {
        return data - 100; }
    }

白话：双手赞成。

【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

反例:

    String str = "start";
    for (int I = 0; I