Java开发手册
2020-12-22 15:21:14 1 举报AI智能生成
Alibaba-Java规范总结
作者其他创作
大纲/内容
一、编程规约
1.命名风格
1.【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
3.【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外:DO / BO / DTO / VO / AO
4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式。
5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
6.【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始，以 Test 结尾。
7.【强制】中括号是数组类型的一部分，数组定义如下:String[] args;
8，【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。
9.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用。
10.【强制】杜绝完全不规范的缩写，避免望文不知义。
11.【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词 组合来表达其意。
12.【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
13.【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简洁 性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是 与接口方法相关，并且是整个应用的基础常量。
14.接口和实现类的命名有两套规则
【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部
的实现类用 Impl 的后缀与接口区别。
的实现类用 Impl 的后缀与接口区别。
【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名(通常是–able 的形式)。
15.【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
16.【参考】各层命名规约
2.常量定义
【强制】不允许任何魔法值(即未经定义的常量)直接出现在代码中。
【强制】long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字1混淆，造成误解。
【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。
【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。
【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。下面 正例中的数字就是延伸信息，表示星期几。
3.代码格式
【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行;如果 是非空代码块则:
【强制】 左小括号和字符之间不出现空格;同样，右小括号和字符之间也不出现空格。
【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
【强制】任何二目、三目运算符的左右两边都需要加一个空格。
【强制】采用 4 个空格缩进，禁止使用 tab 字符。
【强制】注释的双斜线与注释内容之间有且仅有一个空格。
【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则:
【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式， 不要使用 Windows 格式。
【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义 之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
4.OOP规约
【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成
本，直接用类名来访问即可。
本，直接用类名来访问即可。
【强制】所有的覆写方法，必须加@Override 注解。
【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。
【强制】外部正在调用或者二方库依赖的接口
【强制】不能使用过时的类或方法。
【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。
【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。
关于基本数据类型与包装数据类型的使用标准如下:
【强制】所有的POJO类属性必须使用包装数据类型。
【强制】RPC方法的返回值和参数必须使用包装数据类型。
【推荐】所有的局部变量使用基本数据类型。
【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败;如 果完全不兼容升级，
避免反序列化混乱，那么请修改 serialVersionUID 值。
避免反序列化混乱，那么请修改 serialVersionUID 值。
【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
【强制】POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString
时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。
时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。
【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无
内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。
【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，
便于阅读，此条规则优先于第 15 条规则。
便于阅读，此条规则优先于第 15 条规则。
【推荐】 类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。
【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在
getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。
【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字:
【推荐】慎用 Object 的 clone 方法来拷贝对象。
【推荐】类成员与方法访问控制从严:
5.集合处理
【强制】关于 hashCode 和 equals 的处理，遵循如下规则:
1) 只要重写equals，就必须重写hashCode。
2) 因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的 对象必须重写这两个方法。
3) 如果自定义对象做为Map的键，那么必须重写hashCode和equals。
【强制】ArrayList的subList结果不可强转成ArrayList
【强制】在 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、
增加、 删除均会产生ConcurrentModificationException 异常。
增加、 删除均会产生ConcurrentModificationException 异常。
【强制】使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完
全 一样的数组，大小就是 list.size()。
全 一样的数组，大小就是 list.size()。
【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方
法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方
法，而<? super T>不能使用get方法，做为接口调用赋值时易出错。
法，而<? super T>不能使用get方法，做为接口调用赋值时易出错。
【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用
Iterator方式，如果并发操作，需要对 Iterator 对象加锁。
Iterator方式，如果并发操作，需要对 Iterator 对象加锁。
【强制】 在 JDK7 版本及以上，Comparator 要满足如下三个条件，不然 Arrays.sort，
Collections.sort 会报 IllegalArgumentException 异常。
Collections.sort 会报 IllegalArgumentException 异常。
【推荐】集合初始化时，指定集合初始值大小。
【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。
【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况
【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序
性(unsort)和 不稳定性(unorder)带来的负面影响。
性(unsort)和 不稳定性(unorder)带来的负面影响。
【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的
contains 方法进行遍历、对比、去重操作。
6.并发处理
【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样
的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
【强制】SimpleDateFormat 是线程不安全的类，一般不要定义为static变量，如果定义为
static，必须加锁，或者使用 DateUtils 工具类。
【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁;能
锁区块，就不要锁整个方法体;能用对象锁，就不要用类锁。
【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造 成死锁。
【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加 锁，
要么在数据库层使用乐观锁，使用 version 作为更新依据。
要么在数据库层使用乐观锁，使用 version 作为更新依据。
【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获
抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。
抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。
【推荐】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown
方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行
至 await 方法，直到超时才返回结果。
方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行
至 await 方法，直到超时才返回结果。
【推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一 seed 导致的性能下降。
【推荐】在并发场景下，通过双重检查锁(double-checked locking)实现延迟初始化的优
化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解
决方案中较为简单一种(适用于 JDK5 及以上版本)，将目标属性声明为 volatile 型。
化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解
决方案中较为简单一种(适用于 JDK5 及以上版本)，将目标属性声明为 volatile 型。
【参考】volatile 解决多线程内存不可见问题。
【参考】 HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在
开发过程中可以使用其它数据结构或加锁来规避此风险。
开发过程中可以使用其它数据结构或加锁来规避此风险。
【参考】ThreadLocal 无法解决共享对象的更新问题
7.控制语句
【强制】在一个 switch 块内，都必须包含一个 default 语句并且 放在最后，即使它什么代码也没有。
【强制】在 if/else/for/while/do 语句中必须使用大括号。
【推荐】表达异常的分支时，少用 if-else 方式.
【推荐】除常用方法(如 getXxx/isXxx)等外，不要在条件判断中执行其它复杂的语句，将复
杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
【推荐】循环体中的语句要考量性能
【推荐】接口入参保护，这种场景常见的是用于做批量操作的接口。
【参考】下列情形，需要进行参数校验:
1) 调用频次低的方法。
2) 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参
数错误导致中间执行回退，或者错误，那得不偿失。
3) 需要极高稳定性和可用性的方法。
4) 对外提供的开放接口，不管是RPC/API/HTTP接口。
5) 敏感权限入口。
【参考】下列情形，不需要进行参数校验:
1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2) 底层调用频度比较高的方法。
3) 被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参 数已经做过检查或者肯定不会有问题，此时可以不校验参数。
8.注释规约
【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用 // xxx方式。
【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、
异常说明外，还必须指出该方法做什么事情，实现什么功能。
异常说明外，还必须指出该方法做什么事情，实现什么功能。
【强制】所有的类都必须添加创建者和创建日期。
【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释
使用/* */注释，注意与代码对齐。
【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持 英文原文即可。
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑 等的修改。
【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
【参考】对于注释的要求:
1.能够准确反应设计思想和代码逻辑;
2.能够描述业务含 义，使别的程序员能够迅速了解到代码背后的信息。
【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的
一个极端:过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，
经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
9.其他
【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
【强制】velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可。
【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。
【强制】注意 Math.random() 这个方法返回是 double 类型。
【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
【推荐】不要在视图模板中加入任何复杂的逻辑。
【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
【推荐】及时清理不再使用的代码段或配置信息。
三、单元测试
【强制】好的单元测试必须遵守 AIR 原则。
【强制】单元测试应该是全自动执行的，并且非交互式的。
【强制】保持单元测试的独立性。
【强制】单元测试是可以重复执行的，不能受到外界环境的影响。
【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。
【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
【强制】单元测试代码必须写在如下工程目录:src/test/java，不允许写在业务代码目录下。
【推荐】单元测试的基本目标:语句覆盖率达到 70%;核心模块的语句覆盖率和分支覆盖率都 要达到 100%
【推荐】编写单元测试代码遵守 BCDE 原则，以保证被测试模块的交付质量。
B:Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
C:Correct，正确的输入，并得到预期的结果。
D:Design，与设计文档相结合，来编写单元测试。
E:Error，强制错误信息输入(如:非法数据、异常流程、非业务允许输入等)，并得 到预期的结果。
【推荐】对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，
或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
【推荐】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者
对单元测试产生的数据有明确的前后缀标识。
对单元测试产生的数据有明确的前后缀标识。
【推荐】对于不可测的代码建议做必要的重构，使代码变得可测，避免为了达到测试要求而 书写不规范测试代码。
【推荐】在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好 覆盖所有测试用例(UC)。
【推荐】单元测试作为一种质量保障手段，不建议项目发布后补充单元测试用例，建议在项 目提测前完成单元测试。
【参考】为了更方便地进行单元测试，业务代码应避免以下情况:
构造方法中做的事情过多。
存在过多的全局变量和静态方法。
存在过多的外部依赖。
存在过多的条件语句。
【参考】不要对单元测试存在如下误解:
那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。
单元测试代码是多余的。汽车的整体功能与各单元部件的测试正常与否是强相关的。
单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。
单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。
五、MySQL数据库
1.建表规约
【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint ( 1表示是，0表示否)。
【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只 出现数字。
【强制】表名不使用复数名词。
【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。
【强制】主键索引名为 pk_字段名;唯一索引名为 uk_字段名;普通索引名则为 idx_字段名。
【强制】小数类型为 decimal，禁止使用 float 和 double。
【强制】如果存储的字符串长度几乎相等，使用 char 定长字符串类型。
【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长
度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索
引效率。
度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索
引效率。
【强制】表必备三字段:id, gmt_create, gmt_modified。
【推荐】表的命名最好是加上“业务名称_表的作用”。
【推荐】库名与应用名称尽量一致。
【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循:
【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检 索速度。
2.索引规约
【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
【强制】超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致;多表关联查询时， 保证被关联的字段需要有索引。
【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据 实际文本区分度决定索引长度即可。
【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合
索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
【推荐】利用覆盖索引来进行查询操作，避免回表。
【推荐】利用延迟关联或者子查询优化超多分页场景。
【推荐】SQL 性能优化的目标:至少要达到 range 级别，要求是 ref 级别，如果可以是 consts 最好。
【推荐】建组合索引的时候，区分度最高的在最左边。
【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。
【参考】创建索引时避免有如下极端误解:
3.SQL语句
【强制】不要使用 count(列名)或 count(常量)来替代 count(*)。
【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinct
col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
【强制】当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为
NULL，因此使用 sum()时需注意 NPE 问题。
NULL，因此使用 sum()时需注意 NPE 问题。
【强制】使用 ISNULL()来判断是否为 NULL 值。
【强制】 在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控
制在 1000 个之内。
【参考】如果有全球化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数 的区别。
【参考】开发中 尽可能不要使用 TRUNCATE TABLE
4.ORM映射
【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行 字段与属性之间的映射。
【强制】不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需
要定义;反过来，每一个表也必然有一个与之对应。
要定义;反过来，每一个表也必然有一个与之对应。
【强制】sql.xml 配置参数使用:#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
【强制】iBATIS自带的queryForList(String statementName,int start,int size)不推 荐使用。
【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。
【推荐】不要写一个大而全的数据更新接口。
【参考】@Transactional 事务不要滥用。
【参考】<isEqual>中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带
上此条件;<isNotEmpty>表示不为空且不为 null 时执行;<isNotNull>表示不为 null 值时 执行。
上此条件;<isNotEmpty>表示不为空且不为 null 时执行;<isNotNull>表示不为 null 值时 执行。
二、异常日志
1.异常处理
【强制】Java 类库中定义的一类 RuntimeException 可以通过预先检查进行规避。
【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
【强制】对大段代码进行 try-catch，这是不负责任的表现。
【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请 将该异常抛给它的调用者。
【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回 滚事务。
【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
【强制】不能在 finally 块中使用 return，finally 块中的 return 返回后方法结束执行，不
会再执行 try 块中的 return 语句。
会再执行 try 块中的 return 语句。
【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分
说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。
说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。
【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景:
1)返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。
2) 数据库的查询结果可能为null。
3) 集合里的元素即使isNotEmpty，取出的数据元素也可能为null。
4) 远程调用返回对象时，一律要求进行空指针判断，防止NPE。
5) 对于Session中获取的数据，建议NPE检查，避免空指针。
6) 级联调用obj.getA().getB().getC();一连串调用，易产生NPE。
【推荐】定义时区分unchecked/checked 异常，避免直接抛出newRuntimeException()，
更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义
过的自定义异常，如:DAOException / ServiceException等。
更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义
过的自定义异常，如:DAOException / ServiceException等。
【参考】避免出现重复的代码(Don’t Repeat Yourself)，即DRY原则。
2.日志规约
【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API。
【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。
【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
appName_stats_logName.log。
appName_desc_logName.log。
appName_monitor_logName.log。
appName_visit_logName.log。
【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理，那么通过 关键字 throws 往上抛出。
【推荐】谨慎地记录日志。
【参考】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适 从。
四、安全规约
【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。
【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。
【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，
禁止字符串拼接 SQL 访问数据库。
禁止字符串拼接 SQL 访问数据库。
【强制】用户请求传入的任何参数必须做有效性验证。
【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。
【强制】表单、AJAX 提交必须执行 CSRF 安全过滤。
【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放限制，
如数量限制、疲劳度控制、验证码校验，避免被滥刷、资损。
如数量限制、疲劳度控制、验证码校验，避免被滥刷、资损。
【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过 滤等风控策略。
六、工程结构
1.应用分层
【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖。
【参考】分层异常处理规约
【参考】分层领域模型规约:
DO(Data Object):与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
DTO(Data Transfer Object):数据传输对象，Service 或 Manager 向外传输的对象。
BO(Business Object):业务对象。由 Service 层输出的封装业务逻辑的对象。
AO(ApplicationObject):应用对象。在Web层与Service层之间抽象的复用对象模型，
极为贴近展示层，复用度不高。
极为贴近展示层，复用度不高。
VO(View Object):显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
Query:数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止
使用 Map 类来传输。
2.二方库依赖
【强制】定义 GAV 遵从以下规则:
1) GroupID格式:com.{公司/BU }.业务线.[子业务线]，最多4级。
2) ArtifactID格式:产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
3) Version:详细规定参考下方。
【强制】二方库版本号命名方式:主版本号.次版本号.修订号
【强制】线上应用不要依赖 SNAPSHOT 版本(安全包除外)。
【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。
【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚
举类型或者包含枚举类型的 POJO 对象。
举类型或者包含枚举类型的 POJO 对象。
【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的 Version。
【推荐】所有 pom 文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在 <dependencyManagement>语句块中。
【推荐】二方库不要有配置项，最低限度不要再增加配置项。
【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则:
精简可控原则
稳定可追溯原则
3.服务器
【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。
【推荐】调大服务器所支持的最大文件句柄数(File Descriptor，简写为fd)。
【推荐】给 JVM 设置-XX:+HeapDumpOnOutOfMemoryError 参数，让 JVM 碰到 OOM 场景时输出 dump 信息。
【推荐】在线上生产环境，JVM的Xms和Xmx设置一样大小的内存容量，避免在GC 后调整堆 大小带来的压力。
【参考】服务器内部重定向使用 forward;外部重定向地址使用 URL 拼装工具类来生成，否则 会带来 URL
维护不一致的问题和潜在的安全风险。
维护不一致的问题和潜在的安全风险。
0 条评论
下一页
