入职公司三天，没干啥其他活，基本在配置本地环境和阅读相关文档。技术方面公司基本用的是主流的技术体系，入职后需要先阅读阿里的开发规范和其他的一些产研文档。今天整理一些平时需要关注的阿里规约和数据库开发规范，方便今后在开发过程中查阅。

文章目录

阿里规约
数据库开发规范

阿里规约

下文提到的规约除标注【推荐】类型的都属于阿里【强制】类型的规约，开发过程中需要严格遵守。

相关命名严禁使用“拼音”或者“拼音+英文”的方式，国际通用的中文名称可视同英文；
类名使用驼峰风格，除了DO、DTO、BO等；
抽象类使用Abstract或者Base开头，异常类使用Exception结尾，测试类以测试类名开头，以Test结尾；
POJO类型的布尔类型变量不使用is作为开头 ，如isDeleted，部分框架解析会出现序列化错误；
不允许在子父类的成员变量之间，不同代码块的局部变量之间采用完全相同的命名；
杜绝完全不规范的缩写，避免望文不知义；
对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
不允许任何魔法值(即未经预先定义的常量)直接出现在代码中（防止其他开发人员错写变量）
推荐的规约：常量复用的五个层次：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

跨应用共享常量:放置在二方库中，通常是 client.jar 中的 constant 目录下。

应用内共享常量:放置在一方库中，通常是子模块中的 constant 目录下。反例:易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量:
类 A 中:public static final String YES = “yes”;
类 B 中:public static final String YES = “y”; A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。

子工程内部共享常量:即在当前子工程的 constant 目录下。 4) 包内共享常量:即在当前包下单独的 constant 目录下。

类内共享常量:直接在类内部 private static final 定义。

如果是大括号内为空，则简洁地写成{}即可，右大括号后还有else等代码则不换行
if/for/while/switch/do等保留字与括号之间都必须加空格
采用 4 个空格缩进，禁止使用 Tab 字符，如果使用 Tab 缩进，必须设置 1 个 Tab 为 4 个空格。IDEA 设置 Tab 为 4 个空格时，请勿勾选 Use tab character
注释的双斜线与注释内容之间有且仅有一个空格。
在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开
单行字符数限制不超过 120 个，超出需要换行，第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进
IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。
【推荐】单个方法的总行数不超过 80 行。
所有的覆写方法，必须加@Override注解。
外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。
强制不能使用过时的类或方法。
所有整型包装类对象之间值的比较，全部使用equals方法比较。
任何货币金额，均以最小货币单位且整型类型来进行存储。（最小货币单位，例如分，整型类型，例如Long）
浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals 来判断。BigDecimal 的等值比较应使用 compareTo()方法，而不是 equals()方法
使用BigDecimal的valueOf()方法替代构造方法BigDecimal(double)，将Double值转化为BigDecimal对象，因为构造方法会存在精度损失风险。
定义DO/DTO/VO等POJO类时，不要设定任何属性默认值，如createTime字段，不能设定默认值为new Date()。
构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中
POJO类必须写toString()方法，如果继承了另一个POJO类，需要在前面添加super.toString
禁止在POJO类中，同时存在对应属性xxx的isXxx()和getXxx()方法
【推荐】类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter 方法
【推荐】类成员与方法访问控制从严：工具类不允许有public或default构造方法
不允许在程序任何地方中使用:1)java.sql.Date。 2)java.sql.Time。 3)java.sql.Timestamp。
关于hashCode和equals的处理：

