一、编程规约 （二）常量定义

  • 作者： 凯哥Java(公众号：凯哥Java)
  • P3C规范
  • 时间：2019-07-06 14:18
  • 2253人已阅读
工作小总结&小工具类 Redis LoRaWAN&ChirpStack AI编程 AI相关 MQTT Maven mybatis ChatGPT uniapp zookeeper Thymeleaf语法 POI-TL sa-token PowerDesigner16.5 taos数据库 frp echarts Actor模型及Akka thingsboard 大疆无人机对接 CI/CD 教师资格证 小任务 面试其他 职场 淘宝客 支付宝支付 HBuilder X Flink Java集合类 多线程 ES Ribbon eureka Docker java游戏 网络通信 Nacos 芋道管理系统 Solr 分布式相关 Dubbo 数据结构 EasyPOI Drools RocketMQ JS 七天深入MySQL实战营 书籍 kafka spring Java基础 java web 若依(ruoyi) 分布式事务 面试宝典 mysql java8新特性 spring cloud ElasticSearch学习系列 HM_leadnews 即时通讯 并发 思维&学习 VUE 宝塔面板 算法刷题 设计模式 RabbitMQ学习系列教程 P3C规范 JVM学习系列 反射 自定义注解 网络美文 PHP源码 经验分享 资源 git项目 websocket 网赚 数据库读写分离 测试相关 其他随笔 shiro学习系列 fremarker学习系列 学习笔录-spring boot 网络文章 工作小总结
简介 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。 反例：String key = "Id#taobao_" + tradeId;       cache.put(key, value);【强制】long或者Long初始赋值

🔔🔔🔔好消息!好消息!🔔🔔🔔

有需要的朋友👉:联系凯哥 微信号 kaigejava2022

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

    String key = "Id#taobao_" + tradeId;       
cache.put(key, value);

  2. 【强制】long或者Long初始赋值时，使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
    说明：

    Long a = 2l;

    写的是数字的21，还是Long型的2?

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

  4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
    1） 跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。 2） 应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。 
    反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量：

     类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);
       int seq; 
       SeasonEnum(int seq){         
           this.seq = seq;     
       } 
}



工作小总结&小工具类 Redis LoRaWAN&ChirpStack AI编程 AI相关 MQTT Maven mybatis ChatGPT uniapp zookeeper Thymeleaf语法 POI-TL sa-token PowerDesigner16.5 taos数据库 frp echarts Actor模型及Akka thingsboard 大疆无人机对接 CI/CD 教师资格证 小任务 面试其他 职场 淘宝客 支付宝支付 HBuilder X Flink Java集合类 多线程 ES Ribbon eureka Docker java游戏 网络通信 Nacos 芋道管理系统 Solr 分布式相关 Dubbo 数据结构 EasyPOI Drools RocketMQ JS 七天深入MySQL实战营 书籍 kafka spring Java基础 java web 若依(ruoyi) 分布式事务 面试宝典 mysql java8新特性 spring cloud ElasticSearch学习系列 HM_leadnews 即时通讯 并发 思维&学习 VUE 宝塔面板 算法刷题 设计模式 RabbitMQ学习系列教程 P3C规范 JVM学习系列 反射 自定义注解 网络美文 PHP源码 经验分享 资源 git项目 websocket 网赚 数据库读写分离 测试相关 其他随笔 shiro学习系列 fremarker学习系列 学习笔录-spring boot 网络文章 工作小总结

上一篇： 一、编程规约 （一）命名风格

下一篇： 一、编程规约 （三）代码格式

TopTop