公司技术规范模板

第一章 介绍

1. 1. 本规范分为二个章节

• 第一章 – 介绍
• 第二章 – 代码编写规范

1. 2. 语言

本文中用到的关键字 必须=强制。不能=强制。要求=强制,如果有特殊情况，需要商讨后决定是否可以解除此次强制。应该=不强制，但如果不遵守，可能会出现意外情况。不应该=不强制，但如果不遵守，可能会出现意外情况。推荐=不强制，根据经验总结出的相对较好的方案, 可以不遵守。可以=不强制，明确指定允许做的事情。可选=不强制，任选其一，可以都不选择。

第二章 代码编写规范

1. 1. 推荐：不使用双重否定

目的：1.增加可读性

例如 :
(错误示例) 1.isNotFoundNotExistByKey(是否找不到不存在的KEY )
(正确示例) isExistByKey(是否存在KEY )

1. 2. 推荐：DB层的API命名 计数方法count作为前缀，查询方法find作为前缀，增加方法insert作为前缀，修改方法update作为前缀，删除方法delete作为前缀

目的：1.为AOP做铺垫。2.增加可读性。3.与业务隔离

注： API指对外暴露的服务名称
　　 计数方法指 count（*）,只返回个数的查询方法

1. 3. 推荐：DB层的Mapper命名 计数方法count作为前缀，查询方法find作为前缀，增加方法insert作为前缀，修改方法update作为前缀，删除方法delete作为前缀

目的：1.为读写分离的数据源AOP做铺垫。2.增加可读性。3.与业务隔离

注： Mapper指Mybatis的 xml文件与接口
　　 计数方法指 count（*）,只返回个数的查询方法

1. 4. 推荐：自2019年3月8日后新编写的代码，DB服务SQL只允许写在xml文件中。

目的：1.增加可维护性。

第三章 SQL语句规范

1. 1. 推荐：用嵌套查询替代挂表查询（特别是大表！）

目的：1.增加性能。2.优化磁盘IO

反例：

正例：