JAVA基础篇(8)-命名规则

JAVA && Spring && SpringBoot2.x — 学习目录

阿里巴巴Java开发手册终极版v1.3.0.pdf

  1. 【强制】代码中的命名均不能以下划线或$开始和结束。
  2. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。(即使纯拼音命名也要避免)。
  3. 【强制】类名使用UpperCamelCase(首字母大写)风格,必须遵从驼峰形式,但是以下情形例外:DO/BO/DTO/VO/AO
  4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
    正例:localValue、getHttpMessage()
  5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整,不要嫌名字长。
  6. 【强制】抽象类命名使用Abstract或Base开头,异常类使用Exception结尾,测试类命名以它要测试的类的名称开始,以Test结尾。
  7. 【强制】中括号是数组类型的一部分,数组定义如下:String[] args;
    反例:使用String args[]的方式来定义。
  8. 【强制】POJO类中的boolean类型,都不要加is,否则部分框架解析会引起序列化错误。
    反例:定义为基本类型Boolean isDeleted;的属性,它的方法也是isDeleted(),RPC框架在反向解析的时候,“以为”对应的属性名称是deleted,导致属性获取不到,进而抛出异常。
  9. 【强制】包名统一使用小写,点分割符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
    正例:应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考spring框架结构)
  10. 【强制】杜绝完全不规范的缩写,避免望文不知义。
    反例:AbstractClass“缩写”命名成AbsClass。
  11. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。
    正例:从远程仓库拉取代码的类命名为PullCodeFromRemoteRepository。
    反例:变量int a;的随意命名方式。
  12. 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。
  13. 【推荐】接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加上有效的javadoc注释,尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础变量。
  14. 接口和实现类的命名规则
    • 【强制】对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl后缀与接口区分。
    • 【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是-able的形式1)
      正例:AbstractTranslator实现Translatable接口。
  15. 【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。
    正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS/UNKOWN_REASON。
  16. 【参考】各层命名规范
    16.1 Service/DAO层方法命名规范
    * 获取单个对象的方法用get做前缀;
    * 获取多个对象的方法用list做前缀;
    * 获取统计值得方法用count做前缀;
    * 插入的方法用save/insert做前缀;
    * 删除的方法用remove/delete做前缀;
    * 修改的方法用update做前缀;
    16.2 领域模型命名规范
    * 数据对象:XXXDO,xxx即为表名;
    * 数据传输对象:XXXDTO,xxx为业务领域相关的名称;
    * 展示对象:XXXVO,XXX一般为网页名称;
    * POJO是DO/PO/DTO/BO/VO的统称,禁止命名为XXXPOJO。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容