资讯专栏INFORMATION COLUMN

阿里Java开发手册节选(嵩山版)

xuhong / 465人阅读

摘要:虚静出内功代码规范节选代码命名均不能以下划线或者美元符号开始,也不能以下划线或美元符号结束所有编程相关命名都严禁使用拼音和英文混合方式,也不允许直接使用中文类名使用风格,但以下情形例外等,正确命名示例等方法名参数名成员

虚静出内功


代码规范(节选)
  1. 代码命名均不能以下划线或者美元符号开始,也不能以下划线或美元符号结束
  2. 所有编程相关命名都严禁使用拼音和英文混合方式,也不允许直接使用中文
  3. 类名使用UpperCamelCase风格,但以下情形例外:DO/BO/DTO/VO/AO/PO/UID等,
    正确命名示例:ForceCode、UserDao、HtmlDTO等
  4. 方法名、参数名、成员变量、局部变量统一使用lowerCamelCase风格,
    正确命名示例: localValue、getHttpMessage()
  5. 常量命名全部大写,单词间用下划线隔开,如:MAX_STOCK_COUNT、CACHE_EXPIRED_TIME
  6. 抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾,测试类命名以它要测试的类的名称开始,以Test结尾
  7. 类型与中括号紧挨相连来表示数组,如:int[] arrayDemo
  8. POJO类中的任何布尔类型变量,都不要加is前缀,否则部分框架解析会引起序列化错误
  9. 包名统一使用小写,包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式
  10. 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名使可理解性降低
  11. 杜绝完全不规范的缩写,避免望文不知义,反例:AbstractClass缩写成AbsClass; condition缩写成condi;Function缩写成Fu 。自定义编程元素在命名时,使用尽量完整的单词组合来表达
  12. 常量与变量命名时,表示类型的名词放在词尾,以提升辨识度,如:startTime、nameList
  13. 接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码简洁性,并加上有效的javadoc注释,尽量不要在接口中定义变量
  14. 对于Service和DAO类,基于SOA理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口区别
  15. 各层命名规约:
    1. Service/DTO层方法命名规约:
      • 获取单个对象的方法用get做前缀
      • 获取多个对象的方法用list做前缀,复数结尾,如listObjects
      • 获取统计值的方法用count做前缀
      • 插入的方法用save/insert做前缀
      • 删除的方法用remove/delete做前缀
      • 修改的方法用update做前缀
    2. 领域模型命名规约:
      • 数据对象:xxxDO, xxx即为数据表名
      • 数据传输对象:xxxDTO, xxx为业务领域相关的名称
      • 展示对象:xxxVO, xxx一般为网页名称
      • POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/122171.html

相关文章

  • 新增16条设计规约!阿里巴巴Java开发手册(详尽)开放下载!

    摘要:熟悉和遵守阿里巴巴开发手册的编程风格,那只是标,而代码可读性的本可以追溯到软件设计阶段。何为条设计规约是根据阿里巴巴实际项目架构经验提炼而成,共条。本次新增的不单是条新的设计规约,还是千万阿里人的技术之心。 摘要:2018年6月,《阿里巴巴Java开发手册》再次刷新代码规范认知,我们新增了16条设计规约!现免费开放下载,不可错过!《阿里巴巴Java开发手册》是阿里内部Java工程师所遵...

    _ang 评论0 收藏0
  • 阿里巴巴java开发手册学习记录,php

    摘要:的类型均为类型,前者现在时表示主动创建,后者过去分词表示被动更新。推荐单表行数超过万行或者单表容量超过,才推荐进行分库分表。超过三个表禁止。防止因字段类型不同造成的隐式转换,导致索引失效。说明会统计值为的行,而列名不会统计此列为值的行。 一.编程规约 (一)命名风格 1.目录使用小写+下划线 home,view,model,admin_view 2.类 UpperCamelCa...

    Chao 评论0 收藏0
  • 阿里巴巴java开发手册学习记录,php

    摘要:的类型均为类型,前者现在时表示主动创建,后者过去分词表示被动更新。推荐单表行数超过万行或者单表容量超过,才推荐进行分库分表。超过三个表禁止。防止因字段类型不同造成的隐式转换,导致索引失效。说明会统计值为的行,而列名不会统计此列为值的行。 一.编程规约 (一)命名风格 1.目录使用小写+下划线 home,view,model,admin_view 2.类 UpperCamelCa...

    wangym 评论0 收藏0
  • 坑爹的 Java 可变参数,把我整得够惨。。

    摘要:最近在写一个功能点,用了中的可变参数,真是把我搞得够惨。。我找到了阿里巴巴的开发手册中关于可变参数的规约。阿里巴巴也是不建议大家合作可变参数的,可知它带来的坑会有多坑。。 最近在写一个功能点,用了 Java 中的可变参数,真是把我搞得够惨。。 什么是可变参数? 就是方法参数用 Object... args 三个点形式,一个参数可以接收多个参数。 实际的代码就不帖了,来看这个示例吧: 示...

    Carson 评论0 收藏0
  • 常识之外的规范——阿里java开发手册笔记(全章节)

    摘要:说明这篇文章是我第一次认真阅读阿里巴巴开发手册终极版的笔记。说明本手册明确防止是调用者的责任。一年半载后,那么单元测试几乎处于废弃状态。好的单元测试能够最大限度地规避线上故障。 说明 这篇文章是我第一次(认真)阅读《阿里巴巴 Java 开发手册(终极版)》的笔记。手册本身对规范的讲解已经非常详细了,如果你已经有一定的开发经验并且有良好的编码习惯和意识,会发现大部分规范是符合常识的。所以...

    Martin91 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<