《Java开发手册V1.7.1（黄山版）.docx》由会员分享，可在线阅读，更多相关《Java开发手册V1.7.1（黄山版）.docx（52页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、Java 开发手册（黄山版）目录一、编程规约1(一) 命名风格1(二) 常量定义3(三) 代码格式4(四) OOP 规约6(五) 日期时间9(六) 集合处理10(七) 并发处理14(八) 控制语句17(九) 注释规约20(十) 前后端规约21(十一) 其他23二、异常日志24(一) 错误码24(二) 异常处理25(三) 日志规约26三、单元测试29四、安全规约31五、MySQL 数据库32(一) 建表规约32(二) 索引规约33(三) SQL 语句34(四) ORM 映射35六、工程结构37(一) 应用分层37(二) 二方库依赖38(三) 服务器39七、设计规约40附 1：版本历史42附 2：
2、专有名词解释44附 3：错误码列表45 Java 开发手册（黄山版）版本号制定团队更新日期备注1.7.1全球 Java 社区开发者2022.02.03黄山版，新增 11 条新规约。一、编程规约(一) 命名风格1. 【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反 例 ：_name / name / $Object / name_ / name$ / Object$2. 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。正例：a
3、li / alibaba / taobao / kaikeba / aliyun / youku / hangzhou 等国际通用的名称，可视同英文。反例：DaZhePromotion【打折】/ getPingfenByName()【评分】 / String fw【福娃】/ int 变量名 = 33. 【强制】代码和注释中都要避免使用任何人类语言中的种族歧视性或侮辱性词语。正例：blockList / allowList / secondary反例：blackList / whiteList / slave / SB / WTF4. 【强制】类名使用 UpperCamelCase 风格，以下情
4、形例外：DO / PO / DTO / BO / VO / UID 等。正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion5. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。正例：localValue / getHttpMessage() / inputUserId6. 【强制】常量命名应该全部大写，单词间用下划线隔开，
5、力求语义表达完整清楚，不要嫌名字长。正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME反例：MAX_COUNT / EXPIRED_TIME7. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾，测试类命名以它要测试的类的名称开始，以 Test 结尾。8. 【强制】类型与中括号紧挨相连来定义数组。正例：定义整形数组 int arrayDemo。反例：在 main 参数中，使用 String args 来定义。9. 【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
6、说明：本文 MySQL 规约中的建表约定第 1 条，表达是与否的变量采用 is_xxx 的命名方式，所以需要在 设置从 is_xxx 到 xxx 的映射关系。反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析时，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。10. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。正例：应用工具类包名为 com.alibaba.ei.kunlun.aap.util；类名为
7、MessageUtils（此规则参考 spring 的框架结构）。11. 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。39/51 说明：子类、父类成员变量名相同，即使是 public 也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter / getter 的参数名称也要避免与成员变量名称相同。反例：public class ConfusingName protected int stock; protected String alibaba;/ 非 setter/getter 的参数名
8、称，不允许与本类成员变量同名public void access(String alibaba) if (condition) final int money = 666;/ .for (int i = 0; i 10; i+) / 在同一方法体中，不允许与其它代码块中的 money 命名相同final int money = 15978;/ .class Son extends ConfusingName / 不允许与父类的成员变量名称相同private int stock;12. 【强制】杜绝完全不规范的英文缩写，避免望文不知义。反例：AbstractClass“缩写”成 AbsClass
9、；condition“缩写”成 condi；Function“缩写”成 Fu，此类随意缩写严重降低了代码的可阅读性。13. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用完整的单词组合来表达。正例：在 JDK 中，对某个对象引用的 volatile 字段进行原子更新的类名为 AtomicReferenceFieldUpdater。反例：常见的方法内变量为 int a; 的定义方式。14. 【推荐】在常量与变量命名时，表示类型的名词放在词尾，以提升辨识度。正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
10、反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD15. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时要体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。正例： public class OrderFactory;public class LoginProxy;public class ResourceObserver;16. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义常量
11、，如果一定要定义，最好确定该常量与接口的方法相关，并且是整个应用的基础常量。正例：接口方法签名 void commit();接口基础常量 String COMPANY = alibaba;反例：接口方法定义 public abstract void commit();说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。17. 接口和实现类的命名有两套规则：1） 【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。正例：CacheServiceImpl 实现
12、CacheService 接口。2） 【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是 able 结尾的形容词） 。正例：AbstractTranslator 实现 Translatable。18. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON19. 【参考】各层命名规约：A） Service / DAO 层方法命名规约：1） 获取单个对象的方法用 get 做前缀。2）
13、 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects 3）获取统计值的方法用 count 做前缀。4）插入的方法用 save / insert 做前缀。5）删除的方法用 remove / delete 做前缀。6）修改的方法用 update 做前缀。B） 领域模型命名规约： 1）数据对象：xxxDO，xxx 即为数据表名。2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。3） 展示对象：xxxVO，xxx 一般为网页名称。4） POJO 是 DO / DTO / BO / VO 的统称，禁止命名成 xxxPOJO。(二) 常量定义1. 【强制】不允许任何
14、魔法值（即未经预先定义的常量）直接出现在代码中。反例：/ 开发者 A 定义了缓存的 key。String key = Id#taobao_ + tradeId; cache.put(key, value);/ 开发者 B 使用缓存时直接复制少了下划线，即 key 是Id#taobao + tradeId，导致出现故障。String key = Id#taobao + tradeId;cache.get(key);2. 【强制】long 或 Long 赋值时，数值后使用大写 L，不能是小写 l，小写容易跟数字混淆，造成误解。说明：public static final Long NUM = 2l
15、; 写的是数字的 21，还是 Long 型的 2？3. 【强制】浮点数类型的数值后缀统一为大写的 D 或 F。正例：public static final double HEIGHT = 175.5D; public static final float WEIGHT = 150.3F;4. 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到要修改的常量，不利于理解，也不利于维护。正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 SystemConfigConsts 下。5. 【推荐】常量的
16、复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。2） 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。反例：易懂常量也要统一定义成应用内共享常量，两个程序员在两个类中分别定义了表示“是”的常量： 类 A 中：public static final String YES = yes;类 B 中：public static final String YES = y;A.YES.equals(B.YES)，预期是 true，但实
17、际返回为 false，导致线上问题。3）子工程内部共享常量：即在当前子工程的 constant 目录下。4） 包内共享常量：即在当前包下单独的 constant 目录下。5） 类内共享常量：直接在类内部 private static final 定义。6. 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。说明：如果存在名称之外的延伸属性应使用 enum 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例：public enum SeasonEnum SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);private int se
18、q; SeasonEnum(int seq) this.seq = seq;public int getSeq() return seq;(三) 代码格式1. 【强制】如果大括号内为空，简洁地写成即可，大括号中间无需换行和空格；如果是非空代码块，则：1） 左大括号前不换行。2） 左大括号后换行。3） 右大括号前换行。4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。2. 【强制】左小括号和右边相邻字符之间不需要空格；右小括号和左边相邻字符之间也不需要空格；而左大括号前需要加空格。详见第 5 条下方正例提示。反例：if(空格 a = b 空格)3. 【强制】if /
19、for / while / switch / do 等保留字与左右括号之间都必须加空格。4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。说明：包括赋值运算符 =、逻辑运算符 &、加减乘除符号等。5. 【强制】采用 4 个空格缩进，禁止使用 Tab 字符。说明：如使用 Tab 缩进，必须设置 1 个 Tab 为 4 个空格。IDEA 设置 Tab 为 4 个空格时，请勿勾选 Use tab character； 而在 Eclipse 中，必须勾选 insert spaces for tabs。正例：（涉及上述中的 1-5 点）public static void main(Stri
20、ng args) / 缩进 4 个空格String say = hello;/ 运算符的左右必须有一个空格int flag = 0;/ 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格if (flag = 0) System.out.println(say);/ 左大括号前加空格且不换行；左大括号后换行if (flag = 1) System.out.println(world);/ 右大括号前换行，右大括号后有 else，不用换行 else System.out.println(ok);/ 在右大括号后直接结束，则必须换行6. 【强制】注释的双斜线与注释
21、内容之间有且仅有一个空格。正例：/ 这是示例注释，请注意在双斜线之后有一个空格String commentString = new String(demo);7. 【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。正例：double first = 3.2D;int second = (int)first + 2;8. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。2） 运算符与下文一起换行。3） 方法调用的点符号与下文一起换行。4） 方法调用中的多个参数需要换行时
22、，在逗号后进行。5） 在括号前不要换行，见反例。正例：StringBuilder builder = new StringBuilder();/ 超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点号一起换行builder.append(yang).append(hao).append(chen).append(chen).append(chen);反例：StringBuilder builder = new StringBuilder();/ 超过 120 个字符的情况下，不要在括号前换行builder.append(you).append(are).append (lucky
23、);/ 参数很多的方法调用可能超过 120 个字符，逗号后才是换行处method(args1, args2, args3, ., argsX);9. 【强制】方法参数在定义和传入时，多个参数逗号后面必须加空格。正例：下例中实参的 args1 逗号后边必须要有一个空格。method(args1, args2, args3);10. 【强制】IDE 的text file encoding 设置为UTF-8；IDE 中文件的换行符使用Unix 格式，不要使用Windows 格式。11. 【推荐】单个方法的总行数不超过 80 行。说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可
24、见字符的总行数不超过 80 行。正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加晰；共性逻辑抽取成为共性方法，便于复用和维护。12. 【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。正例：int one = 1; long two = 2L; float three = 3F;StringBuilder builder = new StringBuilder();说明：增加 builder 这个变量，如果需要对齐，则给 one、two、three 都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。13. 【推荐】不同逻辑、
25、不同语义、不同业务的代码之间插入一个空行，分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开。(四) OOP 规约1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。2. 【强制】所有的覆写方法，必须加 Override 注解。说明：getObject() 与 get0bject() 的问题。一个是字母的 O，一个是数字的 0，加 Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。3. 【强制】相同参数类型，相同业务含义，才可以使用的可变参数，参数类型避免定义
26、为 Object。说明：可变参数必须放置在参数列表的最后。（建议开发者尽量不用可变参数编程） 正例：public List listUsers(String type, Long. ids) .4. 【强制】外部正在调用的接口或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加 Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。5. 【强制】不能使用过时的类或方法。说明：.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数decode(String source, String e
27、ncode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。6. 【强制】Object 的equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。正例：test.equals(param); 反例：param.equals(test);说明：推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b)7. 【强制】所有整型包装类对象之间值的比较，全部使用 equals 方法比较。说明：对于 Integer var = ? 在 -128 至 12
28、7 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用 = 进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。8. 【强制】任何货币金额，均以最小货币单位且为整型类型进行存储。9.【强制】浮点数之间的等值判断，基本数据类型不能使用 = 进行比较，包装数据类型不能使用equals进行判断。说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考码出
29、高效。反例：float a = 1.0F - 0.9F; float b = 0.9F - 0.8F; if (a = b) / 预期进入此代码块，执行其它业务逻辑/ 但事实上 a = b 的结果为 falseFloat x = Float.valueOf(a); Float y = Float.valueOf(b); if (x.equals(y) / 预期进入此代码块，执行其它业务逻辑/ 但事实上 equals 的结果为 false正例：(1) 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。float a = 1.0F - 0.9F;float b = 0.9F - 0.
30、8F; float diff = 1e-6F;if (Math.abs(a - b) generate toString 时，如果继承了另一个POJO 类，注意在前面加一下super.toString()。说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString() 方法打印其属性值，便于排查问题。18. 【强制】禁止在POJO 类中，同时存在对应属性 xxx 的 isXxx() 和 getXxx() 方法。说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到，神坑之一。19. 【推荐】使用索引访问用String 的split 方法得到的数组时，需做
31、最后一个分隔符后有无内容的检查， 否则会有抛 IndexOutOfBoundsException 的风险。说明：String str = a,b,c,;String ary = str.split(,);/ 预 期 大 于 3， 结 果 等 于 3 System.out.println(ary.length);20. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读， 此条规则优先于下一条。正例：public int method(int param);protected double method(int param1, int param2); pr
32、ivate void method();21. 【推荐】类内方法定义的顺序依次是：公有方法或保护方法 私有方法 getter / setter 方法。说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有Service 和 DAO 的 getter / setter 方法放在类体最后。22. 【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在 getter / setter 方法中，不要增加业务逻辑，增加排查
33、问题的难度。反例：public Integer getData() if (condition) return this.data + 100; else return this.data - 100;23. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。反例：String str = start;for (int i = 0; i 100; i+) str = str + hello;说明：反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过toString()
34、返回 String 对象，造成内存资源浪费。24. 【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：1） 不允许被继承的类，如：String 类。2） 不允许修改引用的域对象，如：POJO 类的域变量。3） 不允许被覆写的方法，如：POJO 类的 setter 方法。4） 不允许运行过程中重新赋值的局部变量。5） 避免上下文重复使用一个变量，使用 final 关键字可以强制重新定义一个变量，方便更好地进行重构。25. 【推荐】慎用Object 的 clone 方法来拷贝对象。说明：对象 clone 方法默认是浅拷贝，若想实现深拷贝需覆写 clon
35、e 方法实现域对象的深度遍历式拷贝。26. 【推荐】类成员与方法访问控制从严：1）如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。2）工具类不允许有 public 或 default 构造方法。3）类非 static 成员变量并且与子类共享，必须是 protected。4）类非 static 成员变量并且仅在本类使用，必须是 private。5）类 static 成员变量如果仅在本类使用，必须是 private。6）若是 static 成员变量，考虑是否为 final。7） 类成员方法只供类内部调用，必须是 private。8） 类成员方法只对继承类公开，那么限
36、制为 protected。说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果是一个private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗？ 变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。(五) 日期时间1. 【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。说明：日期格式化时，yyyy 表示当天所在的年，而大写的 YYYY 代表是 week in which year（JDK7 之后引入的概念）， 意思是当天所在的周
37、属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 YYYY 就是下一年。正例：表示日期和时间的格式如下所示：new SimpleDateFormat(yyyy-MM-dd HH:mm:ss)反例：某程序员因使用 YYYY/MM/dd 进行日期格式化，2017/12/31 执行结果为 2018/12/31，造成线上故障。2. 【强制】在日期格式中分清楚大写的M 和小写的m，大写的H 和小写的h 分别指代的意义。说明：日期格式中的这两对字母表意如下：1） 表示月份是大写的 M2） 表示分钟则是小写的 m3）24 小时制的是大写的 H4）12 小时制的则是小写的 h3. 【强制】获取当前毫
38、秒数：System.currentTimeMillis()；而不是 new Date().getTime()。说明：获取纳秒级时间，则使用 System.nanoTime 的方式。在JDK8 中，针对统计时间等场景，推荐使用 Instant 类。4. 【强制】不允许在程序任何地方中使用：1）java.sql.Date 2）java.sql.Time 3）java.sql.Timestamp。说明：第 1 个不记录时间，getHours() 抛出异常；第 2 个不记录日期，getYear() 抛出异常；第 3 个在构造方法super(time / 1000) * 1000)，在 Timestam
39、p 属性 fastTime 和 nanos 分别存储秒和纳秒信息。反例：java.util.Date.after(Date) 进行时间比较时，当入参是 java.sql.Timestamp 时，会触发 JDK BUG（JDK9 已修复），可能导致比较时的意外结果。5. 【强制】禁止在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误。正例：/ 获取今年的天数int daysOfThisYear = LocalDate.now().lengthOfYear();/ 获取指定某年的天数LocalDate.of(2011, 1, 1).lengthOfYear();反例：/
40、 第一种情况：在闰年 366 天时，出现数组越界异常int dayArray = new int365;/ 第二种情况：一年有效期的会员制，2020 年 1 月 26 日注册，硬编码 365 返回的却是 2021 年 1 月 25 日Calendar calendar = Calendar.getInstance(); calendar.set(2020, 1, 26);calendar.add(Calendar.DATE, 365);6. 【推荐】避免公历闰年 2 月问题。闰年的 2 月份有 29 天，一年后的那一天不可能是 2 月 29 日。7. 【推荐】使用枚举值来指代月份。如果使用数字，注意 Date，Calendar 等日期相关类的月份 month 取值范围从 0 到 11 之间。说明：参考 JDK 原生注释，Month value is 0-based. e.g., 0 for January.正例：Calendar.JANUARY，Calendar.FEBRUARY，Calendar.MARCH 等来指代相应月份来进行传参或比较。(六) 集合处理1. 【强制】