Java基础篇-命名规范

基本原则

1. 驼峰式命名
2. 不能以数字开头
3. 可以使用_、$、数字；
4. 避免关键字

代码规约

1. 严禁拼音、中文；推荐使用完整单词组合，尽量避免英文缩写（除预定俗成的，例i18n，http，tcp/ip之类）
2. 严禁_、$开头或结尾
3. 驼峰原则，但是要避免例外情况（DO、BO、DTO、UID、XML之类）

• 项目名称，全小写，用 - 分割
• 模块命名
• 包名全小写，用 . 分隔，且分隔符间仅含1个单词
• 类名驼峰命名，推荐采用名词
  • 测试类以Test结尾
  • 常量类以Const结尾
  • 枚举类以Enum结尾
  • 抽象类Abstract\Base开头
  • 异常类Exception结尾
  • 配置类Prop、Properties、Configuration结尾
  • 实体类 Entity DO（DatabaseObject） VO（ViewObject） DTO（DataTransportObject）BO（BusinessObject）等结尾
  • 工具类使用Utils结尾
• 变量名采用名词，尽量表达清楚语境语义；
  • 成员变量
  • 局部变量
  • 常量全大写，用_分隔单词
  • 方法参数
  • 数组命名，类型和中括号紧挨表示数组
  • 布尔值命名勿用isXXX，部分框架解析会忽略is，导致属性获取不到；
• 方法命名采用动词
  • mapper方法规约
    • 增 save、insert前缀
    • 删 delete、remove前缀
    • 改 update前缀
    • 查单个 get、find前缀
    • 查多个 list前缀
    • 统计 count前缀
• 实例值：
  - 严禁使用未定义的魔法值
  - Long类型赋值末尾L采用大写，严禁小写；

4. 其他规范
   • 接口名称常用Service结尾，以impl为实现类；形容能力的接口推荐用-able结尾，推荐or结尾为实现类（translatable， xxxxTranslator）
   • 在类或者方法上使用设计模式，在具体命名中体现出设计模式（Proxy，Factory，Builder）