Java开发手册-8

MySQL 数据库

SQL语句

1. 【强制】不要使用count(列名)或count(常量)来替代count(*)，count(*)是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。
   说明：count(*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。
2. 【强制】count(distinct col)计算该列除NULL之外的不重复行数，注意count(distinct col1，col2)如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为0。
3. 【强制】当某一列的值全是NULL时，count(col)的返回结果为0；但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE问题。
   正例：可以使用如下方式来避免sum的NPE 问题：SELECT IFNULL(SUM(column)，0) FROM table;
4. 【强制】使用 ISNULL()来判断是否为NULL值。
   说明：NULL与任何值的直接比较都为NULL。
   1）NULL <> NULL的返回结果是NULL，而不是false。
   2）NULL = NULL的返回结果是NULL，而不是true。
   3）NULL <> 1的返回结果是NULL，而不是true。
   反例：在SQL语句中，如果在null前换行，影响可读性。
   select*from table where column1 is null and column3 is not null;而ISNULL(column)是一个整体，简洁易懂。从性能数据上分析，ISNULL(column)执行效率更快一些。
5. 【强制】代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句。
6. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
   说明：（概念解释）学生表中的student_id是主键，那么成绩表中的student_id则为外键。如果更新学生表中的student_id，同时触发成绩表中的student_id更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
7. 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
8. 【强制】数据订正（特别是删除或修改记录操作）时，要先select，避免出现误删除的情况，确认无误才能执行更新语句。
9. 【强制】对于数据库中表记录的查询和变更，只要涉及多个表，都需要在列名前加表的别名（或表名）进行限定。
   说明：对多表进行查询记录、更新记录、删除记录时，如果对操作列没有限定表的别名（或表名），并且操作列在多个表中存在时，就会抛异常。
   正例：select t1.name from first table ast1, second_table as t2 where t1.id= t2.id;
   反例：在某业务中，由于多表关联查询语句没有加表的别名（或表名）的限制，正常运行两年后，最近在某个表中增加一个同名字段，在预发布环境做数据库变更后，线上查询语句出现出1052异常：Column'name'infield list is ambiguous。
10. 【推荐】SQL语句中表的别名前加as，并且以t1、t2、t3、…的顺序依次命名。
    说明：
    1）别名可以是表的简称，或者是依照表在SQL语句中出现的顺序，以t1、t2、t3的方式命名。
    2）别名前加as使别名更容易识别。
    正例：select t1.name from first_table ast1, second_table as t2 where t1.id= t2.id;
11. 【推荐】in操作能避免则避免，若实在避免不了，需要仔细评估in后边的集合元素数量，控制在 1000个之内。

ORM映射

1. 【强制】在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明。
   说明：
   1）增加查询分析器解析成本。
   2）增减字段容易与resultMap配置不一致。
   3）无用字段增加网络消耗，尤其是text类型的字段。
2. 【强制】POJO类的布尔属性不能加is，而数据库字段必须加is_，要求在resultMap中进行字段与属 性之间的映射。
   说明：参见定义POJO类以及数据库字段定义规定，在sql.xml增加映射，是必须的。
3. 【强制】不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义 <resultMap>；反过来，每一个表也必然有一个<resultMap>与之对应。
   说明：配置映射关系，使字段与DO类解耦，方便维护。
4. 【强制】sql.xml配置参数使用：#{}，#param#不要使用${}此种方式容易出现SQL注入。
5. 【强制】iBATIS 自带的queryForList(String statementName，int start，int size)不推荐使用。
   说明：其实现方式是在数据库取到statementName 对应的 SQL语句的所有记录，再通过 subList取 start， size 的子集合，线上因为这个原因曾经出现过OOM。
   正例：

 Map<String, Object> map = new HashMap<>(16);
 map.put("start", start);
 map.put("size", size);

6. 【强制】不允许直接拿HashMap与Hashtable作为查询结果集的输出。
   反例：某同学为避免写一个<resultMap>xxx</resultMap>，直接使用Hashtable来接收数据库返回结果，结果出现日常是把 bigint 转成Long 值，而线上由于数据库版本不一样，解析成 Biglnteger，导致线上问题。
7. 【强制】更新数据表记录时，必须同时更新记录对应的update_time字段值为当前时间。
8. 【推荐】不要写一个大而全的数据更新接口。传入为POJO类，不管是不是自己的目标更新字段，都进行update table set c1 = value1, c2 = value2, c3 = value3;这是不对的。执行SQL时，不要更新无改动的字段，一是易出错；二是效率低；三是增加binlog存储。
9. 【参考】@Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各 方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

工程结构

应用分层

1. 【推荐】根据业务架构实践，结合业界分层规范与流行技术框架分析，推荐分层结构如图所示，默认上层依赖于下层，箭头关系表示可直接依赖，如：开放API层可以依赖于Web层（Controller层），也可以直接依赖于Service层，依此类推：
   

   ●开放API层：可直接封装Service接口暴露成RPC接口；通过Web封装成http接口；网关控制层等。
   ●终端显示层：各个端的模板渲染并执行显示的层。当前主要是JS渲染，JSP渲染，移动端展示等。
   ●Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
   ●Service层：相对具体的业务逻辑服务层。
   ●Manager层：通用业务处理层，它有如下特征
   1）对第三方平台封装的层，预处理返回结果及转化异常信息，适配上层接口。
   2）对Service层通用能力的下沉，如缓存方案、中间件通用处理。
   3）与DAO层交互，对多个DAO的组合复用。
   ●DAO层：数据访问层，与底层MySQL、Oracle、Hbase、OceanBase等进行数据交互。
   ●第三方服务：包括其它部门RPC服务接口，基础平台，其它公司的HTTP接口，如淘宝开放平台、支付宝付款服务、高德地图服务等。
   ●外部数据接口：外部（应用）数据存储服务提供的接口，多见于数据迁移场景中。

2. 【参考】（分层异常处理规约）在DAO层，产生的异常类型有很多，无法用细粒度的异常进行 catch，使用catch(Exception e)方式，并throw new DAOException(e)，不需要打印日志，因为日志在Manager或Service层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在Service层出现异常时，必须记录出错日志到磁盘，尽可能带上参数和上下文信息，相当于保护案发现场。Manager层与Service同机部署，日志方式与DAO层处理一致，如果是单独部署，则采用与Service一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，尽量加上友好的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。

3. 【参考】分层领域模型规约：
   ●DO(Data Object)：此对象与数据库表结构一一对应，通过DAO层向上传输数据源对象。
   ●DTO(Data Transfer Object)：数据传输对象，Service或Manager 向外传输的对象。
   ●BO(Business Object)：业务对象，可以由Service层输出的封装业务逻辑的对象。
   ●Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。
   ●VO(View Object)：显示层对象，通常是Web 向模板渲染引擎层传输的对象。

二方库依赖

1. 【强制】定义GAV遵从以下规则：
   1）Groupld格式：com.{公司/BU}.业务线.【子业务线】，最多4级。
   说明：{公司/BU}例如：alibaba/taobao/tmall/kaikeba等BU一级；子业务线可选。
   正例：com.taobao.jstorm 或com.alibaba.dubbo.register
   2）Artifactld格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
   正例：dubbo-client/fastjson-api/jstorm-tool
   3）Version：详细规定参考下方。
2. 【强制】二方库版本号命名方式：主版本号.次版本号.修订号
   1）主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。
   2）次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的API不兼容修改。
   3）修订号：保持完全兼容性，修复BUG、新增次要功能特性等。
   说明：注意起始版本号必须为：1.0.0，而不是0.0.1。
   反例：仓库内某二方库版本号从1.0.0.0开始，一直默默"升级"成1.0.0.64，完全失去版本的语义信息。
3. 【强制】线上应用不要依赖SNAPSHOT版本（安全包除外）；正式发布的类库必须先去中央仓库进行查证，使RELEASE版本号有延续性，且版本号不允许覆盖升级。
   说明：不依赖 SNAPSHOT版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
4. 【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。
   说明：在升级时，进行 dependency.resolve前后信息比对，如果仲裁结果完全不一致，那么通过dependency.tree命令，找出差异点，进行<exclude>排除jar包。
5. 【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。
6. 【强制】二方库定制包的命名方式，在规定的版本号之后加“-英文说明序号】”，英文说明可以是部门简称、业务名称，序号直接紧跟在英文说明之后，表示此定制包的顺序号。
   说明：fastison给SCM定制的版本号：1.0.0-SCM1。注：尽可能在应用端来解决类冲突和加载问题，避免随意发布此类定制包。
7. 【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
   说明：依赖springframework-core，-context，-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。
8. 【强制】禁止在子项目的pom依赖中出现相同的Groupld，相同的Artifactld，但是不同的Version。
   说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的lib目录中。曾经出现过线下调试是正确的，发布到线上却出故障的先例。