公司项目JAVA开发规范总结（六）——数据库规范

• 表名、字段名使用全小写，单词间用 “_” 隔开

​ 禁止数字开头，禁止两个下划线中间只出现数字

• 若两个实体之间存在多对多的关系，在两者间的主键与公共属性分配到第三个实体中，变成两个一对多的关系；

  • 满足三大范式

  • 第一范式：字段具有原子性，不可再分解

  • 第二范式：实体数据有惟一标识，即主键标识

  • 第三范式：任何字段不能由其他字段派生出来，若在增加运行效率的前提下可适当冗余，具体情况具体分析；

• 数据库表设计个数尽可能少；一个表的字段个数尽可能少；

• 基本表必备三字段：id，create_time，update_time

  • id：主键，unsigned -> 选中【无符号】

    • int(11)，数据库的unsigned int 对应 java 的 Long，范围：0~4294967295

    • mediumint(11)，数据库的unsigned int 对应 java 的 Integer，范围：0~16777215

  • create_time：最初创建时间，类型为timestamp，新建默认：CURRENT_TIMESTAMP

  • update_time：最新一次更新时间，类型为timestamp，新建默认：CURRENT_TIMESTAMP，选中【根据当前时间戳更新】

• 表达是与否概念的字段，必须使用 is_xxx 的方式命名

  • 数据类型是 unsigned tinyint数据类型：tinyint unsigned (1:是，0:否)，

    注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在设置从 is_xxx 到

    Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含

    义与取值范围。

  • 正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除

• 表名不使用拼音、复数名词

• 记录含小数的数字字段，类型统一使用decimal，禁用flfloat和double

• varchar长度不要超过 5000

1. 索引名设置

• 主键索引：pk_字段名

• 唯一索引：uk_字段名

• 普通索引：idx_字段名

2. 多表关联查询时，保证关联的字段需要有索引

3. 【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。

   说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外， 即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

4. 【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据 实际文本区分度决定索引长度。

   说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90% 以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。

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

   说明：即使双表 join 也要注意表索引、SQL 性能。

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

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

7. 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索 引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。

   正例：where a=? and b=? order by c; 索引：a_b_c

   反例：索引如果存在范围查询，那么索引有序性无法利用，如：WHERe a>10 ORDER BY b; 索引 a_b 无 法排序。

8. 【推荐】利用覆盖索引来进行查询操作，避免回表。

   说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这 个目录就是起到覆盖索引的作用。

   正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用 explain 的结果，extra 列会出现：using index。

9. 【推荐】利用延迟关联或者子查询优化超多分页场景。

   说明：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
   

10. 【推荐】建组合索引的时候，区分度最高的在最左边。

    正例：如果 where a=? and b=?，a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。

    说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where c>? and d=? 那么即使 c 的区分度更高，也必须把d 放在索引的最前列，即建立组合索引 idx_d_c。

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 table_first as t1 , table_second as t2 where 
   

10. 【推荐】SQL 语句中表的别名前加 as，并且以 t1、t2、t3、…的顺序依次命名。

    说明：1）别名可以是表的简称，或者是根据表出现的顺序，以 t1、t2、t3 的方式命名。2）别名前加 as 使别名更容易识别。

    正例：

    select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;
    

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

1. 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。

   说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。3）无用字段增加网络消耗，尤其是 text 类型的字段。

2. 【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行 字段与属性之间的映射。

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

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

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

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

5. 【强制】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。

   说明：其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录，再通过 subList 取 start,size 的子集合。

   正例：

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

6. 【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。

   反例：某同学为避免写一个，直接使用 HashTable 来接收数据库返回结果，结果出现日常 是把 bigint 转成 Long 值，而线上由于数据库版本不一样，解析成 BigInteger，导致线上问题。

7. 【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。

8. 【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需 要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

9. 【参考】两种分页方式：

   1. MybatisPlus的分页插件：

      MybatisPlus通过创建Page对象，赋予页数页码，传入Mapper查询方法中，从数据库操作层面去实现，但面对复杂语句会报错。

   2. Pagehelper分页方式：

      执行完Pagehelper的startPage，其第一次查询自动加上limit的限制，new PageInfo放入的数据，就会按startPage传入的参数去进行处理。

   项目实现方式：

   Controller继承BaseController，BaseController中有：

      protected  Page getPage() {
           Page page = new Page<>();
           String pNo = httpServletRequest.getParameter("CurrentIndex");
           String pSize = httpServletRequest.getParameter("PageSize");
           page = StringUtils.isBlank(pNo) ? page.setCurrent(1L) : page.setCurrent(Long.parseLong(pNo));
           page = StringUtils.isBlank(pSize) ? page.setSize(10L) : page.setSize(Long.parseLong(pSize));
           return page;
       }
   
       protected void getPageHelper(){
           String pNo = httpServletRequest.getParameter("CurrentIndex");
           String pSize = httpServletRequest.getParameter("PageSize");
           if (StringUtils.isBlank(pNo) || StringUtils.isBlank(pSize)){
               PageHelper.startPage(1,10);
           }else{
               PageHelper.startPage(Integer.parseInt(pNo), Integer.parseInt(pSize));
           }
       }
   
       protected  SimplePage formatPage(Page mybatisPage) {
           SimplePage simplePage = new SimplePage();
           simplePage.setPageNo(mybatisPage.getCurrent());
           simplePage.setPageSize(mybatisPage.getSize());
           simplePage.setPageCount(mybatisPage.getPages());
           simplePage.setCount(mybatisPage.getTotal());
           simplePage.setRecords(mybatisPage.getRecords());
           return simplePage;
       }
   
       protected  ReplacePage formatPage(PageInfo PageHelper) {
           ReplacePage replacePage = new ReplacePage();
           replacePage.setTotalCount(PageHelper.getTotal());
           replacePage.setList(PageHelper.getList());
           return replacePage;
       }
   
   

   当Controller的接口职能是分页查询时，则执行super.getPage() ；会将传过来的参数pageNo和pageSize去封装到两种方式中，根据不同场景去选择进行使用。

10. 【参考】让一些对于数据的处理提取到Service层，使用MybatisPlus可使用Wrapper的lambda表达式去拼凑一些where后面的语句，使得我们只需要在sql层面书写查询、分组操作，再通过注入Wrapper即可。

11. 【参考】集合的筛选、去重、循环等复杂操作建议先尝试使用stream流操作

    例：

    //从学生集合中筛选出学生id集合 
    List stuUserIdList = studentList.stream().map(BaseStudent::getUserId).collect(Collectors.toList());
    
    //筛选包中人脸图片是否符合要求 
    List failToFaceLibList = faceIdImportList.stream().filter(p -> !faceIdList.contains(p)).collect(Collectors.toList()); 
    
    //车牌号集合去重 
    List carIdDistinctList = carIdList.stream().distinct().collect(Collectors.toList()); 
    
    //集合内的实体循环操作 
    baseParentList.forEach(item -> {});