Java开发手册新.docx

1、本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范Java 开发手册前言现代软件行业的高速发展对于开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致维护困难；没有鉴权的漏洞代码被黑客攻击等等。所以本手册以 Java 开发者为中心视角，划分为编程规约、异常日志规约、MySQL 规约、工程规约、安全规约五大块，再根据内容特征，细分成若干二级子目录。根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。对

2、于规约里的内容， “说明”对内容做了引申和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。本手册的愿景是码出质量、码出高效。代码的字里行间流淌的是软件生命中的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识。另外，现代软件架构都需要协同开发完成，高效考虑的是降低协同成本，所谓无规矩不成方圆，无规范不能协作。众所周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。试想如果没有限速，没有红绿灯，没有规定靠右行驶，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可

3、的统一方式一起做事，提升协作效率。本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范一、编程规约(一)命名规约1.【强制】 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例： _name / _name / $Object / name_ / name$ / Object$2.【强制】 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。反例： DaZhePromotion 打折 / getPingf

4、enByName() 评分 / int 某变量 = 3正例： alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。3.【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO 等。正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion4.【强制】方法名、参数名、成员变量

5、、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。正例： localValue / getHttpMessage() / inputUserId5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。正例： MAX_STOCK_COUNT反例： MAX_COUNT6.【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。7.【强制】中括号是数组类型的一部分，数组定义如下：String args;反例：使用 String args的方式

6、来定义。8.【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。反例：定义为基本数据类型 Boolean isSuccess；的属性，它的方法也是 isSuccess()，RPC 框架在反向解析的时候， “以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。9.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。正例： 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils（此规则参考spring 的框架结构）10

7、.【 强制】杜绝完全不规范的缩写，避免望文不知义。反例： AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。11.【 推荐】如果使用到了设计模式，建议在类名中体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范正例：public class OrderFactory;public class LoginProxy;public class ResourceObserver

8、;12.【 推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加） ，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。正例：接口方法签名：void f();接口基础常量表示：String COMPANY = “alibaba“;反例：接口方法定义：public abstract void f();说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。13.接口和实现类的命名有两套规则：1） 【 强制】对于 Service 和 DA

9、O 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。正例：CacheServiceImpl 实现 CacheService 接口。2） 【 推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是able 的形式） 。正例：AbstractTranslator 实现 Translatable。14.【 参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。正例：枚举名字：DealStatusEnum，成员名称：SUCCESS / UNKOWN_REAS

10、ON。15.【 参考】各层命名规约：A) Service/DAO 层方法命名规约1） 获取单个对象的方法用 get 做前缀。2） 获取多个对象的方法用 list 做前缀。3） 获取统计值的方法用 count 做前缀。4） 插入的方法用 save（推荐）或 insert 做前缀。5） 删除的方法用 remove（推荐）或 delete 做前缀。6） 修改的方法用 update 做前缀。B) 领域模型命名规约1） 数据对象：xxxDO，xxx 即为数据表名。2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。3） 展示对象：xxxVO，xxx 一般为网页名称。4） POJO 是 DO/

11、DTO/BO/VO 的统称，禁止命名成 xxxPOJO。本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范(二)常量定义1.【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。反例： String key = “Id#taobao_“+tradeId；cache.put(key, value);2.【强制】long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字1 混淆，造成误解。说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?3.【推荐】不要使用一个常量类维护所

12、有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts 下；系统配置相关的常量放在类： ConfigConsts下。说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。4.【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。2） 应用内共享常量：放置在一方库的 modules 中的 constant 目录下。反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义

13、了表示“是”的变量：类 A 中： public static final String YES = “yes“;类 B 中：public static final String YES = “y“;A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致产生线上问题。3） 子工程内部共享常量：即在当前子工程的 constant 目录下。4） 包内共享常量：即在当前包下单独的 constant 目录下。5） 类内共享常量：直接在类内部 private static final 定义。5.【推荐】如果变量值仅在一个范围内变化用 Enum 类。如果还带有名称之外的延伸

14、属性，必须使用 Enum 类，下面正例中的数字就是延伸信息，表示星期几。(三)格式规约1.【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成即可，不需要换行；如果是非空代码块则：1） 左大括号前不换行。2） 左大括号后换行。3） 右大括号前换行。4） 右大括号后还有 else 等代码则不换行；表示终止右大括号后必须换行。2.【强制】 左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。详见第 5 条下方正例提示。3.【强制】if/for/while/switch/do 等保留字与左右括号之间都必须加空格。4.【强制】任何运算符左右必须加一个空格。说明：运算符包括

15、赋值运算符=、逻辑运算符/超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点符号一起换行sb.append(“zi“).append(“xin“).append(“huang“).append(“huang“).append(“huang“);反例：StringBuffer sb = new StringBuffer();/超过 120 个字符的情况下，不要在括号前换行sb.append(“zi“).append(“xin“).append(“huang“);/参数很多的方法调用可能超过 120 个字符，不要在逗号前换行method(args1, args2, args3, .

16、, argsX);7.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。正例：下例中实参的“a“,后边必须要有一个空格。method(“a“, “b“, “c“);8.【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 windows 格式。9.【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。10.【 推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。说明：没有必要插入多行空格进行隔开。(四)OOP

