zoukankan      html  css  js  c++  java
  • 规约先行-(二)常量定义

    1. 【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中
      反例:String key = "Id#taobao_" + tradeId;

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

    3. 【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护
      说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护
      正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下

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

    • 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下
    • 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下
      反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示“是”的变量:
      类 A 中:public static final String YES = "yes";
      类 B 中:public static final String YES = "y";
      A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致线上问题
    • 子工程内部共享常量:即在当前子工程的 constant 目录下
    • 包内共享常量:即在当前包下单独的 constant 目录下
    • 类内共享常量:直接在类内部 private static final 定义
    1. 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义
      说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的第几个季节
    public enum SeasonEnum {
         SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
         private int seq;
         SeasonEnum(int seq){
             this.seq = seq;
         }
    }
    
    起风了,努力生存
  • 相关阅读:
    架设WCF项目出现的问题
    百思不得其解的"Failed to allocate a managed memory buffer of 268435456 bytes."错误解决
    Ajax 分页
    关于Asp.net调用外部程序的拒绝访问错误
    转贴:[翻译]Visual Studio 2008 Code Metrics
    荀子,劝学篇(部分)
    .net设计模式(转载)
    人月神话读书笔记
    Memory food
    2010年4月12日,今天做计划
  • 原文地址:https://www.cnblogs.com/StivenYang/p/12716043.html
Copyright © 2011-2022 走看看