常量與魔法值處理

常量指的就是在其作用域中保持不變的量淑玫,一般使用final關(guān)鍵字來修飾客峭,
根據(jù)作用域的劃分,常量分為全局常量栓撞,類內(nèi)常量和局部常量。
全局常量:public static final
類內(nèi)常量:private static final
局部常量:final(方法內(nèi)部)
示例代碼:

package 常量魔法值與枚舉;
public class 三種常量 {
public static final String GLOBAL_CONSTANT="shared in global";//全局常量
public static final String CLASS_CONSTANT="shared in class";//類內(nèi)常量
public void f(String s) {
    final String methodConstant="shared in method";//局部常量
}
public void g(final int b) {//局部常量
    System.out.println(b);
    //b=3;報錯常量不可被賦值
}
}

關(guān)于常量的命名碗硬,我們一般使用全大寫字母瓤湘,且單詞之間使用_來隔開。
因為常量的使用范圍經(jīng)常是全類甚至全局的恩尾,如果常量的命名讓人不知其意弛说,那么就會造成閱讀困難,這其中最常出現(xiàn)的問題就是魔法值翰意。
魔法值即“共識層面”的常量木人,直接以具體的數(shù)值或字符出現(xiàn)在代碼中。
如下程序所示:

int [] array = new int[20];
for (int i = 0; i < 20; i++){
    System.out.print(array[i]);
}

上述例子中猎物,如果數(shù)組的聲明與for循環(huán)相隔比較遠虎囚,就很難知道 for循環(huán)里面的控制條件 i < 20 中 20 具體含義是什么。它是數(shù)組的長度呢蔫磨,還是根據(jù)需求定義的界限值呢淘讥?就搞不清楚。
魔法數(shù)值使代碼的可讀性大大下降堤如。而且蒲列,如果同樣的數(shù)值多次出現(xiàn)時,到底這些數(shù)值是不是帶有同樣的含義呢搀罢,誰也說不清楚蝗岖。另一方面,如果本來應(yīng)該使用相同數(shù)值的地方榔至,一旦用錯了抵赢,也很難發(fā)現(xiàn)。因此,我們應(yīng)極力避免使用魔法數(shù)值铅鲤。
解決辦法就是使用static final 定義常量或使用enum值
關(guān)于常量我們已經(jīng)說過了划提,下面我們來寫下枚舉怎么解決魔法值問題。

假如有如下場景邢享,我們需要向一個視頻網(wǎng)站上放上我們的教學視頻鹏往,但是我們想讓視頻分類,有些視頻可以被觀看骇塘,有些視頻不能被觀看伊履,剛投稿的視頻要進審核也不能觀看。
大概在最開始我們的代碼可以這樣寫

public void getOnlinePackageCourse(Long packageId,Long userId) {
    if(packageId==3) {
        logger.error("線下課程款违,無法線上觀看");
        return;
    }
    //其他邏輯處理
    PackageCourse online = PackageService.getByTeacherId(userId);
    if(online.getPackageId == 2) {
        logger.error("未審核課程");
        return;
    }
    //其他邏輯處理
}
}

我們隨意的用魔法值2唐瀑,3來表示未審核課程和線下課程,兩個數(shù)字而已奠货,容易記憶介褥。但是除了2,3外递惋,還有1,4溢陪,5萍虽,6等表示其他類型的課程⌒握妫或許我們在開發(fā)中可以靠記憶來判斷和告知其他人杉编,這些數(shù)字代表什么,但是時間一長咆霜,總會出漏洞邓馒。
為此,我們重構(gòu)代碼蛾坯,示例如下:

public enum CourseTypeEnum {
/**
 * 允許官方和講師創(chuàng)建和運營
 */
    VIDEO_COURSE(1, "錄播課程"),
    
/**
 * 只允許官方創(chuàng)建和運營光酣,初始化必須設(shè)置合理的報名人數(shù)上限
 * 
*/
    LIVE_COURSE(2,"直播課程"),
/**
 * 只允許官方創(chuàng)建和運營
 */
   ODDLINE_COURSE(3,"線下課程");
    private int seq;
    private String desc;
    private CourseTypeEnum(int seq, String desc) {
        this.seq = seq;
        this.desc = desc;
    }
    public int getSeq() {
        return seq;
    }
    public String getDesc() {
        return desc;
    }
    
}

