编码规范-Jeesan0620

1.1 【强制】代码中的命名均不能以下划线或美元符号开始和结束

1.2 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式

1.3 【强制】ClassName除DO / BO / DTO / VO / AO /PO / UID以外使用 UpperCamelCase 风格

1.4 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格

1.5 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长

1.6 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾

1.7 【强制】类型与中括号紧挨相连来表示数组

1.8 【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误

1.9 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。
包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式

1.10 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。

1.11 【强制】杜绝完全不规范的缩写，避免望文不知义

1.12 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。

1.13【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度

1.14 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式

1.15 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量

1.16 【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别

1.17 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有

1.18 各层命名规约

2.1 【强制】不允许任何未经预先定义的常量（魔法值）直接出现在代码中

2.2  【强制】在 long 或者 Long 赋值时，数值后使用大写的 L

2.3 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护
说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解，也不利于维护

2.4 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包
内共享常量、类内共享常量。

2.5 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

3.1 【强制】如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非
空代码块则：
1） 左大括号前不换行。
2） 左大括号后换行。
3） 右大括号前换行。
4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

3.2【强制】左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空
格；而左大括号前需要加空格。详见第 5 条下方正例提示。
反例：if (空格 a == b 空格)

3.3【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

3.4【强制】任何二目、三目运算符的左右两边都需要加一个空格

3.5 【强制】采用 4 个空格缩进，禁止使用 tab 字符

3.6 【强制】注释的双斜线与注释内容之间有且仅有一个空格

3.7 【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开

3.8 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）方法调用中的多个参数需要换行时，在逗号后进行。
5）在括号前不要换行

3.9 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

3.10【推荐】单个方法的总行数不超过 80 行

3.11 【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐

3.12 【推荐】同时定义多个变量时，在不影响逻辑的情况下，先后顺序按照由短变长的顺序创建

4.1 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成
本，直接用类名来访问即可

4.2 【强制】所有的覆写方法，必须加@Override 注解
说明：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判
断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错

4.3 【强制】所有整型包装类对象之间值的比较，全部使用 equals 方法比较
说明：对于 Integer var = ? 在-128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，
会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，都
会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断

4.4 【强制】浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals
来判断。使用BigDecimal类并通过equals来判等

4.5 .【强制】禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象，优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常

4.6 关于基本数据类型与包装数据类型的使用标准

4.7 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值

4.8 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中

4.9 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString
时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。
说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题

4.10 【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。
说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到，神坑之一

constant(跨应用共享常量)

核心模块

文件上传模块

业务模块

constant(跨应用共享常量)

核心模块

文件上传模块

业务模块