sql规范&&Java规范

日常吐槽：那啥，就我一朋友啊，写代码不写注释，然后呢设计表不写comment,结果被砍了20刀，老惨了…我在此声明我不是内涵不写注释的朋友，我是针对在座的每一个不写注释的人，哈哈哈

捞一下之前项目的规范

表结构

1.【强制】表和列的名称必须控制在32个字符以内，表名只能使用字母、数字和下划线，一律小写。

2.【建议】表名要求模块名强相关，如师资系统采用”sz”作为前缀，渠道系统采用”qd”作为前缀等。

3.【强制】创建表时必须显式指定字符集为utf8mb4。

4.【强制】创建表时必须显式指定表存储引擎类型，如无特殊需求，一律为InnoDB。当需要使用除InnoDB/MyISAM/Memory以外的存储引擎时，必须通过DBA审核才能在生产环境中使用。因为Innodb表支持事务、行锁、宕机恢复、MVCC等关系型数据库重要特性，为业界使用最多的MySQL存储引擎。而这是其他大多数存储引擎不具备的，因此首推InnoDB。无对指定引擎的特殊依赖，禁止使用InnoDB以外的数据库存储引擎；

5.【强制】建表必须有comment;

6.【建议】建表时关于主键：(1)建议主键为id，类型为int或bigint，且为auto_increment； (2)标识表里每一行主体的字段不要设为主键，建议设为其他字段如user_id，order_id等，并建立unique key索引。因为如果设为主键且主键值为随机插入，则会导致innodb内部page分裂和大量随机I/O，性能下降。主键id没有任务业务意义，在业务代码中不得使用主键id用于查询条件。唯一索引的业务ID在业务表设计中可以使用，对于字典项类的表可以无此字段；

7.【强制】业务相关表（如用户表，金钱相关的表）必须有行数据的创建人字段created_by ,创建时间字段create_time和更新人字段updated_by，最后更新时间字段update_time，便于查问题。

8.【强制】表中所有字段必须都是NOT NULL属性，业务可以根据需要定义DEFAULT值。因为使用NULL值会存在每一行都会占用额外存储空间、数据迁移容易出错、聚合函数计算结果偏差等问题，同时无特殊说明字段必须设置DEFAULT默认值。

9.【强制】布尔值表达使用tinyint，并且不包含is，例如是否删除使用deleted，而不是is_deleted。

10.【建议】建议对表里的blob、text等大字段，垂直拆分到其他表里，仅在需要读这些对象的时候才去select。

11.【建议】反范式设计：把经常需要join查询的字段，在其他表里冗余一份。如user_name属性在user_account，user_login_log等表里冗余一份，减少join查询。

12.【强制】中间表用于保留中间结果集，名称必须以tmp_开头。备份表用于备份或抓取源表快照，名称必须以bak_开头。中间表和备份表定期清理。

13.【强制】对于超过100W行的大表进行alter table，必须经过DBA审核，并在业务低峰期执行。因为alter table会产生表锁，期间阻塞对于该表的所有写入，对于业务可能会产生极大影响。建议停服进行更新，避免引起数据库故障导致业务恢复困难。

一个规范的设计表示例

