阿里巴巴java开发规范学习—编程规约:命令规则

        前不久公司安排实习生做了公司内的一个demo来熟悉业务,演示完后发现各种规范还是不太清楚,之后准备去阿里巴巴编码规范网站那考一个证书,于是准备好好学习一手规范,美化自己的代码。

  1. 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
  2. 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方法。
  3. 类名使用UpperCamelCase风格,必须遵守驼峰形式,以下情况例外:DO / BO / DTO / VO / AO。
  4. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
  5. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌弃字长。
  6. 抽象类命令使用Abstract或Base开头,异常类命名使用Exception结尾,测试类命令以它要测试的类的名称开始,以Test结尾。
  7. 中括号是数组类型的一部分,数组定义如下:String[] args。
  8. POJO类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误。
  9. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英文单词。包名统一使用单数形式,但是类名如果有复数意义,类名可以使用复数形式。
  10. 杜绝完全不规范的缩写,任何自定义编程元素在命名时,尽量使用完整的单词来表达其意。

推荐:

  1. 为了达到代码自解释的目标,任何自定义的编程元素在命令时,使用尽量完整的单词来表达其意。
  2. 如果模块、接口、类、方法中使用了设计模式,在命名时体现出具体模式。
  3. 接口中的方法和属性不要加任何修饰符(public也不要加),保持代码的简洁性,并加上有效的Javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定与接口方法有关,并且是整个应用的基础常量。
  4. 接口和实现类的命名有两套规则:

        (强制)对于Service和DAO类,基于SOA理念,暴露出来的服务一定是接口,内部的实现类使用Impl的后缀与接口区别。

        (推荐)如果是形容能力的接口名称,去对应的形容词做接口名(通常是-able的形式)。

        5.枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。

        6.各层命名规约:

        Service/DAO层方法命名规约
            获取单个对象的方法用get做前缀
            获取多个对象的方法用list做前缀
            获取统计值的方法用count做前缀
            插入的方法用save/insert做前缀
            删除的方法用remove/delete做前缀
            修改的方法用update做前缀

        领域模型命名规约:
            数据对象:xxxDO,xxx为数据表名
            数据传输对象:xxxDTO,xxx为业务领域相关的名称
            展示对象:xxxVO, xxx一般为网页名称
            POJO是DO/DTO/BO/VO的统称,禁止命名为xxxPOJO

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

才疏学浅的小缘同学

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值