java编程规范

未符合的规范

1：变量和常量的命名方式

非公有（private/protected/default）变量前面要加上小写m；
静态变量（static）前面加上小写s；
其它变量以小写字母开头；
静态常量（static final）全大写。

抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类名开始，以Test结尾。

POJO类中布尔类型的标量，都不要加is前缀，否则部分框架解析会引起序列化错误。 
反例：定义为基本数据类型 Boolean isDeleted；的属性，它的方法也是 isDeleted()，RPC框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

包名统一是用小写，点分隔符之间“有且仅有一个自然语义的英语单词”。包名统一使用单数形式，但是类名如有复数含义，类名可以使用复数形式。其实很多团队都会用公司官方网址的倒写作为包名。这些都是可以主观规定的。

]如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。 
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。 
正例：
public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

接口和实现类的命名有两套规则：

对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用lmpl的后缀与接口区别。
正例：CacheServiceImpl 实现 CacheService 接口。

[推荐]如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able的形式）。
正例：AbstractTranslator 实现 Translatable。

接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简洁性，并加上有效的javadoc注释。精良不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。 
正例：接口方法签名 void f(); 
接口基础常量 String COMPANY = “alibaba”; 
反例：接口方法定义 public abstract void f();

枚举类名建议带上Enum后缀，枚举成员名称需要全部大写，单词间用下划线隔开。 
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。 
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。

9：Service/DAO层方法命名规约：

获取单个对象的方法用get作前缀。
获取多个对象的方法用list作前缀。
获取统计值的方法用count作前缀。
插入的方法用save/insert作前缀。
删除的方法用remove/delete作前缀。
修改的方法用update作前缀。

领域模型命名规约

数据对象xxxDO，xxx即为数据表名。
数据传输对象：xxxDTO，xxx为业务领域相关的名称。
展示对象：xxxVO，xxx一般为网页名称。
POJO是DO/DTO/BO/VO 的统称，禁止命名成xxxPOJO。

不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。 
反例：

String key = "Id#taobao_" + tradeId;
cache.put(key, value);
1
2
说明：上面的”Id#taobao_”就是魔法值，需要先定义再使用： 
正例：

private static final String NAME_TAOBAO = "Id#taobao_";
String key = NAME_TAOBAO + tradeId;
cache.put(key, value);

不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。 
说明：大而全的长两类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。 
正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

大括号的使用约定。如果是大括号内为空，则简介地写成{}即可，不需要换行；如果是非空代码块则：

左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

注释的双斜线与注释内容之间有且仅有一个空格。 
正例：

//  这是示例注释，请注意在双斜线之后有一个空格
String ygb = new String();

单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：

第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
运算符与下文一起换行。
方法调用的点符号与下文一起换行。
方法调用时，多个参数，需要换行时，在逗号后进行。
在括号前不要换行，见反例。

方法参数在定义和传入是，多个参数逗号后边必须加空格。 
正例：下例中实参的”a”,后边必须要有一个空格。

method("a", "b", "c");

IDE的text file encoding设置为UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

不同逻辑、不同语义、不同业务的代码之间插入一个空行分割开来以提升可读性。 
说明：没有必要插入多个空行进行隔开

]所有的覆写方法，必须加@Override注解。

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

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

[强制]所有的 POJO 类属性必须使用包装数据类型。
[强制]RPC 方法的返回值和参数必须使用包装数据类型。
[推荐]所有的局部变量使用基本数据类型。
说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE 问题，或者入库检查，都由使用者来保证。 
正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

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

序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列化失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。 
说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

构造方法里面禁止加入任何业务逻辑。使用IDE中的工具，请放在init方法中。

POJO类必须写toString方法。使用IDE中的工具：source> generate toString时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。 
说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。

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

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

关于hsahCode和equals的处理，遵循如下规则：

只要重写 equals，就必须重写 hashCode。
因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须重写这两个方法。
如果自定义对象作为 Map 的键，那么必须重写 hashCode 和 equals。
说明：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。

ArrayList 的 subList 结果不可强转成 ArrayList，否则会抛出 ClassCastException 异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList. 
说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。
3.[强制]在 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均会产生 ConcurrentModificationException 异常。

使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。
说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ] 的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小

定义与集合元素个数一致。
正例：

List<String> list = new ArrayList<String>(2);
list.add("guan");
list.add("bao");
String[] array = new String[list.size()];
array = list.toArray(array);
反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出现 ClassCastException 错误。

使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法抛出UnsupportedOperationException 异常。 
说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str);
1
2
第一种情况：list.add(“yangguanbao”); 运行时异常。 
第二种情况：str[0] = “gujin”; 那么 list.get(0)也会随之修改。

使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法抛出UnsupportedOperationException 异常。 
说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str);
1
2
第一种情况：list.add(“yangguanbao”); 运行时异常。 
第二种情况：str[0] = “gujin”; 那么 list.get(0)也会随之修改。

6.[强制]泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方法，而<? super T>不能使用 get 方法，作为接口调用赋值时易出错。 
说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用<? extends T>。第二、经常往里插入的，适合用<? super T>。

7.[强制]不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。 
正例：

        Iterator<String> iterator = list.iterator();
        while (iterator.hasNext()) {
            String item = iterator.next();
            if (删除元素的条件) {
                iterator.remove();
            }
        }

反例：

        List<String> list = new ArrayList<String>();
        list.add("1");
        list.add("2");
        for (String item : list) {
            if ("1".equals(item)) {
                list.remove(item);
            }
        }

31 ????

在 JDK7 版本及以上，Comparator 要满足如下三个条件，不然 Arrays.sort，Collections.sort 会报 IllegalArgumentException 异常。 
说明：三个条件如下