上面把課程分為了三種,枚舉類型是幾乎不會改變的全局常量脉课。
我們再把視頻分為新課程救军,未審核課程,審核通過倘零,審核不通過唱遭,以刪除等五種狀態(tài)。用常量來定義

public abstract class BaseCourseState {
public static final int NEW_COURSE = 1;
public static final int UNAUTHED_COURSE = 2;
public static final int PASSED_COURSE = 3;
public static final int  NOT_PASSED_COURSE = 4;
public static final int DELETE_COURSE = 5;
}

經(jīng)過代碼重構(gòu)后呈驶,我們的代碼可讀性立刻有了明顯提升拷泽。

public void getOnlinePackageCourse(Long packageId,Long userId) {
        if(packageId==CourseTypeEnum.OFFLINE_COURSE.getSeq()) {
            logger.error("線下課程,無法線上觀看");
            return;
        }
        //其他邏輯處理
        //PackageCourse online = PackageService.getByTeacherId(userId);
        if(online.getPackageId == BaseCourseState.UNAUTHED_COURSE) {
            logger.error("未審核課程");
            return;
        }
        //其他邏輯處理
    }

代碼為什么不允許出現(xiàn)魔法值

即使類內(nèi)常量和局部變量當前只使用一次,也要賦予一個有意義的名稱司致,目的一是望文知義订晌,二是在后期多次使用時能做到值出同源。

以下為警示代碼:

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

上面是用魔法值來拼裝key蚌吸,這導致各個調(diào)用方到處復制粘貼字符串
Id#taobao_,終于有一天锈拨,一個粗心的程序員復制的時候少了_,
這個錯誤在測試沒有被發(fā)現(xiàn),因為緩存沒有命中羹唠,會自動訪問數(shù)據(jù)庫奕枢。在大促中,數(shù)據(jù)庫壓力急劇上升佩微,進而發(fā)現(xiàn)緩存全部失效缝彬,導致連接占滿,查詢變慢哺眯。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末谷浅,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子奶卓,更是在濱河造成了極大的恐慌一疯,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,525評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件夺姑,死亡現(xiàn)場離奇詭異墩邀,居然都是意外死亡,警方通過查閱死者的電腦和手機盏浙,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,203評論 3 395
  • 文/潘曉璐 我一進店門眉睹,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人废膘,你說我怎么就攤上這事竹海。” “怎么了丐黄?”我有些...
    開封第一講書人閱讀 164,862評論 0 354
  • 文/不壞的土叔 我叫張陵斋配,是天一觀的道長。 經(jīng)常有香客問我孵稽,道長许起,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,728評論 1 294
  • 正文 為了忘掉前任菩鲜,我火速辦了婚禮园细,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘接校。我一直安慰自己猛频,他們只是感情好狮崩,可當我...
    茶點故事閱讀 67,743評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著鹿寻,像睡著了一般睦柴。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上毡熏,一...
    開封第一講書人閱讀 51,590評論 1 305
  • 那天坦敌,我揣著相機與錄音,去河邊找鬼痢法。 笑死狱窘,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的财搁。 我是一名探鬼主播蘸炸,決...
    沈念sama閱讀 40,330評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼尖奔!你這毒婦竟也來了搭儒?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,244評論 0 276
  • 序言:老撾萬榮一對情侶失蹤提茁,失蹤者是張志新(化名)和其女友劉穎淹禾,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體甘凭,經(jīng)...
    沈念sama閱讀 45,693評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡稀拐,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,885評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了丹弱。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,001評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡铲咨,死狀恐怖躲胳,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情纤勒,我是刑警寧澤坯苹,帶...
    沈念sama閱讀 35,723評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站摇天,受9級特大地震影響粹湃,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜泉坐,卻給世界環(huán)境...
    茶點故事閱讀 41,343評論 3 330
  • 文/蒙蒙 一为鳄、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧腕让,春花似錦孤钦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,919評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽静袖。三九已至,卻和暖如春俊扭,著一層夾襖步出監(jiān)牢的瞬間队橙,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,042評論 1 270
  • 我被黑心中介騙來泰國打工萨惑, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留捐康,地道東北人。 一個月前我還...
    沈念sama閱讀 48,191評論 3 370
  • 正文 我出身青樓咒钟,卻偏偏與公主長得像吹由,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子朱嘴,可洞房花燭夜當晚...
    茶點故事閱讀 44,955評論 2 355

推薦閱讀更多精彩內(nèi)容