编程规约

发表于 | 更新于: | 分类于 | 阅读次数: | | 字数统计: 5,576

编程规约

集合

  1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则：
    1） 只要重写 equals，就必须重写 hashCode。 2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须重写这两个方法。
    3） 如果自定义对象作为 Map 的键，那么必须重写 hashCode 和 equals。
    说明：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。
  2. 【强制】ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException
    异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。
    说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。
  3. 【强制】在 subList 场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生 ConcurrentModificationException 异常。
  4. 【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。
    说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ]的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
    正例：
    1
    2
    3
    4
    5
    List<String> list = new ArrayList<String>(2); 
    list.add("guan"); 
    list.add("bao"); 
    String[] array = new String[list.size()]; 
    array = list.toArray(array);

反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出现 ClassCastException 错误。

  1. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
    说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。 
    1
    2
    String[] str = new String[] { "you", "wu" };
    List list = Arrays.asList(str);

第一种情况：list.add(“yangguanbao”); 运行时异常。
第二种情况：str[0] = “gujin”; 那么 list.get(0)也会随之修改。

  1. 【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方 法，而<? super T>不能使用 get 方法，作为接口调用赋值时易出错。
    说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用<? extends T>。第二、经常往里插入的，适合用<? super T>。
  2. 【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator
    方式，如果并发操作，需要对 Iterator 对象加锁。
    正例： 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    List<String> list = new ArrayList<>();
          list.add("1");
          list.add("2");
          Iterator<String> iterator = list.iterator();
          while (iterator.hasNext()) {
              String item = iterator.next();
              if (删除元素的条件) {
                  iterator.remove();
              }
          }

##　OOP规约

  1. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
    说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，
    然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。
    反例： 

    1
    2
    3
    4
    String str = "start"; 
        for (int i = 0; i < 100; i++) { 
            str = str + "hello"; 
        }

  2. 【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：

    • 不允许被继承的类，如：String 类。
    • 不允许修改引用的域对象。
    • 不允许被重写的方法，如：POJO 类的 setter 方法。
    • 不允许运行过程中重新赋值的局部变量。
    • 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好地进行重构。

    控制语句

    1. 【强制】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。
      说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。
      反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

      注释规约

  3. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用// xxx 方式。
    说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
  4. 【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
    说明：对子类的实现要求，或者调用注意事项，请一并说明。
  5. 【强制】所有的类都必须添加创建者和创建日期。
  6. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

    其他

  7. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。
  8. 【推荐】及时清理不再使用的代码段或配置信息。
    说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。
    正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

    异常处理

  9. 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。
  10. 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。
    说明：本手册明确防止 NPE 是调用者的责任。
  11. 【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：
    1）返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。
    反例：public int f() { return Integer 对象}， 如果为 null，自动解箱抛 NPE。
    2） 数据库的查询结果可能为 null。
    3） 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。
    4） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE。
    5） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。
    6） 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。
    正例：使用 JDK8 的 Optional 类来防止 NPE 问题。
  12. 【参考】对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出；
    跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。
    说明：关于 RPC 方法返回方式使用 Result 方式的理由：
    1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
    2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
  13. 【参考】避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。
    说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。
    正例：一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取：
    private boolean checkParam(DTO dto) {...}

    日志规约

  14. 【强制】日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。
  15. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：
    appName_logType_logName.log。
    logType:日志类型，如 stats/monitor/access 等；logName:日志描述。这种命名的好处：
    通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
    正例：mppserver 应用中单独监控时区转换异常，如：
    mppserver_monitor_timeZoneConvert.log
    说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
  16. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
    正例：<logger name="com.taobao.dubbo.config" additivity="false">
  17. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。
    正例：logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

    安全

  18. 【强制】表单、AJAX 提交必须执行 CSRF 安全验证。
    说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在CSRF 漏洞的应用/网站，攻击者可以事先构造好 URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。
  19. 【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。
    说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。

    MySql数据库

    建表

  20. 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint（1 表示是，0 表示否）。
    说明：任何字段如果为非负数，必须是 unsigned。
    注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在设置从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
    正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。
  21. 【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。
  22. 【强制】主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
    说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。
  23. 【强制】小数类型为 decimal，禁止使用 float 和 double。
    说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。
  24. 【强制】如果存储的字符串长度几乎相等，使用 char 定长字符串类型。
  25. 【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
  26. 【强制】表必备三字段：id, gmt_create, gmt_modified。
    说明：其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。gmt_create, gmt_modified 的类型均为 datetime 类型，前者现在时表示主动创建，后者过去分词表示被动更新。
  27. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
    说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

    索引

  28. 【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
    说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
  29. 【强制】超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。
    说明：即使双表 join 也要注意表索引、SQL 性能。
  30. 【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
    说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。
  31. 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
    说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。
  32. 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
    正例：where a=? and b=? order by c; 索引：a_b_c
    反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引a_b 无法排序。
  33. 【推荐】利用覆盖索引来进行查询操作，避免回表。
    说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。
    正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用 explain 的结果，extra 列会出现：using index。
  34. 【推荐】利用延迟关联或者子查询优化超多分页场景。
    说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。
    正例：先快速定位需要获取的 id 段，然后再关联：SELECT a.* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id
  35. 【推荐】SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts最好。
    说明：
    1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
    2）ref 指的是使用普通的索引（normal index）。
    3）range 对索引进行范围检索。
    反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。
  36. 【推荐】建组合索引的时候，区分度最高的在最左边。
    正例：如果 where a=? and b=? ，如果 a 列的几乎接近于唯一值，那么只需要单建 idx_a索引即可。
    说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c>? and d=? 那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即索引 idx_d_c。

