1.【强制】BC_MM_01:代码中的命名均不能以下划线或者美元符号开始也不能以下划线或美元符号结束。
2.【强制】BC_MM_02:代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
3.【强制】BC_MM_03:类名使用UpperCamelCase风格,但DO/BO/DTO/VO/AO/PO 等除外。
4.【强制】BC_MM_04:方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵守驼峰格式。
5.【强制】BC_MM_05:常量命名全部大写,单词间用下划线隔开,力求予以表达完整,不要嫌名字长。
6.【强制】BC_MM_06:抽象类命名使用Abstract 或 Base 开头:异常类明明使用Exception结尾;测试类名以Test+类名的方式。
7.【强制】BC_MM_07:类型与中括号之间无空格相连定义数组。
8.【强制】BC_MM_08:POJO 类中布尔类型变量都不要加is前缀,否则部分框架解析会引起序列化错误。
9.【强制】BC_MM_09:杜绝不规范的缩写,避免词不达义。如AbstractClass->AbsClass
10.【推荐】BC_MM_10:为了达到代码自解释的目标,任何定义变成元素在命名时,使用尽量完整的单词组合来表达其意。
11.【推荐】BC_MM_11:如果模块、接口、类、方法使用了设计模式,应在命名时体现出具体模式。
12.【推荐】BC_MM_12:接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加航有效的javadoc注释。尽量不要再接口里定义变量,如果一定要定义变量,必须要时与接口方法相关的,并且时整个应用的基础常量。
13.【强制】BC_MM_13:对于Service和Dao类,基于SOA的理念,暴力出来的服务一定是接口,内部的实现类用impl后缀与接口区别。
14.【推荐】BC_MM_14:如果是形容能力的接口名称,取对应的形容词为接口名(通常时-able的形式)。
15.【参考】BC_MM_15:枚举类名带上Enum后缀,美剧类成员需要全大写,单词间用下划线隔开。
16.【参考】各层命名规约
1)Service/Dao层方法命名规约如下。
获取单个对象的方法用get作为前缀。
获取多个对象的方法用list作为前缀。
获取统计值的方法用count作为前缀。
插入的方法用save/insert 作为前缀。
删除的方法用remove/delete 作为前缀。
2)领域模型命名规约如下。
数据对象:xxxDo,xxx为数据表名。
数据传输对象:xxxDTO,xxx为业务领域相关的名称。
展示对象:xxxVO,xxx 一般为网页名称。
POJO 是DO/DTO/BO/VO 的统称,禁止命名成xxxxPOJO。