一、命名风格

  1. 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束
  2. 所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式
  3. 类名使用UpperCamelCase风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID等
  4. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格
  5. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长
  6. 抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾
  7. 类型与中括号紧挨相连来表示数组
  8. POJO类中的任何布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误
  9. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式
  10. 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低
  11. 杜绝完全不规范的缩写，避免望文不知义
  12. 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达
  13. 在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度
  14. 如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式
  15. 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量
  16. 接口和实现类的命名有两套规则
  17. 枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开
  18. 各层命名规约：
    A) Service/DAO层方法命名规约
      1） 获取单个对象的方法用get做前缀
      2） 获取单个对象的方法用get做前缀
      3） 获取统计值的方法用count做前缀
      4） 插入的方法用save/insert做前缀
      5） 删除的方法用remove/delete做前缀
      6） 修改的方法用update做前缀
    B) 领域模型命名规约
      1） 数据对象：xxxDO，xxx即为数据表名
      2） 数据传输对象：xxxDTO，xxx为业务领域相关的名称
      3） 展示对象：xxxVO，xxx一般为网页名称
      4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO

二、定义常量

  1. 不允许任何魔法值（即未经预先定义的常量）直接出现在代码中
  2. 在long或者Long赋值时，数值后使用大写的L，不能是小写的l，小写容易跟数字混淆，造成误解
  3. 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护
  4. 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
      1） 跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
       2） 应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。
       3） 子工程内部共享常量：即在当前子工程的constant目录下。
       4） 包内共享常量：即在当前包下单独的constant目录下。
       5） 类内共享常量：直接在类内部private static final定义。
  5. 如果变量值仅在一个固定范围内变化用enum类型来定义。