手册下载链接:https://pan.baidu.com/s/1s8esZSYZbRQW2IAQk3wZuw 提取码:i6ui
1、命名风格
代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束
代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式
类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO / PO / UID等
方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式
常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长(eg:CACHE_EXPIRED_TIME)
抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类以类名开头,以 Test 结尾
类型与中括号紧挨相连来表示数组
POJO 类中布尔类型变量都不要加 is 前缀,否则部分框架解析会引起序列化错误
包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词
包名统一使 用单数形式,但是类名如果有复数含义,类名可以使用复数形式
避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低
杜绝完全不规范的缩写,避免望文不知义
对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别
数据对象:xxxDO,xxx 即为数据表名
数据传输对象:xxxDTO,xxx 为业务领域相关的名称
展示对象:xxxVO,xxx 一般为网页名称
POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO
2、常量定义
不允许任何魔法值(即未经预先定义的常量)直接出现在代码中
在 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字1混淆,造成误解
常量的复用层次有五