命名风格
- 代码命名不能以下划线或者美元符号开头或者结尾
- 代码命名不能以中文拼音或者中文拼音与英文混合方式
- 类名使用UpperCamCamelCase风格，但DO、PO、DTO、VO、BO等除外
- 方法名、参数名、变量名统一使用lowerCamelCase，必须遵守驼峰命名
- 常量名全部大写，单词间用下划线隔开
- 抽象类必须以Abstract或者Base开头，异常类必须以Exception结尾，测试
类以测试的类的名称开头Test结尾 - 类型与中括号紧挨相连标示数组
- POJO类中布尔类型变量不要加is前缀
- 包名统一小写，点分隔符有且有一个自然语义单词
- 避免在父子类和不同代码块中采用相同变量名
- 避免不规范的缩写命名
- 在对元素命名时用完整单词组合表达其意
- 常量和变量命名时，表示类型放在词尾，如：idList、TERMINATED_TREAD_COUNT
- 接口、类、方法、模块使用设计模式，命名时要体现具体模式
- 接口类中的方法和属性不要加任何修饰符，并加上有效的javadoc。
- 接口和实现类的命名规则：
1、对于service和dao类，实现类必须用Impl结尾；
2、如果是形容能力的接口名称，取对应的形容词为接口名 AbstractTranslator实现 Translatable接口 - 枚举类名加Enum后缀，枚举成员名称全大写，单词间用下划线隔开
- 各层命名规范：
A) Service/DAO层命名规约
1.获取单个对象的方法用get做前缀
2.获取多个对象的方法用list做前缀，如：listObjects
3.获取统计值的方法用count做前缀
4.插入方法用save/insert做前缀
5.删除方法用delete/remove做前缀
6.修改方法用update做前缀
B）领域模型命名规范
1.数据对象：xxxDO, xxx为数据库表名
2.数据传输对象：xxxDTO,xxx为业务模型相关名称
3.展示对象：xxxVO，xxx一般为网页名称
4.POJO是对DO、DTO、VO、BO的统称，禁止xxxPOJO
常量定义
- 在Long类型中赋值，数值后使用大写L
- 不要在一个常量类中维护所有常量，要根据功能分开维护
- 常量的复用层次：
1.跨应用：放在二方库中，通常在constant目录下
2.应用内：放在一方库中，通常在constant目录下
3.子工程内：放在当前子工程constant目录下
4.包内共享常量：当前包下单独的constant目录下
5.类内共享常量：直接在类内部private static final定义 - 如果变量值只在固定的范围内变化，用enum类型定义
代码格式
- 如果大括号代码为空直接’{}’,大括号内有代码则：左大括号左侧不换行，右侧换行；右大括号右侧换行，左侧如果不跟else等代码换行，否则不换行
- 小括号和字符之间不能有空格，括号内字符和运算符之间有空格 如：if (a == b)
- if、for、while、do、switch与括号之间必须有空格
- 任何二目、三目运算符前后必须有空格
- 采用4个空格，禁止使用tab
- 注释的双斜线和内容要有空格
- 强制类型转换时，右括号与强制转换值之间不用空格
- 单行字符不超过120个，超过要换行
- 方法在定义和传参时，必须要加空格
- IDE的text file encoding 设置为UTF-8；IDE中 文件的换行符使用Unix格式
- 单个方法尽量不超过80行
- 不同逻辑、不同语义、不同业务之间的代码插入一个空行分隔符
oop规约
- 不用一个类型的对象引用来访问静态方法和静态属性，直接类名访问即可
- 所有覆写方法，必须加@Override注解
- 相同业务含义，相同参数类型才能使用java可变参数
- 外部依赖或者二方库依赖的接口，不能修改方法签名。接口过时必须用@Deprecated 注解，并说明新接口或者新服务是什么
- 不能使用过时的类或者方法
- Object的equals方法容易抛出空指针，应使用常量或者确定值的对象来调用equals
- 所有整型包装类之间的值比较都用equals 方法比较
- 浮点数之间的等值判断，基本类型不能用==，包装类不能用equals。
解决方案：(1) 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。
(2) 使用BigDecimal来定义值，再进行浮点数的运算操作。 - 定义DO类时，属性类型要数据库字段类型相匹配
- 防止精度丢失，禁止使用BigDecimal(double)方式将double对象转换成BigDecimal。建议使用BigDecimal的valueOf方法
- 基本类型和包装类型的使用标准
1.所有POJO的属性必须用包装类型
2.RPC方法的参数和返回值必须使用包装类型
3.所有局部变量使用基本变量 - 所有POJO 不要对其属性设置默认值
- 序列化类新增时不要修改其serialVersionUID字段
- 构造方法里禁止加任何业务处理逻辑，有要加在init()
- POJO类必须要写toString方法
- 禁止在POJO类中对属性xxx 同时存在isXxx()和getXxx()
- 使用索引访问用String的split方法得到数组时，需要对最后一个分隔符有无内容做检查
- 一个类有多个构造方法或者多个同名方法，要按照顺序来。
- 类中的方法顺序 ：共有方法-> 私有方法 -> get/set
- setter方法中参数名称和成员变量名称一致，不要在getter和setter方法中加业务逻辑
- 循环体内用StringBuilder的append方法进行扩展
- final可以修饰类，方法，变量。
- 慎用Object的clone方法
- 类成员与方法访问控制从严
1） 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
2） 工具类不允许有public或default构造方法。
3） 类非static成员变量并且与子类共享，必须是protected。
4） 类非static成员变量并且仅在本类使用，必须是private。
5） 类static成员变量如果仅在本类使用，必须是private。
6） 若是static成员变量，考虑是否为final。
7） 类成员方法只供类内部调用，必须是private。
8） 类成员方法只对继承类公开，那么限制为protected。
mysql建表规约
- 表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsigned tinyint（1表示是，0表示否）
- 表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑
- 表名不使用复数名词
- 禁用保留字，如desc、range、match、delayed等，请参考MySQL官方保留字
- 主键索引名为pk_字段名；唯一索引名为uk_字段名；普通索引名则为idx_字段名
- 小数类型为decimal，禁止使用float和double
- 如果存储的字符串长度几乎相等，使用char定长字符串类型
- varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率
- 表必备三字段：id, create_time, update_time
- 表的命名最好是遵循“业务名称_表的作用”
- 库名与应用名称尽量一致
- 字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循： 1） 不是频繁修改的字段。 2） 不是varchar超长字段，更不能是text字段。3） 不是唯一索引的字段。
- 如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释
- 单表行数超过500万行或者单表容量超过2GB，才推荐进行分库分表
- 合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度
索引规约
- 业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引
- 超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引
- 在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可
- 页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决
- 如果有order by的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，影响查询性能
- 利用覆盖索引来进行查询操作，避免回表
- 利用延迟关联或者子查询优化超多分页场景
- SQL性能优化的目标：至少要达到 range 级别，要求是ref级别，如果可以是consts最好
- 建组合索引的时候，区分度最高的在最左边
- 防止因字段类型不同造成的隐式转换，导致索引失效
- 创建索引时避免有如下极端误解： 1） 宁滥勿缺。认为一个查询就需要建一个索引。 2） 宁缺勿滥。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。 3） 抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。
sql语句
- 不要使用count(列名)或count(常量)来替代count()，count()是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关
- count(distinct col) 计算该列除NULL之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0
- 当某一列的值全是NULL时，count(col)的返回结果为0，但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE问题
- 使用ISNULL()来判断是否为NULL值
- 代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句
- 不得使用外键与级联，一切外键概念必须在应用层解决
- 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性
- 数据订正（特别是删除、修改记录操作）时，要先select，避免出现误删除，确认无误才能执行更新语句
- in操作能避免则避免，若实在避免不了，需要仔细评估in后边的集合元素数量，控制在1000个之内
- 如果有国际化需要，所有的字符存储与表示，均以utf-8编码，注意字符统计函数的区别
- TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句
orm映射
- 在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明
- POJO类的布尔属性不能加is，而数据库字段必须加is_，要求在resultMap中进行字段与属性之间的映射
- 不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个POJO类与之对应
- sql.xml配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现SQL注入
- iBATIS自带的queryForList(String statementName,int start,int size)不推荐使用
- 不允许直接拿HashMap与Hashtable作为查询结果集的输出
- 更新数据表记录时，必须同时更新记录对应的gmt_modified字段值为当前时间
- 不要写一个大而全的数据更新接口。传入为POJO类，不管是不是自己的目标更新字段，都进行update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行SQL时，不要更新无改动的字段，一是易出错；二是效率低；三是增加binlog存储
- @Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等
- 中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件；表示不为空且不为null时执行；表示不为null值时执行
434
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
