Java编码规范
目录
Java编码规范... 1
1. 命名风格... 2
2. 常量定义... 2
3. 代码格式... 3
4. OOP(Object Oriented Programming)规约... 4
5. 集合处理... 5
6. 并发处理... 7
7. 控制语句... 8
8. 注释规约... 8
9. 其他... 9
- 命名风格
- 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
- 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。但是alibaba /beijing 等国际通用的名称，可视同英文。
- 类名使用UpperCamelCase风格，必须遵从驼峰形式。
- 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
- 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚。
- 抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾
- 中括号是数组类型的一部分，数组定义如下：String[] args; 禁止使用String args[]的方式来定义。
- 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
- 杜绝完全不规范的缩写，如：AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi。这种缩写反而降低了代码的可阅读性。
- 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。应避免int a这种随意的命名方式。
- 如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式，有助于读者理解设计模式。例：public class OrderFactory;
- 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
正例：接口方法签名：void f(); 接口基础常量表示：String LOCATION = "beijing";
反例：接口方法定义：public abstract void f();
- 接口和实现类的命名有两套规则： 1）对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
例：CacheServiceImpl实现CacheService接口。
2）如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。
例：AbstractTranslator实现 Translatable。
- 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
- 常量定义
- 不允许任何魔法值（即未经定义的常量）直接出现在代码中。
- long或者Long初始赋值时，使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
- 不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。
- 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
应用内共享常量：放置在一方库中，通常是modules中的constant目录下。
子工程内部共享常量：即在当前子工程的constant目录下。
包内共享常量：即在当前包下单独的constant目录下。
类内共享常量：直接在类内部private static final定义。
- 如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。
例：public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}
- 代码格式
- 大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：左大括号前不换行(加空格)，左大括号后换行。右大括号前换行。右大括号后还有else等代码则不换行；表示终止的右大括号后必须换行。
- 左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
- if/for/while/switch/do等保留字与括号之间都必须加空格。例：if (a==b)。
- 任何二目、三目运算符的左右两边都需要加一个空格。包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
- 采用4个空格缩进，禁止使用tab字符。如果使用tab缩进则必须设置1个tab为4个空格。
- 注释的双斜线与注释内容之间有且仅有一个空格。
- 单行字符数限制不超过 120 个，超出需要换行，换行时 遵循如下原则：
1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2） 运算符与下文一起换行。
3） 方法调用的点符号与下文一起换行。
4） 方法调用时，多个参数，需要换行时，在逗号后进行。
5） 在括号前不要换行，见反例。
- 方法参数在定义和传入时，多个参数逗号后边必须加空格。例：mehtod(“a”, “b”, “c”);
- IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用Windows格式。
- 没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
- 方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
- OOP(Object Oriented Programming)规约
- 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
- 所有的覆写方法，必须加@Override注解。
说明：getObject()与get0bject()的问题。一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。
- 相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。 说明：可变参数必须放置在参数列表的最后。
- 外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。
- 不能使用过时的类或方法。
- Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
- 所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。
说明：对于Integer var = ? 在-128至127范围内的赋值，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象。
- 序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
- 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
- POJO(Plain Ordinary Java Object简单的Java对象，实际就是普通JavaBeans)类必须写toString方法。如果继承了另一个POJO类，注意在前面加一下super.toString。
- 使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。
- 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起。
- 类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。
- setter方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在getter/setter方法中，不要增加业务逻辑，增加排查问题的难度。
- 循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。
- 慎用Object的clone方法来拷贝对象。
说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝。
- 类成员与方法访问控制从严：
1）如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
2）工具类不允许有public或default构造方法。
3）类非static成员变量并且与子类共享，必须是protected。
4）类非static成员变量并且仅在本类使用，必须是private。
5）类static成员变量如果仅在本类使用，必须是private。
6）若是static成员变量，必须考虑是否为final。
7）类成员方法只供类内部调用，必须是private。
8）类成员方法只对继承类公开，那么限制为protected。
- 集合处理
- 只要重写equals，就必须重写hashCode。因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法。如果自定义对象做为Map的键，那么必须重写hashCode和equals。
- ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常。
说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
- 在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均会产生ConcurrentModificationException 异常。
- 使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。
- 使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常。
说明：asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。
- 泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方法，而<? super T>不能使用get方法，做为接口调用赋值时易出错。
- 不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。
(解释详见链接)
- Comparator要满足如下三个条件，不然Arrays.sort，Collections.sort会报IllegalArgumentException异常。
说明：1）x，y的比较结果和y，x的比较结果相反。
2）x>y，y>z，则x>z。
3）x=y，则x，z比较结果和y，z比较结果相同。
- 集合初始化时，指定集合初始值大小。
正例：initialCapacity (需要存储的元素个数 / 负载因子) + 1。 负载因子（即loader factor 默认为 0.75，如果暂时无法确定初始值大小，请设置为16（即默认值）。
反例： HashMap需要 放置 1024个元素，由于没有设置容量初始大小，随着元素不断增加，容量7次被迫扩大，resize需要重建hash表，严重影响性能。
- 使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。
说明：keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。如果是JDK8，使用Map.foreach方法。
- Map类集合键值对能不能为null的情况
- 合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
- 并发处理
- 获取单例对象以及其中的方法都要保证线程安全。
- 创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
- 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
- 线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，规避资源耗尽的风险。
- SimpleDateFormat 是线程不安全的类，一般不要定义为static变量，如果定义为static，必须加锁，或者使用DateUtils工具类。
- 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
- 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
- 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。
说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。
- 多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题。
- 使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。(注意，子线程抛出异常堆栈，不能在主线程try-catch到)
- 避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。
- volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。
- HashMap在容量不够进行resize时由于高并发可能出现死链，导致CPU飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。
- ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。
- 控制语句
- 在一个switch块内，每个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。
- 在if/else/for/while/do语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements;
- 除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
- 循环体中的语句要考量性能，某些操作尽量移至循环体外处理。如定义对象、变量、获取数据库连接，进行不必要的try-catch操作。
- 接口入参保护，这种场景常见的是用于做批量操作的接口。
- 下列情形，需要进行参数校验：
1）调用频次低的方法。
2）执行时间开销很大的方法。
3）需要极高稳定性和可用性的方法。
4）对外提供的开放接口，不管是RPC/API/HTTP接口。
5）敏感权限入口。
- 下列情形，不需要进行参数校验：
1）极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2）底层调用频度比较高的方法。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验可以省略。
3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。
- 注释规约
- 类、类属性、类方法的注释必须使用Javadoc规范，使用/**内容*/格式，不得使用// xxx方式。
- 所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。(对子类的实现要求，或者调用注意事项需一并说明)
- 所有的类都必须添加创建者和创建日期。
- 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
- 所有的枚举类型字段必须要有注释，说明每个数据项的用途。
- 与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
- 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
- 谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
- 注释要求能够准确反应设计思想和代码逻辑；能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。即使隔很长时间，也能清晰理解当时的思路；也能让继任者快速接替自己的工作。
- 好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
- 其他
- 在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
- 注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
- 获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime()。
- 不要在视图模板中加入任何复杂的逻辑。
- 任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
- 及时清理不再使用的代码段或配置信息。