只要覆写 equals，就必须覆写 hashCode。(如果不覆写hashCode方法，就会违反规定：通过equals方法判定为相等的对象，必须有相同的hashCode）
因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写这两种方法。
如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals

判断所有集合内部的元素是否为空，使用isEmpty()方法，而不是size()==0的方式。
在使用java.util.stream.Collectors类的toMap()方法转为Map集合时，一定要注意当 value 为 null 时会抛 NPE 异常。
使用Map的方法keySet()/values()/entrySet()返回集合对象时，不可以对其进行添加元素操作，否则会抛出 UnsupportedOperationException 异常
使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一致、长度为 0 的空数组。
在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行 instanceof 判断，避免抛出 ClassCastException 异常。
【推荐】集合初始化时，指定集合初始值大小。如果能确定集合需要存储的元素数量，则在创建集合的时候，需要指定集合大小，避免集合在容量满后，被动扩容。

反例：HashMap需要放置1024个元素，由于没有设置容量初始大小，随着元素增加而被迫不断扩容，resize()方法总共会调用 8 次，反复重建哈希表和数据迁移。当放置的集合元素个数达千万级时会影响程序性能。

使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。说明:keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.forEach 方法。
创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static，必须加锁，或者使用 DateUtils 工具类。
必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理自定义的ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用 try-finally 块进行回收。

数据库开发规范

表命名规范：

实体表使用尽量准确的英文单数表示，若一个英文单词不足以表示表的意义，可用下横杠分割，小写命名。备份以bak_开头，分表以pt_开头，归档表以arch_xxxx_开头，临时表以tmp_开头，日志表以log_开头。

索引：非唯一索引命名为 idx_列名1_列名2，唯一索引命名为 uk_列名1_列名2，如果列名太长或列太多，可酌情精简
字符集统一使用utf8mb4 ， ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT=‘XXXXXX-应用名称’;
所有表和字段都尽量需要添加注释
可以使用tinyint存储状态值。比enum减少cpu开销，且容易维护。建议使用 UNSIGNED 存储非负数值，相比不使用 unsigned，可以扩大一倍使用数值范围。

使用decimal 需要额外的空间和计算开销，所以应该尽量只是在对小数进行精确计算的时候才使用，例如存储财务数据。如果数据量大，也可以考虑使用bigint来存储，这样能避免使用浮点存储不精确和decimal精确存储代价高的问题。
涉及金额字段，数额 * 100 ，用int存

时间类型：时间类型统一用datetime，如涉及时区，则用timestamp

每个表中都必须包含2个字段：
r_add_time datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT ‘创建时间’,
r_modified_time datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT ‘修改时间’

除了必须为NULL，建议字段都定义为NOT NULL因为null值会影响cordinate统计，影响优化器对索引的选择，而且需要额外的存储空间。
不允许使用join，left join，请将复杂查询拆分为多个简单查询，减少锁表的范围和时间，这条短期内难以实现。对于对于20W以上的表建议不要联表查询。禁止在dml语句中使用join。
where条件中不要使用函数或进行(隐式)强制转换
拒绝大事务：比如在一个事务里进行多个select，多个update，如果是高频事务，会严重影响MySQL并发能力，因为事务持有的锁等资源只在事务rollback/commit时才能释放
数据库中不允许使用视图、函数、触发器、存储过程、外键
不对大字符串、长文本全部加索引，要么加部分索引，如果字符串的前几个字符的选择度比较高，可以新建部分索引
alter table table_name add key idx_code (field(10));
一般情况下，表结构变更尤其是表空间大于1G的表变更放到晚上业务低峰期进行
DMS 上提交DML工单，白天提交的每个工单影响行数不超过2000, 影响行数超过2000请分批提交, 建议非紧急情况下影响行数大于1w的数据订正放到晚上业务低峰期进行.（特别是商品中心的数据库).
上线业务sql均走索引

那些开发过程中需要遵守的开发规范相关推荐

开发过程中应该遵守哪些编码规范和class命名规范？
这里是修真院前端小课堂,每篇分享文从[背景介绍][知识剖析][常见问题][解决方案][编码实战][扩展思考][更多讨论][参考文献]八个方面深度解析前端知识/技能. 本篇分享的是:开发过程中应该遵守哪 ...
html5class命名规范,开发过程中应该遵守哪些编码规范和class命名规范？
一.背景介绍为什么要遵守编码规范? 1.好的编码规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护: 2.好的编码规范可以改善软件的可读性 ...
项目开发过程中如何使用免费开发手机验证码验证功能（详细教程）
一群热爱技术并且向往优秀的程序猿同学,不喜欢水文,不喜欢贩卖焦虑,只喜欢谈技术,分享的都是技术干货.Talk is cheap. Show me the code 首先声明一下,这个Demo仅限用于开 ...
java开发过程中的命名规范
为什么80%的码农都做不了架构师?>>> 最近在读项目的过程中,发现好多同事的代码并不是很规范,有的包名也按照了驼峰的写法,虽说这样不是不行,但个人认为开发过程中应该遵守这些规 ...
互联网金融之应用系统安全开发规范
整体研发流程管理规范文档模板附件见: https://gitee.com/471351719/DPM 为规范公司线上系统.后台系统等业务系统的安全开发,使开发人员明确在开发过程中需要遵守的安全要求,保 ...
大数据平台后端一些开发规范
大家好,我是脚丫先生 (o^^o) 集团大数据平台之流批一体的建设之后. 一直想着能研发一套自己沉淀的小型大数据平台项目. 之后能与小伙伴们多多交流. 在研发的过程中,总结一些开发规范(参考全网),希 ...
《MySQL开发规范》过时了，视图的查询性能提升了一万倍
MySQL 8.0新特性专栏目录 <MySQL开发规范>过时了,视图查询性能提升了一万倍你真的会用EXPLAIN么,SQL性能优化王者晋级之路索引三剑客之降序索引和不可见索引千呼万唤 ...
开发过程中js遇到的问题及一些基础知识恶补
Supermarket 开发过程中js遇到的问题及一些基础知识恶补函数相关问题 DOM元素相关操作变量操作异常捕获开发过程中关于条形码识别开发结束关于前端板块思路函数相关问题 (funct ...
java编码规范文档下载_软件项目实训及课程设计指导——制定待开发项目中各种文档的规范...
软件项目实训及课程设计指导--制定待开发项目中各种形式文档的规范 1.制定对课程设计项目开发过程中的规范性要求 (1)从"形式"到"内容"两个方面控制和要求开发 ...

那些开发过程中需要遵守的开发规范

文章目录

阿里规约

数据库开发规范

那些开发过程中需要遵守的开发规范相关推荐

最新文章

热门文章