此文章為筆記,為閱讀其他文章的感受、補充、記錄、練習、匯總,非原創,感謝每個知識分享者。
文章目錄
- 1. 背景
- 2. 枚舉緩存
- 3. 樣例展示
- 4. 性能對比
- 5. 總結
本文通過幾種樣例展示如何高效優雅的使用java枚舉消除冗余代碼。
1. 背景
枚舉在系統中的地位不言而喻,狀態、類型、場景、標識等等,少則十幾個多則上百個,相信以下這段代碼很常見,而且類似的代碼到處都是,目標:消除這類冗余代碼。
/*** 根據枚舉代碼獲取枚舉* */public static OrderStatus getByCode(String code){for (OrderStatus v : values()) {if (v.getCode().equals(code)) {return v;}}return null;}/*** 根據枚舉名稱獲取枚舉* 當枚舉內的實例數越多時性能越差*/public static OrderStatus getByName(String name){for (OrderStatus v : values()) {if (v.name().equals(name)) {return v;}}return null;}
2. 枚舉緩存
- 減少代碼冗余,代碼簡潔
- 去掉for循環,性能穩定高效
模塊設計圖
緩存結構
源碼分析
源碼展示
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;/*** 枚舉緩存*/
public class EnumCache {/*** 以枚舉任意值構建的緩存結構**/static final Map<Class<? extends Enum>, Map<Object, Enum>> CACHE_BY_VALUE = new ConcurrentHashMap<>();/*** 以枚舉名稱構建的緩存結構**/static final Map<Class<? extends Enum>, Map<Object, Enum>> CACHE_BY_NAME = new ConcurrentHashMap<>();/*** 枚舉靜態塊加載標識緩存結構*/static final Map<Class<? extends Enum>, Boolean> LOADED = new ConcurrentHashMap<>();/*** 以枚舉名稱構建緩存,在枚舉的靜態塊里面調用** @param clazz* @param es* @param <E>*/public static <E extends Enum> void registerByName(Class<E> clazz, E[] es) {Map<Object, Enum> map = new ConcurrentHashMap<>();for (E e : es) {map.put(e.name(), e);}CACHE_BY_NAME.put(clazz, map);}/*** 以枚舉轉換出的任意值構建緩存,在枚舉的靜態塊里面調用** @param clazz* @param es* @param enumMapping* @param <E>*/public static <E extends Enum> void registerByValue(Class<E> clazz, E[] es, EnumMapping<E> enumMapping) {if (CACHE_BY_VALUE.containsKey(clazz)) {throw new RuntimeException(String.format("枚舉%s已經構建過value緩存,不允許重復構建", clazz.getSimpleName()));}Map<Object, Enum> map = new ConcurrentHashMap<>();for (E e : es) {Object value = enumMapping.value(e);if (map.containsKey(value)) {throw new RuntimeException(String.format("枚舉%s存在相同的值%s映射同一個枚舉%s.%s", clazz.getSimpleName(), value, clazz.getSimpleName(), e));}map.put(value, e);}CACHE_BY_VALUE.put(clazz, map);}/*** 從以枚舉名稱構建的緩存中通過枚舉名獲取枚舉** @param clazz* @param name* @param defaultEnum* @param <E>* @return*/public static <E extends Enum> E findByName(Class<E> clazz, String name, E defaultEnum) {return find(clazz, name, CACHE_BY_NAME, defaultEnum);}/*** 從以枚舉轉換值構建的緩存中通過枚舉轉換值獲取枚舉** @param clazz* @param value* @param defaultEnum* @param <E>* @return*/public static <E extends Enum> E findByValue(Class<E> clazz, Object value, E defaultEnum) {return find(clazz, value, CACHE_BY_VALUE, defaultEnum);}private static <E extends Enum> E find(Class<E> clazz, Object obj, Map<Class<? extends Enum>, Map<Object, Enum>> cache, E defaultEnum) {Map<Object, Enum> map = null;if ((map = cache.get(clazz)) == null) {executeEnumStatic(clazz);// 觸發枚舉靜態塊執行map = cache.get(clazz);// 執行枚舉靜態塊后重新獲取緩存}if (map == null) {String msg = null;if (cache == CACHE_BY_NAME) {msg = String.format("枚舉%s還沒有注冊到枚舉緩存中,請在%s.static代碼塊中加入如下代碼 : EnumCache.registerByName(%s.class, %s.values());",clazz.getSimpleName(),clazz.getSimpleName(),clazz.getSimpleName(),clazz.getSimpleName());}if (cache == CACHE_BY_VALUE) {msg = String.format("枚舉%s還沒有注冊到枚舉緩存中,請在%s.static代碼塊中加入如下代碼 : EnumCache.registerByValue(%s.class, %s.values(), %s::getXxx);",clazz.getSimpleName(),clazz.getSimpleName(),clazz.getSimpleName(),clazz.getSimpleName(),clazz.getSimpleName());}throw new RuntimeException(msg);}if(obj == null){return defaultEnum;}Enum result = map.get(obj);return result == null ? defaultEnum : (E) result;}private static <E extends Enum> void executeEnumStatic(Class<E> clazz) {if (!LOADED.containsKey(clazz)) {synchronized (clazz) {if (!LOADED.containsKey(clazz)) {try {// 目的是讓枚舉類的static塊運行,static塊沒有執行完是會阻塞在此的Class.forName(clazz.getName());LOADED.put(clazz, true);} catch (Exception e) {throw new RuntimeException(e);}}}}}/*** 枚舉緩存映射器函數式接口*/@FunctionalInterfacepublic interface EnumMapping<E extends Enum> {/*** 自定義映射器** @param e 枚舉* @return 映射關系,最終體現到緩存中*/Object value(E e);}}
關鍵解讀
開閉原則
什么是開閉原則?
對修改是封閉的,對新增擴展是開放的。為了滿足開閉原則,這里設計成有枚舉主動注冊到緩存,而不是有緩存主動加載枚舉,這樣設計的好處就是:當增加一個枚舉時只需要在當前枚舉的靜態塊中自主注冊即可,不需要修改其他的代碼
比如我們現在要新增一個狀態類枚舉:
public enum StatusEnum {INIT("I", "初始化"),PROCESSING("P", "處理中"),SUCCESS("S", "成功"),FAIL("F", "失敗");private String code;private String desc;StatusEnum(String code, String desc) {this.code = code;this.desc = desc;}public String getCode() {return code;}public String getDesc() {return desc;}static {// 通過名稱構建緩存,通過EnumCache.findByName(StatusEnum.class,"SUCCESS",null);調用能獲取枚舉EnumCache.registerByName(StatusEnum.class, StatusEnum.values());// 通過code構建緩存,通過EnumCache.findByValue(StatusEnum.class,"S",null);調用能獲取枚舉EnumCache.registerByValue(StatusEnum.class, StatusEnum.values(), StatusEnum::getCode);}
}
注冊時機
將注冊放在靜態塊中,那么靜態塊什么時候執行呢?
1、當第一次創建某個類的新實例時
2、當第一次調用某個類的任意靜態方法時
3、當第一次使用某個類或接口的任意非final靜態字段時
4、當第一次Class.forName時
如果我們入StatusEnum創建枚舉,那么在應用系統啟動的過程中StatusEnum的靜態塊可能從未執行過,則枚舉緩存注冊失敗,
所有我們需要考慮延遲注冊,代碼如下:
private static <E extends Enum> void executeEnumStatic(Class<E> clazz) {if (!LOADED.containsKey(clazz)) {synchronized (clazz) {if (!LOADED.containsKey(clazz)) {try {// 目的是讓枚舉類的static塊運行,static塊沒有執行完是會阻塞在此的Class.forName(clazz.getName());LOADED.put(clazz, true);} catch (Exception e) {throw new RuntimeException(e);}}}}}
Class.forName(clazz.getName())被執行的兩個必備條件:
1、緩存中沒有枚舉class的鍵,也就是說沒有執行過枚舉向緩存注冊的調用,見EnumCache.find方法對executeEnumStatic方法的調用;
2、executeEnumStatic中的LOADED.put(clazz, true);還沒有被執行過,也就是Class.forName(clazz.getName());沒有被執行過;
我們看到executeEnumStatic中用到了雙重檢查鎖,所以分析一下正常情況下代碼執行情況和性能:
1、當靜態塊還未執行時,大量的并發執行find查詢。
此時executeEnumStatic中synchronized會阻塞其他線程;第一個拿到鎖的線程會執行Class.forName(clazz.getName());同時觸發枚舉靜態塊的同步執行;之后其他線程會逐一拿到鎖,第二次檢查會不成立跳出executeEnumStatic;2、當靜態塊已經執行,且靜態塊里面正常執行了緩存注冊,大量的并發執行find查詢。
executeEnumStatic方法不會調用,沒有synchronized引發的排隊問題;3、當靜態塊已經執行,但是靜態塊里面沒有調用緩存注冊,大量的并發執行find查詢。
find方法會調用executeEnumStatic方法,但是executeEnumStatic的第一次檢查通不過;
find方法會提示異常需要在靜態塊中添加注冊緩存的代碼;總結:第一種場景下會有短暫的串行,但是這種內存計算短暫串行相比應用系統的業務邏輯執行是微不足道的,
也就是說這種短暫的串行不會成為系統的性能瓶頸
3. 樣例展示
構造枚舉
public enum StatusEnum {INIT("I", "初始化"),PROCESSING("P", "處理中"),SUCCESS("S", "成功"),FAIL("F", "失敗");private String code;private String desc;StatusEnum(String code, String desc) {this.code = code;this.desc = desc;}public String getCode() {return code;}public String getDesc() {return desc;}static {// 通過名稱構建緩存,通過EnumCache.findByName(StatusEnum.class,"SUCCESS",null);調用能獲取枚舉EnumCache.registerByName(StatusEnum.class, StatusEnum.values());// 通過code構建緩存,通過EnumCache.findByValue(StatusEnum.class,"S",null);調用能獲取枚舉EnumCache.registerByValue(StatusEnum.class, StatusEnum.values(), StatusEnum::getCode);}
}
測試類
public class Test{public static void main(String [] args){System.out.println(EnumCache.findByName(StatusEnum.class, "SUCCESS", null));// 返回默認值StatusEnum.INITSystem.out.println(EnumCache.findByName(StatusEnum.class, null, StatusEnum.INIT));// 返回默認值StatusEnum.INITSystem.out.println(EnumCache.findByName(StatusEnum.class, "ERROR", StatusEnum.INIT));System.out.println(EnumCache.findByValue(StatusEnum.class, "S", null));// 返回默認值StatusEnum.INITSystem.out.println(EnumCache.findByValue(StatusEnum.class, null, StatusEnum.INIT));// 返回默認值StatusEnum.INITSystem.out.println(EnumCache.findByValue(StatusEnum.class, "ERROR", StatusEnum.INIT));}
}
執行結果
SUCCESS
INIT
INIT
SUCCESS
INIT
INIT
4. 性能對比
對比代碼,如果OrderType中的實例數越多性能差異會越大
public class Test {enum OrderType {_00("00", "00"),_01("01", "01"),_02("02", "02"),_03("03", "03"),_04("04", "04"),_05("05", "05"),_06("06", "06"),_07("07", "07"),_08("08", "08"),_09("09", "09"),_10("10", "10");private String code;private String desc;OrderType(String code, String desc) {this.code = code;this.desc = desc;}public String getCode() {return code;}public String getDesc() {return desc;}static {EnumCache.registerByValue(OrderType.class, OrderType.values(), OrderType::getCode);}public static OrderType getEnumByCode(String code, OrderType def) {OrderType[] values = OrderType.values();for (OrderType value : values) {if (value.getCode().equals(code)) {return value;}}return def;}}private static final OrderType DEF = OrderType._00;private static final int TIMES = 10000000;static void compare(String code) {long s = System.currentTimeMillis();for (int idx = 0; idx < TIMES; idx++) {OrderType.getEnumByCode(code, DEF);}long t = System.currentTimeMillis() - s;System.out.println(String.format("枚舉->%s : %s", code, t));s = System.currentTimeMillis();for (int idx = 0; idx < TIMES; idx++) {EnumCache.findByValue(OrderType.class, code, DEF);}t = System.currentTimeMillis() - s;System.out.println(String.format("緩存->%s : %s", code, t));System.out.println();}public static void main(String[] args) throws Exception {for (int idx = 0; idx < 2; idx++) {compare("NotExist");for (OrderType value : OrderType.values()) {compare(value.getCode());}System.out.println("=================");}}
}
執行結果
枚舉->NotExist : 312
緩存->NotExist : 105枚舉->00 : 199
緩存->00 : 164枚舉->01 : 313
緩存->01 : 106枚舉->02 : 227
緩存->02 : 90枚舉->03 : 375
緩存->03 : 92枚舉->04 : 260
緩存->04 : 92枚舉->05 : 272
緩存->05 : 78枚舉->06 : 284
緩存->06 : 78枚舉->07 : 315
緩存->07 : 76枚舉->08 : 351
緩存->08 : 78枚舉->09 : 372
緩存->09 : 81枚舉->10 : 402
緩存->10 : 78=================
枚舉->NotExist : 199
緩存->NotExist : 68枚舉->00 : 99
緩存->00 : 91枚舉->01 : 141
緩存->01 : 79枚舉->02 : 178
緩存->02 : 77枚舉->03 : 202
緩存->03 : 77枚舉->04 : 218
緩存->04 : 81枚舉->05 : 259
緩存->05 : 90枚舉->06 : 322
緩存->06 : 78枚舉->07 : 318
緩存->07 : 78枚舉->08 : 347
緩存->08 : 77枚舉->09 : 373
緩存->09 : 79枚舉->10 : 404
緩存->10 : 78=================
5. 總結
1、代碼簡潔;
2、枚舉中實例數越多,緩存模式的性能優勢越多;