说明:此文主要摘自《阿里巴巴java开发手册》,由于笔者平时部分遵循了里面的编程规约,觉得非常有道理,故摘取部分如下:
1、程序中方法名、参数、成员变量、局部变量统一使用lowerCamelCase风格,即小驼峰模式
举例:
String getUserInfo(int userId){
String userName = getUserNameByUserId(userId);
}
这里方法名getUserInfo,参数userId,局部变量userName均为lowerCamelCase,即首单词小写,随后单词首字母大写
2、常量全部大写,如果为不可变常量,加final
举例:
String final SUCCESS_CODE="SUCCESS";
int MAX_VALUE=9999;
3、如果是集合类类型,如List,Map等变量,在遵循lowerCamelCase的同时,把类型写在最前面
举例:
int[] arrayDemo;
ArrayList<String> listStudent;
4、类名使用UpperCamelCase风格,但以下情形例外:DO / BO / DTO /VO / PO / AO /UID等,因为他们通识都是写成大写
举例:
UserDO
5、如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。将设计模式体现在名字中,有利于阅读者快速理解架构设计理念
举例:
public class OrderFactory
6、各层命名规约
A) Service/DAO 层方法命名规约
- 获取单个对象的方法用get做前缀
- 获取多个对象的方法用list做前缀,复数形式结尾如:listObjects
- 获取统计值的方法用count做前缀
- 插入的方法用save/insert做前缀
- 删除的方法用remove/delete做前缀
- 修改的方法用update做前缀
B) 领域模型命名规约
- 数据对象:xxxDO,xxx即为数据表明
- 数据传输对象:xxxDTO,xxx为业务领域相关的名称
- 展示对象:xxxVO,xxx一般为网页名称
- POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO