开发规范

最近在coding的时候发现很多类和变量的命名都不是很规范，然后想着自己也刚工作大半年，还是应该要从开始就养成比较好的编码习惯，所以这里参考阿里的开发规范，从中选取一些自己认为重要的，或者自己犯过错的，亦或自己认为会经常使用的来规范自己的代码。内容摘自 https://www.jianshu.com/p/7c8c4a9bdf26

1.命名规约

• 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式，国际通用拼音除外。（碰到不知道翻译的字段真没少用拼音，或者是被遗留系统的代码命名给带偏。。）
• 【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型 的相关命名）DO / DTO / VO / DAO 等。 

• 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

• 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

• 【强制】POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。（涨知识，以前经常对布尔类型变量用is开头） 

• 【强制】杜绝完全不规范的缩写，避免望文不知义。反例：<某业务代码>AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 

  condi，此类随意缩写严重降低了代码的可阅读性。【参考】各层命名规约：  

• 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/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

  2.常量定义

  【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。

• 【强制】long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 const 目录下。 

•  2） 应用内共享常量：放置在一方库的 modules 中的 const 目录下。 

    反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示

  “是”的变量： 

      类 A 中：public static final String YES = "yes"; 

      类 B 中：public static final String YES = "y"; 

      A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致产生线上问题。 

   3） 子工程内部共享常量：即在当前子工程的 const 目录下。 

   4） 包内共享常量：即在当前包下单独的 const 目录下。 

   5） 类内共享常量：直接在类内部 private static final 定义。

  【强制】if/for/while/switch/do 等保留字与左右括号之间都必须加空格。

  OOP 规约 