17、规约1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。2.【强制】所有的覆写方法，必须加Override 注解。反例：getObject() 与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范3.【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。说明：可变参数

18、必须放置在参数列表的最后。 （提倡同学们尽量不用可变参数编程）正例：public User getUsers(String type, Integer. ids)4.【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。5.【强制】不能使用过时的类或方法。说明：.URLDecoder 中的方法 decode(StringencodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，

19、那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。6.【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。正例： “test“.equals(object);反例： object.equals(“test“);说明：推荐使用 java.util.Objects#equals （JDK7 引入的工具类）7.【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。说明：对于 Integer var = ?在-128 至 127 之间的赋值，Integer 对象是在IntegerCach

20、e.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用=进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。8.关于基本数据类型与包装数据类型的使用标准如下：1） 【强制】所有的 POJO 类属性必须使用包装数据类型。2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。3） 【推荐】所有的局部变量使用基本数据类型。说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。正例：数据库的查询结果可能是 null，

21、因为自动拆箱，用基本数据类型接收有 NPE 风险。反例：比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。9.【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。反例：POJO 类的 gmtCreate 默认值为 new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。10.【 强制】序列化类新增属性时，

22、请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。11.【 强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。12.【 强制】POJO 类必须写 toString 方法。使用 IDE 的中工具：sourcegenerate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。说明：在方法执行抛出异常时，可以直接调用 POJO 的 t

23、oString()方法打印其属性值，便于排查问题。本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范13.【 推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。说明：String str = “a,b,c,“;String ary = str.split(“,“);/预期大于 3，结果是 3System.out.println(ary.length);14.【 推荐】当一个类有多个构造方法，或者多个同名方法，这些方

24、法应该按顺序放置在一起，便于阅读。15.【 推荐】 类内方法定义顺序依次是：公有方法或保护方法 私有方法 getter/setter 方法。说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为方法信息价值较低，所有 Service 和 DAO 的 getter/setter方法放在类体最后。16.【 推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在 getter/setter 方法中，尽量不要增加业务逻辑，增加排查问题的难度。

25、反例：public Integer getData() if (true) return data + 100; else return data - 100;17.【 推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。反例：String str = “start“;for (int I = 0; I list = new ArrayList(2);list.add(“guan“);list.add(“bao“);String array = new Stringlist.size();array = list.toArray(array);反

26、例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object类，若强转其它类型数组将出现 ClassCastException 错误。5.【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。说明：本文取自阿里 JAVA 编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的

27、是适配器模式，只是转换接口，后台的数据仍是数组。String str = new String “a“, “b“ ;List list = Arrays.asList(str);第一种情况：list.add(“c“); 运行时异常。第二种情况：str0 = “gujin“; 那么 list.get(0)也会随之修改。6.【强制】泛型通配符来接收返回的数据，此写法的泛型集合不能使用 add 方法，而不能使用 get 方法，做为接口调用赋值时易出错。说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：1 ）频繁往外读取内容的，适合用上界 Extends

28、。2 ）经常往里插入的，适合用下界 Super。7.【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。8.【强制】 在 JDK7 版本及以上，Comparator 要满足如下三个条件，不然 Arrays.sort，Collections.sort 会报 IllegalArgumentException 异常。9.【推荐】集合初始化时，尽量指定集合初始值大小。说明：ArrayList 尽量使用 ArrayList(int initialCapacity) 初始化。10.

29、【 推荐】使用 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 值组合集合。11.【 推荐】高度

30、注意 Map 类集合 K/V 能不能存储 null 值的情况，反例： 由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，注意存储 null 值时会抛出 NPE 异常。12.【 参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是 order/

31、sort。13.【 参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。(六)并发处理1.【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。说明：资源驱动类、工具类、单例工厂类都需要注意。2.【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。正例：public class TimerTaskThread extends Thread public TimerTaskThread() super.setName(“TimerTaskThread“); .本文取自阿里 JAVA

32、编码规范手册不得用于商业规范本文取自阿里 JAVA 编码规范手册不得用于商业规范3.【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。4.【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。说明：Executors 返回的线程池对象的弊端如下：1） FixedThrea

33、dPool 和 SingleThreadPool:允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。2） CachedThreadPool 和 ScheduledThreadPool:允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。5.【强制】SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static，必须加锁，或者使用 DateUtils 工具类。正例：注意线程安全，使用 DateUtils。亦推荐如下处理：private static fi

34、nal ThreadLocal df = new ThreadLocal() Overrideprotected DateFormat initialValue() return new SimpleDateFormat(“yyyy-MM-dd“);说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，DateTimeFormatter 代替 Simpledateformatter，官方给出的解释： simplebeautifulstrongimmutable thread-safe。6.【强制】高并发时，同步调用应该去考

35、量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。7.【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。说明：线程一需要对表 A、 B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A、B 、C，否则可能出现死锁。8.【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。9.【强制】多

36、线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。10.【 推荐】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown 方法，线程执行代码注意 catch 异常，确保 countDown 方法可以执行，避免主线程无法执行至 await 方法，直到超时才返回结果。说明：注意，子线程抛出异常堆栈，不能在主线程 try-catch 到。11.【 推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因