命名规范及变量定义
- 类名:UpperCamelCase
- 方法,参数,局部变量,成员变量:lowerCamelCase
- 常量:全部大写,下划线隔开单词
- 抽象类:以Abstract或者Base开头
- 异常类:以Exception结尾
- 测试类:以Test结尾
- POJO类中布尔类型的变量:不要加is,部分框架解析会引起序列化的错误
- 包名:全部小写,点分隔单词
- 缩写:尽量不要,名字长没关系,可读性第一
- 设计模式:如果使用到尽量在类名中体现
- 接口类:方法和属性不要加修饰符,并加上有效的Javadoc注释,尽量不要在接口类中定义变量,除非是与接口方法有关并且是整个应用的基础变量
- 接口及实现类:暴露出来的一定是接口,实现用Impl后缀,实现接口类
- 枚举类:成员名全大写+下划线
- Service/DAO命名规约:获取单个:get;获取多个:list;获取统计:count;插入:save/insert;删除:remove/delete;修改:update。
- 常量定义:为避免冲突及冗余,定义共享常量需在固定位置(分为五层共享)