编程规约

一、各层的明明规约

Service/DAO 层方法命令规约：

• 获取单个对象的方法用 get 做前缀
• 获取多个对象的方法用 list 做前缀
• 获取统计值的方法用 count 做前缀
• 插入的方法用 save/insert 做前缀
• 删除的方法用 remove/delete 做前缀
• 修改的方法用 update 做前缀

领域模型命名规约：

• 数据对象：xxxDO，xxx 即为数据表名
• 数据传输对象：xxxDTO，xxx 为业务领域相关的名称
• 展示对象：xxxVO，xxx 一般为网页名称
• PIJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO

二、常量定义

1、long 或者 Long 初始赋值时，使用大写的 L，不能是小些的 l，小写容易跟数字 1 混淆，造成误解。

说明：Long a = 2l; 写的是数字的21，还是 Long 型的 2？

2、如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。下面正例中的数字就是延伸信息，表示星期几。

正例：public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7); }

三、OOP 规约

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

2、外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加 @Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

3、不能使用过时的类或方法

说明： java.net.URLDecoder