• 【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。 说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）
• 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

  说明：对于 Integer var=?在-128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache

  产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之

  外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方

  法进行判断。 

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

   1） 所有的 POJO 类属性必须使用包装数据类型。 

   2） RPC 方法的返回值和参数必须使用包装数据类型。 

   3） 所有的局部变量推荐使用基本数据类型。

   正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。 

   反例：某业务的交易报表上显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的

  RPC 服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划

  线-。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。

  【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。 反例：某业务的 DO 的 gmtCreate 默认值为 new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。 

  【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。  

  【强制】POJO 类必须写 toString 方法。使用工具类 source> generate toString 时，如果继

  承了另一个 POJO 类，注意在前面加一下 super.toString。 说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。 

  【推荐】final 可提高程序响应效率，声明成 final 的情况： 

   1） 不需要重新赋值的变量，包括类属性、局部变量。 

   2） 对象参数前加 final，表示不允许修改引用的指向。 

   3） 类方法确定不允许被重写。 

  (五) 集合处理

  【强制】Map/Set 的 key 为自定义对象时，必须重写 hashCode 和 equals。 正例：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。 

  【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全 一样的数组，大小就是 list.size()。

  【强制】使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法， 它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。 

  说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList

  体现的是适配器模式，只是转换接口，后台的数据仍是数组。 

      String[] str = new String[] { "a", "b" }; 

      List list = Arrays.asList(str); 

  第一种情况：list.add("c"); 运行时异常。 

  第二种情况：str[0]= "gujin"; 那么 list.get(0)也会随之修改。

  【推荐】集合初始化时，尽量指定集合初始值大小。 说明：ArrayList 尽量使用 ArrayList(int initialCapacity) 初始化。

  【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。 

  说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key

  所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更

  高。如果是 JDK8，使用 Map.foreach 方法。

  (六) 并发处理

  【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。 

  说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资

  源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者

  “过度切换”的问题。 

  【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能 锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

  【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造 成死锁。 

  说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序

  也必须是 A、B、C，否则可能出现死锁。

  【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，

  但是如果多写，同样无法解决线程安全问题。如果想取回 count++数据，使用如下类实现：

  AtomicInteger count = new AtomicInteger(); count.addAndGet(1); count++操作如果是

  JDK8，推荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

  (七) 控制语句

   

  【推荐】推荐尽量少用 else， if-else 的方式可以改写成： 

  if(condition){   …   return obj;    }   // 接着写 else 的业务逻辑代码;  说明：如果使用要 if-else if-else 方式表达逻辑，【强制】请勿超过 3 层，超过请使用状态

  【推荐】除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行复杂的语句，以提高 可读性。 
  

  【参考】方法中不需要参数校验的场景： 

   1） 极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参

  数检查。 

   2） 底层的方法调用频度都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错

  误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台

  服务器中，所以 DAO 的参数校验，可以省略。 

   3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参

  数已经做过检查或者肯定不会有问题，此时可以不校验参数。

  (八) 注释规约 

  11.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，

  经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。 

   1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]） 

     表示需要实现，但目前还未实现的功能。这实际上是一个 javadoc 的标签，目前的

  javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 javadoc

  标签）。 

  2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]） 

     在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

  （九）其它

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

  【推荐】对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性 等要坚决从程序中清理出去，避免造成过多垃圾。清理这类垃圾代码是技术气场，不要有这样

  二、异常日志 

  (一) 异常处理 

  【强制】不要捕获 Java 类库中定义的继承自 RuntimeException 的运行时异常类，如：

  IndexOutOfBoundsException / NullPointerException，这类异常由程序员预检查来规避，保

  证程序健壮性。 

  【强制】对大段代码进行 try-catch，这是不负责任的表现。catch 时请分清稳定代码和非稳 定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。 

  【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请

  将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

  【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分 说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。 

  说明：本规约明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用

  者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回 null 的情况。 

  【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：
  1） 返回类型为包装数据类型，有可能是 null，返回 int 值时注意判空。 

  2） 数据库的查询结果可能为 null。 

   3） 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。 

   4） 远程调用返回对象，一律要求进行 NPE 判断。 

   5） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。 

   6） 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。 

  【推荐】在代码中使用“抛异常”还是“返回错误码”，对于公司外的 http/api 开放接口必

  须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，

  封装 isSuccess、“错误码”、“错误简短信息”。 

  说明：关于 RPC 方法返回方式使用 Result 方式的理由： 

   1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。 

   2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用

  端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输

  的性能损耗也是问题。 

  【推荐】定义时区分 unchecked / checked 异常，避免直接使用 RuntimeException 抛出，更

  不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过

  的自定义异常，如：DaoException / ServiceException 等。

  (二) 日志规约 

  【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。 

  
   

  【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方 式。 

  说明：logger.debug("Processing trade with id: " + id + " symbol: " + symbol); 如果

  日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，会

  执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。 

  正例：（条件） 

  if (logger.isDebugEnabled()) {    logger.debug("Processing trade with id: " + id + " symbol: " + symbol);   }      

  正例：（占位符） 

  logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

  【强制】 输出的 POJO 类必须重写 toString 方法，否则只输出此对象的 hashCode 值（地址值），没啥 参考意义。

  【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使 用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘

  撑爆，并记得及时删除这些观察日志。 

  说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。纪录日志时请

  思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？ 

  
  三、MYSQL 规约 

  【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint （ 1 表示是，0 表示否），此规则同样适用于 odps 建表。 

  说明：任何字段如果为非负数，必须是 unsigned。 

  
  

  【强制】表名不使用复数名词。 

  说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数

  形式，符合表达习惯。 

  【强制】表名、字段名必须使用小写字母或数字；禁止出现数字开头，禁止两个下划线中间只 出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。 

  正例：getter_admin，task_config，level3_name 

  反例：GetterAdmin，taskConfig，level_3_name

  【强制】表必备三字段：id, gmt_create, gmt_modified。 说明：其中 id 必为主键，类型为 unsigned bigint、单表时自增、步长为 1；分表时改为从TDDL Sequence 取值，确保分表之间的全局唯一。gmt_create, gmt_modified 的类型均为date_time 类型。 

  【推荐】表的命名最好是加上“业务名称_表的作用”，避免上云梯后，再与其它业务表关联

  时有混淆。 正例：tiger_task / tiger_reader / mpp_config 

  【推荐】字段允许适当冗余，以提高性能，但是必须考虑数据同步的情况。冗余字段应遵循： 

   1）不是频繁修改的字段。 

   2）不是 varchar 超长字段，更不能是 text 字段。 

  正例：各业务线经常冗余存储商品名称，避免查询时需要调用 IC 服务获取。 

  【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。 

  说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。 

  反例：某业务三年总数据量才 2 万行，却分成 1024 张表，问：你为什么这么设计？答：分 1024

  张表，不是标配吗？ 

  
  

  (二) 索引规约 

  【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。 说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验和控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。 

  【强制】超过三个表禁止 join。需要 join 的字段，数据类型保持绝对一致；多表关联查询时， 保证被关联的字段需要有索引。 

  【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。 

  说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索

  引。 

  (三) SQL 规约 

  【强制】不要使用 count(列名)或 count(常量)来替代 count(*)，count(*)就是 SQL92 定义的 标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。 

  说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。 

  【强制】count(distinct col) 计算该列除 NULL 之外的不重复数量。注意 count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。 

  
  

  【强制】当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为 NULL，因此使用 sum()时需注意 NPE 问题。 

  正例：可以使用如下方式来避免 sum 的 NPE 问题：SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM  table; 

  【强制】使用 ISNULL()来判断是否为 NULL 值。注意：NULL 与任何值的直接比较都为 NULL。 

  说明： 

   1） NULL<>NULL 的返回结果是 NULL，不是 false。 

   2） NULL=NULL 的返回结果是 NULL，不是 true。 

   3） NULL<>1 的返回结果是 NULL，而不是 true。 

  
  【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。

   

  【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

   

  【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控 制在 1000 个之内。 

   

  【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE

  无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。 

  说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。 

  
  

  (四) ORM 规约 

  1. 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。 说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。 

  2. 【强制】POJO 类的 boolean 属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中

  进行字段与属性之间的映射。 

  说明：参见定义 POJO 类以及数据库字段定义规定，在 sql.xml 增加映射，是必须的。 

  3. 【强制】不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要 定义；反过来，每一个表也必然有一个与之对应。 

  说明：配置映射关系，使字段与 DO 类解耦，方便维护。 

  【强制】xml 配置中参数注意使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。