美文网首页
阿里巴巴编码规范 一、编程规约

阿里巴巴编码规范 一、编程规约

作者: Zer01 | 来源:发表于2023-11-26 20:18 被阅读0次

    (二)常量定义

    1.【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

    2.【强制】在long 或者Long 复制时,数值后使用大写的L,不能时小写的l,小写容易跟数字1混淆,总成误解。

        说明:Long a = 2l;写的时数字的21,还是Long型的2。

    3.【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。

        说明:大二全的常量类,杂乱无章,使用查找红能才能定位到修改的常量,不利于理解和维护。    

        正例:缓存相关常量放在类CacheConsts 下;系统配置相关常量放在类ConfigConsts下。

    4. 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包

    内共享常量、类内共享常量。

    1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。

    2) 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。

    反例:易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了“YES”的变量:

    类 A 中:public static final String YES = "yes";

    类 B 中:public static final String YES = "y";

    A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致线上问题。

    3) 子工程内部共享常量:即在当前子工程的 constant 目录下。

    4) 包内共享常量:即在当前包下单独的 constant 目录下。

    5) 类内共享常量:直接在类内部 private static final 定义。

    5. 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

    说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的

    第几个季节。

    正例:

    public enum SeasonEnum {

    SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);

    private int seq;

    SeasonEnum(int seq) {

    this.seq = seq;

    }

    public int getSeq() {

    return seq;

    }

    }

    相关文章

      网友评论

          本文标题:阿里巴巴编码规范 一、编程规约

          本文链接:https://www.haomeiwen.com/subject/maoawdtx.html