首页 > 编程语言 >编程规约-常量定义

编程规约-常量定义

时间:2022-09-08 07:11:46浏览次数:72  
标签:常量 seq 规约 编程 public 共享 YES 定义

编程规约-常量定义

定义常量

一、在 long 或者 Long 赋值时,数值后使用大写字母 L,不能是小写字母 l,小写容易跟数字混淆,造成误解。

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

二、不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

反例:

// 本例中,开发者 A 定义了缓存的 key,然后开发者 B 使用缓存时少了下划线,即 key 是"Id#taobao"+tradeId,导致出现故障

String key = "Id#taobao_" + tradeId;

cache.put(key, value);

复用常量

一、如果变量值仅在一个固定范围内变化用 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; 
    } 
}

二、不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。

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

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

三、常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

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 定义。

标签:常量,seq,规约,编程,public,共享,YES,定义
From: https://www.cnblogs.com/gcbeen/p/16667957.html

相关文章

  • 5.JS面向对象编程
    5.面向对象编程5.1原型对象JavaScript,java,c#。。。。类:模板对象:具体的实例原型: varuser={   name:"cc",   age:3,   sex:'男',   run:f......
  • 10.1纯函数面向对象编程
    #人狗大战#人-角色#名称等级血量攻击力性别职业#zhangsan={'name':"zhangsan",'level':1,'hp':200,'ad':40,'性别':'不详','职业':'射手'}##l......
  • 面向对象编程
    背景:1.游戏引擎运行于操作系统上,操作系统又运行于特定的硬件(CUP/RAM/IO)上,因此硬件的瓶颈会限制游戏引擎的性能;2.由于摩尔定律接近天花板,芯片上晶体管的密集程度再增加的话......
  • java并发编程之CompletionService(转载)
    如果我有一个任务想要异步执行,可以使用CompletableFuture,那如果我有多个任务呢,想要并发执行或者串行执行,又想要快速拿到异步执行的结果。那推荐你使用ExecutorCompletion......
  • 编程规约-命名风格
    编程规约-命名风格命名规则一、正确的英文拼写和合理的缩写和语法规则正确示例//国际通用的名称可视同英文alialibabataobaocainiaoaliyunyoukuhangzhou......
  • 面向对象编程
    面向对象编程什么是面向对象?面向对象编程(OOP)是**一种计算机编程模型,它围绕数据或对象而不是功能和逻辑来组织软件设计**.对象可以定义为具有独特属性和行为的数据字......
  • 计算机编程领域的三十种基本思想概览
    运用之妙,存乎一心。计算机编程领域的基本思想,是大量实践与经验的提炼总结,是近乎于“道”的东西。有了思想的指引,就如同有高人指路,行不迷惑,遇事有法,运用之妙,存乎一心。......
  • 终于实现了一门属于自己的编程语言
    前言都说程序员的三大浪漫是:操作系统、编译原理、图形学;最后的图形学确实是特定的专业领域,我们几乎接触不到,所以对我来说换成网络更合适一些,最后再加上一个数据库。这四......
  • Java 并发编程解析 | 如何正确理解Java领域中的并发锁,我们应该具体掌握到什么程度?
    苍穹之边,浩瀚之挚,眰恦之美;悟心悟性,善始善终,惟善惟道!——朝槿《朝槿兮年说》写在开头对于Java领域中的锁,其实从接触Java至今,我相信每一位JavaDeveloper都会有这样......
  • 河北稳控科技可编程 USB 转串口适配器开发板与振弦传感器测量模块
    河北稳控科技可编程USB转串口适配器开发板与振弦传感器测量模块可编程USB转UART/I2C/SMBusS/SPI/CAN/1-Wire适配器USB2S(USBToSerialports)是多种数字接口物理层协议转......