阿里巴巴开发手册-摘录

1. 编程约定

1.1 命名规范

• 抽象类类名应以Abstract或Base开头;枚举以Enum结束;异常以Exception结束;
• 拒绝使用String arr [] 声明数组
• Pojo类的布尔值命名不能以is开关，反例：isSuccess不允许
• 包名使用单数，如：com.**.util
• 推荐使用设计模式类型来作结尾，如：LoginFacade,FoodFactory,UserProxy
• 接口成员不要加public abstract修饰
• 枚举成员和常量命名以全大写_分隔
• mvc各层命名规范：
  1. 持久层：get,save/insert,update,remove/delete,list*,count
  2. Pojo:
     • 数据对象： ***DO 数据库表名大驼峰DO
     • 数据传输对象： ***DTO 业务名DTO
     • 展示对象: ***VO 网页名称VO
     • POJO是所有DO/DTO/BO/VO的统称，不允许使用POJO命名类名

1.2 常量定义

• 不允许使用魔法值(未定义的常量)出现在代码中，如反例：status=1,1应当定义为常量，String key="redis_user_" + phone, "redis_user_"应当定义为常量
• long num = 2L,而不能long num=2l
• 常量以类型分类维护，如RedisKeyConsts,ConfigConsts,CacheConsts
• 常量共享分五层：
  1. 跨应用共享常量: 放在二方库的jar包constant目录下
  2. 应用内共享常量： 放在一方库的modules的constant目录下
  3. 子工程共享常量：子工程的constant目录下
  4. 包内共享常量： 放在当前包的constant目录下
  5. 类内共享常量：直接类顶部private static final

1.3 格式规范

• 方法体内 ，执行语句组、变量定义语句组，不同业务逻辑之间、不同语义之间插入一空行。

1.4 OPP规约

• 避免使用对象访问静态成员，应直接使用类名访问
• 所有重写必须加@Override
• 相同数据类型和业务含义，才能使用变长参数，避免使用Object... obj
• 类或方法过时，必须加@Deprecated;不能使用过时方法;
• 使用确定有值的对象来调用equals,如：“test”.equals(goods.getName()); 所有相同类型包装类对象比较使用equals而非==
• 基本类型和包装类使用标准：
  1. 所有pojo都必须使用包装数据类型
  2. RPC方法的返回值和参数都必须使用包装类
  3. 所有局部变量推荐使用基本数据类型
• pojo类不要设置任何默认值
• Pojo类要有serialVersionUID属性，且修改属性时，不要serialVersionUID的值，以避免反序列失败
• 构造方法禁止任何业务逻辑，应使用Init方法
• POJO类必须重写toString
• 多个构造方法和重名方法，应该按顺序放在一起
• 类内方法定义顺序： 公有方式或保护方法>私有方法>getset
• getset不要加任何业务逻辑
• 字符拼接应使用StringBuilder

//反例
String str = "start";
for(int i=0; i<100; i++){
str = str + "hello";
} 

• 声明final可提高程序响应效率
• 慎用.clone方法复制对象，.clone()是浅copy，应复写对象.clone()实现深copy复制对象属性。
• 类成员与控制访问
  1. 工具类不允许有public或default构造
  2. 不允许外部new的类，必须存在private构造
  3. 静态成员访问控制权限必须区分清楚，不应当过于宽泛，且要必须考虑能否final