CREATE TABLE user (
  `id` bigint(11) NOT NULL AUTO_INCREMENT COMMENT ‘id’
  `user_id` bigint(11) NOT NULL DEFAULT '0' COMMENT ‘用户id’
  `username` varchar(45) NOT NULL  DEFAULT '' COMMENT '真实姓名',
  `email` varchar(30) NOT NULL DEFAULT ''  COMMENT ‘用户邮箱’,
  `nickname` varchar(45) NOT NULL DEFAULT ''  COMMENT '昵称',
  `avatar` int(11) NOT NULL  DEFAULT ''  COMMENT '头像',
  `birthday` date NOT NULL  DEFAULT ''  COMMENT '生日',
  `sex` tinyint(4) NOT NULL  DEFAULT '0' COMMENT '性别',
  PRIMARY KEY (`id`),
  UNIQUE KEY `idx_user_id` (`user_id`),
  KEY `idx_username`(`username`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='网站用户基本信息';

SQL编写

1.【强制】SELECT语句必须指定具体字段名称，禁止写成*。因为select *会将不该读的数据也从MySQL里读出来，造成网卡压力。且表字段一旦更新，但model层没有来得及更新的话，系统会报错。

2.【强制】insert语句指定具体字段名称，不要写成insert into t1 values(…)，道理同上。

3.【建议】insert into…values(XX),(XX),(XX)…。这里XX的值不要超过5000个。值过多虽然上线很很快，但会引起主从同步延迟。

4.【建议】SELECT语句不要使用UNION，推荐使用UNION ALL，并且UNION子句个数限制在5个以内。因为union all不需要去重，节省数据库资源，提高性能。

5.【建议】in值列表限制在500以内。例如select… where userid in(….500个以内…)，这么做是为了减少底层扫描，减轻数据库压力从而加速查询。

6.【建议】事务里批量更新数据需要控制数量，进行必要的sleep，做到少量多次。

7.【强制】事务涉及的表必须全部是innodb表。否则一旦失败不会全部回滚，且易造成主从库同步中断。

8.【强制】写入和事务发往主库，只读SQL发往从库。

9.【强制】除静态表或小表（100行以内），DML语句必须有where条件，且使用索引查找。禁止全表查询。

10.【强制】生产环境禁止使用hint，如sql_no_cache，force index，ignore key，straight join等。因为hint是用来强制SQL按照某个执行计划来执行，但随着数据量变化我们无法保证自己当初的预判是正确的，因此我们要相信MySQL优化器！

11.【强制】where条件里等号左右字段类型必须一致，否则无法利用索引。

12.【建议】SELECT|UPDATE|DELETE|REPLACE要有WHERE子句，且WHERE子句的条件必需使用索引查找。

13.【强制】生产数据库中强烈不推荐大表上发生全表扫描，但对于100行以下的静态表可以全表扫描。查询数据量不要超过表行数的25%，否则不会利用索引。

14.【强制】WHERE 子句中禁止只使用全模糊的LIKE条件进行查找，必须有其他等值或范围查询条件，否则无法利用索引。

15.【建议】索引列不要使用函数或表达式，否则无法利用索引。如where length(name)='Admin’或where user_id+2=10023。

16.【建议】减少使用or语句，可将or语句优化为union，然后在各个where条件上建立索引。如where a=1 or b=2优化为where a=1… union …where b=2, key(a),key(b)。

17.【建议】分页查询，当limit起点较高时，可先用过滤条件进行过滤。如select a,b,c from t1 limit 10000,20;优化为: select a,b,c from t1 where id>10000 limit 20。

多表连接

1.【强制】禁止跨db的join语句。因为这样可以减少模块间耦合，为数据库拆分奠定坚实基础。

2.【强制】禁止在业务的更新类SQL语句中使用join，比如update t1 join t2…。

3.【建议】不建议使用子查询，建议将子查询SQL拆开结合程序多次查询，或使用join来代替子查询。

4.【建议】线上环境，多表join不要超过3个表。

5.【建议】多表连接查询推荐使用别名，且SELECT列表中要用别名引用字段，数据库.表格式，如select a from db1.table1 alias1 where …。

6.【建议】在多表join中，尽量选取结果集较小的表作为驱动表，来join其他表。

事务

1.【建议】事务中INSERT|UPDATE|DELETE|REPLACE语句操作的行数控制在2000以内，以及WHERE子句中IN列表的传参个数控制在500以内。

2.【建议】批量操作数据时，需要控制事务处理间隔时间，进行必要的sleep，一般建议值5-10秒。

3.【建议】对于有auto_increment属性字段的表的插入操作，并发需要控制在200以内。

4.【强制】程序设计必须考虑“数据库事务隔离级别”带来的影响，包括脏读、不可重复读和幻读。线上建议事务隔离级别为repeatable-read。

5.【建议】事务里包含SQL不超过5个（支付业务除外）。因为过长的事务会导致锁数据较久，MySQL内部缓存、连接消耗过多等雪崩问题。

6.【建议】事务里更新语句尽量基于主键或unique key，如update … where id=XX; 否则会产生间隙锁，内部扩大锁定范围，导致系统性能下降，产生死锁。

7.【建议】尽量把一些典型外部调用移出事务，如调用webservice，访问文件存储等，从而避免事务过长。

8.【建议】对于MySQL主从延迟严格敏感的select语句，请开启事务强制访问主库。

基础

1.文件名
源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。
2.文件编码
源文件编码格式为UTF-8。
3.文件长度
单个源文件最大长度2000行,自动生成的代码除外，比如RPC接口定义,Protobuf文件等，建议移到单独的module中维护，避免影响主工程的编译速度。
4.特殊字符
除了在行结束使用换行符，空格是源文件中唯一允许出现的空白字符。
1.字符串中的非空格空白字符，使用转义字符。 2.不允许行前使用tab缩进；

特殊转义字符
对于具有特殊意义转义字符(\b, \t, \n, \f, \r，", '及)，不允许使用相应的八进制(比如\012)或Unicode(比如\u000a)转义。
正例

String content = "input your name: \n";
Copy to clipboardErrorCopied

反例

String content = "input your name: \\u000a";

垃圾清理

对从来没有用到的或者被注释的方法、变量、类、配置文件、动态配置属性等要坚决从系统中清理出去，避免造成过多垃圾及干扰性。

【必须】package语句
package语句不换行，行长度限制并不适用于package语句。

import语句
【必须】import不要使用通配符
通配符导入使得不清楚实际需要导入什么，如果具有多个通配符，也可能导致引入的新类名字冲突。

正例

import java.util.Collections;
Copy to clipboardErrorCopied

反例

import java.util.*

【必须】import不要换行
列限制并不适用于import语句,每个import语句语句应独立成行。

【必须】重载方法：不应该分开
当一个类有多个构造函数，或是多个同名方法，这些函数/方法应该按顺序出现在一起，中间不要放进其它函数/方法。

【必须】Lambda表达式
lambda优于匿名类;
通常，方法引用应比lambda表达式更可取;
除非可以提高参数的可读性，否则应省略参数类型;
如果lambda表达式超过几行，请考虑创建一个方法.

正例

Runnable r = () -> System.out.println("Hello World");
Supplier<String> c = () -> "Hello World";

// Collection::contains is a simple unary method and its behavior is
// clear from the context. A method reference is preferred here.
appendFilter(goodStrings::contains);

// A lambda expression is more readable in this case
// (cf. corresponding example in Don'ts section)
trackTemperature((time, temp) -> tempMap.put(time, temp));

Function<Person, String> nameFunc = p -> p.getFirstName() + " " + p.getLastName();

class Util {
    private static String getCapitalizedFirstName(Person p) {
        String first = p.getFirstName();
        char initial = Character.toUpperCase(first.charAt(0));
        return initial + first.substring(1);
    }
 
    static void printAllPersons(List<Person> persons) {
        persons.stream()
               .map(Util::getCapitalizedFirstName)
               .forEach(System.out::println);
    }
}

反例

Runnable r = () -> { System.out.println("Hello World"); };
Supplier<String> s = () -> { return "Hello World"; };

// A lambda expression is not needed here
appendFilter(s -> goodStrings.contains(s));

// Map::put is a binary function, and it's not clear from context what type
// of argument trackTemperature accepts. A lambda expression is better here.
trackTemperature(tempMap::put);

// Unnecessary parameter type
Function<Person, String> nameFunc = (Person p) -> p.getFirstName() + " " + p.getLastName();

class Util {
    static void printAllPersons(List<Person> persons) {
        persons.stream()
               .map(p -> {
                   String first = p.getFirstName();
                   char initial = Character.toTitleCase(first.charAt(0));
                   return initial + first.substring(1);
               })
               .forEach(System.out::println);
    }
}

先整理这些。。。。。后续再补充吧