每日学学Java开发规范,常量定义(附阿里巴巴Java开发手册(终极版))

前言

每次去不同的公司,码不同的代码,适应不同的规范,经常被老大教育规范问题,我都有点走火入魔的感觉,还是要去看看阿里巴巴Java开发规范,从中熟悉一下,纠正自己,码出高效,码出质量

想细看的可以去官网下载,或者下面自取
阿里巴巴Java开发手册(终极版)

二、常量定义

  1. 【强制】不允许任何魔法值(即未经定义的常量)直接出现在代码中。(因为魔法值表示的是一些特定含义的数字或字符,它们在代码中出现时往往不容易理解,可读性也很差;另外,如果将来需要更改这些魔法值,也需要更改大量的代码,增加了工作量。)
反例:String key = "Id#taobao_" + tradeId;
	 ncache.put(key, value
  1. 【强制】long 或者 Long 初始赋值时,使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。
说明:Long a = 2l; 写的是数字的 21,还是 Long 型的 2?
  1. 【推荐】不要使用一个常量类维护所有常量,按常量功能进行归类,分开维护。
说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。
正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下。
  1. 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。(范围由大到小)

    • 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。
    • 应用内共享常量:放置在一方库中,通常是 modules 中的 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 定义。
  2. 【推荐】如果变量值仅在一个范围内变化,且带有名称之外的延伸属性,定义为枚举类。下面正例中的数字就是延伸信息,表示星期几。

正例:public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值