阿里巴巴开发手册笔记

时间:2023-01-10 03:22:48

学习阿里巴巴开发手册的时候为了防止一些以后忘记的东西,写个博客记录一下(仅此而已)。

一编程约规

  (一)命名风格

    8.【强制】POJO类中布尔类型的变量,都不要加is前缀,否则部分框架解析会引起序列化错误。

      反例:定义为基本数据类型Boolean isDeleted的属性,它的方法也是isDeleted(),RPC框架在反向解析的时候,“误以为”deleted导致属性获取不到,进而抛出异常。

    12.【推荐】如果模块,接口,类,方法中使用了设计模式,在命名的时候体现出具体模式。

      说明:将设计模式体现在名字中,有利于阅读之快速理解架构设计理念。

      正例:public  class  OrderFactory;     public  class  LoginProxy;  public  class  ResourceObserver(观察者模式) 

    13【推荐】接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加上有效的Javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。

      正例:接口方法签名:void f();

         接口基础常量:String Company = "alibaba";

      反例:接口方法定义:public abstract void f();

      说明:jdk8中接口允许有默认实现,那么整个default方法,是对所有实现类都有价值的实现。

    14.接口和实现类的命名有两套规则:

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

      正例:CacheServiceImpl实现CacheService接口。 

      2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able的形式)。

      正例:AbstractTranslator实现Translatable。

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

       说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。

      正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS/ UNKOWN_REASON。

    16.【参考】各层命名规约:

      A)Service/DAO层方法命名规约

       1)获取单个对象的方法用get做前缀。  

       2)获取多个对象的方法用list做前缀 

       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