x，y 的比较结果和 y，x 的比较结果相反。
x>y，y>z，则 x>z。
x=y，则 x，z 比较结果和 y，z 比较结果相同。
反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

        new Comparator<Student>() {
            @Override
            public int compare(Student o1, Student o2) {
                return o1.getId() > o2.getId() ? 1 : -1;
            }
        };

32 ???

]集合初始化时，指定集合初始值大小。 
说明：HashMap 使用 HashMap(int initialCapacity) 初始化，

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。

反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

33 ？？？

使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。 
说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.foreach 方法。

正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。

合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。 
说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是order/sort。

利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。

利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。

获取单例对象需要保证线程安全，其中的方法也要保证线程安全。 
说明：资源驱动类、工具类、单例工厂类都需要注意。

创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。 
正例：

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

线程资源必须通过线程池提供，不允许在应用中自行显示创建线程。 
说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

4.[强制]线程池不允许使用Executors去创建，而是通过 ThreadPoolExecutor的方法，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。 
说明：Executors 返回的线程池对象的弊端如下：

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

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

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 代替 SimpleDateFormat，官方给出的解释： 
simple beautiful strong immutable thread-safe。

高并发时同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。 
说明:尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

]对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。 
说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A、B、C，否则可能出现死锁。

并发修改同一记录时，避免更新丢失，需要枷锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。 
说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

多线程并发处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其他任务便会自动终止运行，使用ScheduledExecutorService 则没有这个问题。

使用CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown 方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行至 await 方法，直到超时才返回结果。 
说明：注意，子线程抛出异常堆栈，不能在主线程 try-catch 到。

避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一 seed 导致的性能下降。 
说明：Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。 
正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，需要编码保证每个线程持有一个实例。

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

    class Singleton {
        private Helper helper = null;

        public Helper getHelper() {
            if (helper == null)
                synchronized (this) {
                    if (helper == null)
                        helper = new Helper();
                }
            return helper;
        }
        // other methods and fields...
    }

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

HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。

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

在一个switch块内，每一个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使空代码。

在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements;

在高并发场景中，避免使用”等于”判断作为中断或退出的条件。 
说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。

反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

        if (condition) {
            ...
            return obj;
            }
            //接着写 else 的业务逻辑代码;
说明：如果非得使用 if()…else if()…else…方式表达逻辑，【强制】避免后续代码维护困难，请勿超过 3 层。 
正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现， 
其中卫语句示例如下：

    public void today() {
        if (isBusy()) {
            System.out.println(“change time.”);
            return;
        }

        if (isFree()) {
            System.out.println(“go to travel.”);
            return;
        }
            System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”); 
            return;
        }

除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？

正例：

//伪代码如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...); if (existed) {
...

反例：
if ((file.open(fileName, "w") != null) && (...) || (...)) {
...
}

循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）。

避免采用取反逻辑运算符。 
说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。 
正例：使用 if (x < 628) 来表达 x 小于 628。 
反例：使用 if (!(x >= 628)) 来表达 x 小于 628。

接口入参保护，这种场景常见的是用作鼻梁操作的接口。

下列情形，需要进行参数校验：

调用频次低的方法。
执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
需要极高稳定性和可用性的方法。
对外提供的开放接口，不管是 RPC/API/HTTP 接口。
敏感权限入口。

下列情形，不需要进行参数校验：

极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 
层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。
被声明成 private 
只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

方法内部单行注释，在被注释语句上方另起一行，使用//珠海。方法内部多行注释使用/**/注释，注意与代码对齐。

所有的枚举类型字段必须要有注释，说明每个数据项的用途。

与其“半吊子”英文注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。 
反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

7.[推荐]代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。 
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。 
说明：代码被注释掉有两种可能性：

后续会恢复此段代码逻辑。
永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

对于注释的要求： 
第一、能够准确反应设计思想和代码逻辑； 
第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。

好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。 
反例：

//put elephant into fridge 
put(elephant, fridge);
方法名 put，加上两个有意义的变量名 elephant 和 fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。

错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

69 ???

在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。 
说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);

70 ???

velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is前缀），会自动调用 isXxx()方法。 
说明：注意如果是 Boolean 包装类对象，优先调用 getXxx()的方法。

71 ???

后台输送给页面的变量必须加!var——中间的感叹号。说明：如果var=null或者不存在，那么{var}会直接显示在页面上。

注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。

]获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime(); 
说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。

不要在视图模板中加入任何复杂的逻辑。 
说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。

任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。

及时清理不再使用的代码段或配置信息。 
说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。 
正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

 Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。 
说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，不得不通过 catchNumberFormatException 来实现。 
正例：if (obj != null) {…} 
反例：try { obj.method() } catch (NullPointerException e) {…}

]异常不要用来做流程控制，条件控制。 
说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。

catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。 
说明：对大段代码进行try-catch，是程序无法根据不同的异常做出正确的应急反应，也不利于定位问题，这是一种不负责任的表现。 
正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。

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

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

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

不要在 finally 块中使用 return。 
说明：finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。

捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。 
说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。 
说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null 的情况。

防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：

返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。
反例：public int f() { return Integer 对象}， 如果为 null，自动解箱抛 NPE。

数据库的查询结果可能为 null。
集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。
远程调用返回对象时，一律要求进行空指针判断，防止 NPE。
对于 Session 中获取的数据，建议 NPE 检查，避免空指针。
级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。
正例：使用 JDK8 的 Optional 类来防止 NPE 问题。

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

对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。 
说明：关于 RPC 方法返回方式使用 Result 方式的理由：

使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。 
说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。

正例：一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取：

private boolean checkParam(DTO dto) {...}