SQL语句

  1. 【强制】不要使用 count(列名)或 count(常量)来替代 count()，count()是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。
    说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。
  2. 【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinctcol1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。
  3. 【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
  4. 【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。
  5. 【强制】sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
  6. 【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
    说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。

    工程结构

  7. 【参考】分层领域模型规约：
     DO（Data Object）：此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。  DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。  BO（Business Object）：业务对象，由 Service 层输出的封装业务逻辑的对象。  AO（Application Object）：应用对象，在 Web 层与 Service 层之间抽象的复用对象模型，极为贴近展示层，复用度不高。  VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
     Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。
  8. 【强制】定义 GAV 遵从以下规则：
    1） GroupID 格式：com.{公司/BU }.业务线 [.子业务线]，最多 4 级。
    说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress 等 BU 一级；子业务线可选。
    正例：com.taobao.jstorm 或 com.alibaba.dubbo.register
    2） ArtifactID 格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
    正例：dubbo-client / fastjson-api / jstorm-tool
    3） Version：详细规定参考下方。
  9. 【强制】二方库版本号命名方式：主版本号.次版本号.修订号
    1） 主版本号：产品方向改变，或者大规模 API 不兼容，或者架构不兼容升级。 2） 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。
    3） 修订号：保持完全兼容性，修复 BUG、新增次要功能特性等。
    说明：注意起始版本号必须为：1.0.0，而不是 0.0.1 正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0
  10. 【强制】线上应用不要依赖 SNAPSHOT 版本（安全包除外）。
    说明：不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
  11. 【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评估和验证，建议进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一致，那么通过 dependency:tree 命令，找出差异点，进行排除 jar 包。
  12. 【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。
  13. 【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
    说明：依赖 springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。
  14. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的Version。
    说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个 war，只能有一个版本号出现在最后的 lib 目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。
  15. 【推荐】所有 pom 文件中的依赖声明放在语句块中，所有版本仲裁放在语句块中。
    说明：里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version 和 scope 都读取自父 pom。而所有声明在主 pom 的 里的依赖都会自动引入，并默认被所有的子项目继承。

    服务器

  16. 【推荐】给 JVM 环境参数设置-XX:+HeapDumpOnOutOfMemoryError 参数，让 JVM 碰到 OOM 场景时输出 dump 信息。
    说明：OOM 的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。
  17. 【推荐】在线上生产环境，JVM 的 Xms 和 Xmx 设置一样大小的内存容量，避免在 GC 后调整堆大小带来的压力。
-------------本文结束感谢您的阅读-------------
0%