Java编码规范 安全规范和MySQL规范

编码规范

1.安全规范

1. 隶属于用户个人的页面或者功能必须进行权限控制校验
   1. 说明：防止没有做水平权限校验就可以随意访问、修改、删除别人数据，比如查看他人的私信内容，修改他人的订单等等。
2. 用户敏感数据禁止直接展示，必须对展示数据进行脱敏
   1. 说明：中国大陆个人手机号显示为：150****1037，隐藏中间4位，防止隐私泄露
3. 用户输入的SQL参数严格使用参数绑定或者METADATA字段值限定，防止SQL注入，禁止字符串拼接SQL访问数据库
   1. Java的技术栈里面，mybatis框架有防止依赖注入的措施
   2. #{}代表先编译后引用，$代表直接拼接sql。开发人员少用或者不用${}
4. 用户请求传入的任何参数必须做有效性验证
   1. 说明：忽略参数校验可能导致
      • page size过大导致内存溢出
      • 恶意order by导致数据库慢查询
      • 任意重定向
      • SQL注入
      • 反序列化注入
      • 正则输入源串拒绝服务ReDos
5. 禁止向HTML页面输入未经安全过滤或未正确转义的用户数据
6. 表单，ajax提交必须执行CSRF安全验证
   1. 说明：CSRF（CROS-site request forgery）跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好URL，紫瑶受害者一访问，后台便在用户不知情的情况下对数据库中的用户参数进行相应修改。
      • 如何进行CSRF验证
        • 检查Referer字段
          • Referer：Header中的信息，代表访问来源站点地址
          • 优点：简单易行，工作量低，仅需要在关键访问处增加进一步验证
          • 缺点：有局限性，因完全依赖浏览器，可能被恶意浏览器篡改Referer内容。
        • 添加校验token
          • 方式：服务器一个伪随机数。当客户端通过窗体提交请求时，这个伪随机数也一并提交上去以供验证。正常访问时，客户端浏览器能够正确得到并传回这个伪随机数，而通过CSRF传来的欺骗性攻击中，攻击者无从事先得知这个伪随机数的值，服务端就会因为校验token的值为空或者错误，拒绝这个可疑请求。
          • 优点：更加安全，可以有效防止CSRF
          • 缺点：有一定工作量
7. 在使用平台资源，譬如短信、邮件、电话、下单，必须实现正确的防重放的机制，如数量限制，疲劳度控制、验证码校验，避免被滥刷而导致资损。
   1. 说明：如注册时发送验证码到手机上，如果没有限制次数和频率，那么可以利用此功能骚扰到其他用户，并造成短信平台资源浪费。
8. 发帖、评论、发送即时信息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风险策略。

2、MySQL建表规约

1. 表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsignedtinyint（1表示是，0表示否）
   1. 说明：任何字段如果为非负数，必须是unsigned
2. 表名、字段名必须使用小写字母或者数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑
   1. 说明，MySQL在windows下不区分大小写，但是在linux里面区分大小写。因此，数据库名、表名、字段名，都不允许任何大写字母，避免节外生枝。
3. 表名不使用复数名词
   1. 说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于DO类名也是单数形式，符合表达习惯。
4. 禁用保留字，请参考MySQL官方保留字
5. 主键索引名为pk_字段名；唯一索引名为uk_字段名;普通索引名则为idx_字段名。
6. 小数类型为decimal，禁止使用float和double。
   1. 说明：在存储的时候，float和double都存在精度缺失的问题，很可能在比较值的时候，得到不正确的结果，如果储存的数据范围超过decimal的范围，建议将数据拆成整数和小数并分开存储。
7. 如果存储的字符串长度几乎相等，使用char定长字符串类型
8. varchar是可变字符串，不预先分配储存空间，长度不要超过5000，如果储存长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其他字段索引效率。
9. 表必备三字段：id，create_time,update_time.
   1. 说明id必为主键，类型为bigint unsigned，单表时自增、步长为1。create_time,update_time的类型均为datetime类型。
10. 表的命名最好是遵循“业务名称_表的作用".
11. 库名与应用名称尽量一致。
12. 如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注解。
13. 字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
    1. 不是频繁修改的字段。
    2. 不是varchar超长字段，更不能是text字段。
    3. 不是唯一索引字段
14. 单表行数超过500万行或者单表容量超过2gb，才推荐进行分库分表。
    1. 说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
15. 合适的字符储存长度，不但节约数据库表空间，节约索引储存，更重要的是提升索引速度。

3、MySQL索引规约

1. 业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引
   1. 说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生
2. 超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引
   1. 说明：即使双表join也要注意表索引，SQL性能。
3. 在varchar字段上建立索引，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
   1. 说明：索引长度和区分度是一个矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count（distinct left（列名，索引长度）/count(*)的区分度来确定。
4. 页面搜索严禁左模糊或者全模糊，如果需要请走索引引擎来解决。
   1. 说明：索引文件具有B-tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。
5. 如果有order by的场景，请注意利用索引的有效性。order by最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，印象查询性能。
   1. 证例：where a=？ and b=？ order by c；
6. 利用覆盖索引来进行查询操作，避免回表。