一. DescriptionAttribute的普通使用方式1.1 使用示例 DescriptionAttribute特性可以用到很多地方,比較常見的就是枚舉,通過獲取枚舉上定義的描述信息在UI上顯示,一個簡單的枚舉定義:public enum EnumGender { ...
一. DescriptionAttribute的普通使用方式
1.1 使用示例
DescriptionAttribute特性可以用到很多地方,比較常見的就是枚舉,通過獲取枚舉上定義的描述信息在UI上顯示,一個簡單的枚舉定義:
public enum EnumGender { None, [System.ComponentModel.Description("男")] Male, [System.ComponentModel.Description("女")] Female, Other, }
本文不討論DescriptionAttribute的其他應用場景,也不關註多語言的實現,只單純的研究下獲取枚舉描述信息的方法。
一般比較常見的獲取枚舉描述信息的方法如下,可以在園子里搜索類似的代碼非常多。
public static string GetDescriptionOriginal(this Enum @this) { var name = @this.ToString(); var field = @this.GetType().GetField(name); if (field == null) return name; var att = System.Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute), false); return att == null ? field.Name : ((DescriptionAttribute)att).Description; }
簡單測試下:
Console.WriteLine(EnumGender.Female.GetDescriptionOriginal());
Console.WriteLine(EnumGender.Male.GetDescriptionOriginal());
Console.WriteLine(EnumGender.Other.GetDescriptionOriginal());
//輸出結果:
女
男
Other
1.2 上面的實現代碼的問題
首先要理解特性是什麼?
特性:
Attribute特性就是關聯了一個目標對象的一段配置信息,存儲在dll內的元數據。它本身沒什麼意義,可以通過反射來獲取配置的特性信息。
因此主要問題其實就是反射造成的嚴重性能問題:
- 1.每次調用都會使用反射,效率慢!
- 2.每次調用反射都會生成新的DescriptionAttribute對象,哪怕是同一個枚舉值。造成記憶體、GC的極大浪費!
- 3.好像不支持位域組合對象!
- 4.這個地方的方法參數是Enum,Enum是枚舉的基類,他是一個引用類型,而枚舉是值類型,該方法會造成裝箱,不過這個問題好像是不可避免的。
性能到底有多差呢?代碼來實測一下:
[Test] public void GetDescriptionOriginal_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionOriginal(); } }); }); } //輸出結果: 80 TimeSpan:79,881.0000ms //共消耗了將近80秒 MemoryUsed:-1,652.7970KB CollectionCount(0):7,990.00 //0代GC回收了7千多次,因為創建了大量的DescriptionAttribute對象
其中this.GetTestEnums();方法使用獲取一個枚舉值集合,用於測試的,集合大小80,執行100w次,相當於執行了8000w次GetDescriptionOriginal方法。
TestHelper.InvokeAndWriteAll方法是用來計算執行前後的時間、記憶體消耗、0代GC回收次數的,文末附錄中給出了代碼,由於記憶體回收的原因,記憶體消耗計算其實不准確的,不過可以參考第三個指標0代GC回收次數。
二. 改進的DescriptionAttribute方法
知道了問題原因,解決就好辦了,基本思路就是把獲取到的文本值緩存起來,一個枚舉值只反射一次,這樣性能問題就解決了。
2.1 使用字典緩存+鎖
因為使用靜態變數字典來緩存值,就涉及到線程安全,需要使用鎖(做了雙重檢測),具體方法:
private static Dictionary<Enum, string> _LockDictionary = new Dictionary<Enum, string>(); public static string GetDescriptionByDictionaryWithLocak(this Enum @this) { if (_LockDictionary.ContainsKey(@this)) return _LockDictionary[@this]; Monitor.Enter(_obj); if (!_LockDictionary.ContainsKey(@this)) { var value = @this.GetDescriptionOriginal(); _LockDictionary.Add(@this, value); } Monitor.Exit(_obj); return _LockDictionary[@this]; }
來測試一下,測試數據、次數和1.2的GetDescriptionOriginal_Test相同,效率有很大的提升,只有一次記憶體回收。
[Test] public void GetDescriptionByDictionaryWithLocak_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionByDictionaryWithLocak(); } }); }); } //測試結果: 80 TimeSpan:1,860.0000ms MemoryUsed:159.2422KB CollectionCount(0):1.00
2.2 使用字典緩存+異常(不走尋常路的方式)
還是先看看實現方法吧!
private static Dictionary<Enum, string> _ExceptionDictionary = new Dictionary<Enum, string>(); public static string GetDescriptionByDictionaryWithException(this Enum @this) { try { return _ExceptionDictionary[@this]; } catch (KeyNotFoundException) { Monitor.Enter(_obj); if (!_ExceptionDictionary.ContainsKey(@this)) { var value = @this.GetDescriptionOriginal(); _ExceptionDictionary.Add(@this, value); } Monitor.Exit(_obj); return _ExceptionDictionary[@this]; } }
假設我們的使用場景是這樣的:項目定義的枚舉並不多,但是用其描述值很頻繁,比如定義了一個用戶性別枚舉,用的地方很多,使用頻率很高。
上面GetDescriptionByDictionaryWithLocak的方法中,第一句代碼“if (_LockDictionary.ContainsKey(@this)) ”就是驗證是否包含枚舉值。在2.1的測試中執行了8000w次,其中只有80次(總共只有80個枚舉值用於測試)需要這句代碼“if (_LockDictionary.ContainsKey(@this)) ”,其餘的直接取值就可了。基於這樣的考慮,就有了上面的方法GetDescriptionByDictionaryWithException。
來測試一下,看看效果吧!
[Test] public void GetDescriptionByDictionaryWithException_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionByDictionaryWithException(); } }); }); } //測試結果: 80 TimeSpan:1,208.0000ms MemoryUsed:230.9453KB CollectionCount(0):1.00
測試結果來看,基本上差不多,在時間上略微快樂一點點,1,208.0000ms:1,860.0000ms,執行8000w次快600毫秒,好像差別也不大啊,這是為什麼呢?
這個其實就是Dictionary的問題了,Dictionary內部使用散列演算法計算存儲地址,其查找的時間複雜度為o(1),他的查找效果是非常快的,而本方法中利用了異常處理,異常捕獲本身是有一定性能影響的。
2.3 推薦簡單方案:ConcurrentDictionary
ConcurrentDictionary是一個線程安全的字典類,代碼:
private static ConcurrentDictionary<Enum, string> _ConcurrentDictionary = new ConcurrentDictionary<Enum, string>(); public static string GetDescriptionByConcurrentDictionary(this Enum @this) { return _ConcurrentDictionary.GetOrAdd(@this, (key) => { var type = key.GetType(); var field = type.GetField(key.ToString()); return field == null ? key.ToString() : GetDescription(field); }); }
測試代碼及測試結果:
[Test] public void GetDescriptionByConcurrentDictionary_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionByConcurrentDictionary(); } }); }); } //測試結果: 80 TimeSpan:1,303.0000ms MemoryUsed:198.0859KB CollectionCount(0):1.00
2.4 正式的代碼
綜上所述,解決了性能問題、位域枚舉問題的正式的代碼:
/// <summary> /// 獲取枚舉的描述信息(Descripion)。 /// 支持位域,如果是位域組合值,多個按分隔符組合。 /// </summary> public static string GetDescription(this Enum @this) { return _ConcurrentDictionary.GetOrAdd(@this, (key) => { var type = key.GetType(); var field = type.GetField(key.ToString()); //如果field為null則應該是組合位域值, return field == null ? key.GetDescriptions() : GetDescription(field); }); } /// <summary> /// 獲取位域枚舉的描述,多個按分隔符組合 /// </summary> public static string GetDescriptions(this Enum @this, string separator = ",") { var names = @this.ToString().Split(','); string[] res = new string[names.Length]; var type = @this.GetType(); for (int i = 0; i < names.Length; i++) { var field = type.GetField(names[i].Trim()); if (field == null) continue; res[i] = GetDescription(field); } return string.Join(separator, res); } private static string GetDescription(FieldInfo field) { var att = System.Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute), false); return att == null ? field.Name : ((DescriptionAttribute)att).Description; }
版權所有,文章來源:http://www.cnblogs.com/anding
個人能力有限,本文內容僅供學習、探討,歡迎指正、交流。
附錄:
1.EnumExtension.cs代碼:
public static class EnumExtension { /// <summary> /// 獲取枚舉的描述信息(Descripion)。 /// 支持位域,如果是位域組合值,多個按分隔符組合。 /// </summary> public static string GetDescription(this Enum @this) { return _ConcurrentDictionary.GetOrAdd(@this, (key) => { var type = key.GetType(); var field = type.GetField(key.ToString()); //如果field為null則應該是組合位域值, return field == null ? key.GetDescriptions() : GetDescription(field); }); } /// <summary> /// 獲取位域枚舉的描述,多個按分隔符組合 /// </summary> public static string GetDescriptions(this Enum @this, string separator = ",") { var names = @this.ToString().Split(','); string[] res = new string[names.Length]; var type = @this.GetType(); for (int i = 0; i < names.Length; i++) { var field = type.GetField(names[i].Trim()); if (field == null) continue; res[i] = GetDescription(field); } return string.Join(separator, res); } private static string GetDescription(FieldInfo field) { var att = System.Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute), false); return att == null ? field.Name : ((DescriptionAttribute)att).Description; } /****************** test methods ******************/ public static string GetDescriptionOriginal(this Enum @this) { var name = @this.ToString(); var field = @this.GetType().GetField(name); if (field == null) return name; var att = System.Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute), false); return att == null ? field.Name : ((DescriptionAttribute)att).Description; } private static Dictionary<Enum, string> _LockDictionary = new Dictionary<Enum, string>(); public static string GetDescriptionByDictionaryWithLocak(this Enum @this) { if (_LockDictionary.ContainsKey(@this)) return _LockDictionary[@this]; Monitor.Enter(_obj); if (!_LockDictionary.ContainsKey(@this)) { var value = @this.GetDescriptionOriginal(); _LockDictionary.Add(@this, value); } Monitor.Exit(_obj); return _LockDictionary[@this]; } private static Dictionary<Enum, string> _ExceptionDictionary = new Dictionary<Enum, string>(); public static string GetDescriptionByDictionaryWithException(this Enum @this) { try { return _ExceptionDictionary[@this]; } catch (KeyNotFoundException) { Monitor.Enter(_obj); if (!_ExceptionDictionary.ContainsKey(@this)) { var value = @this.GetDescriptionOriginal(); _ExceptionDictionary.Add(@this, value); } Monitor.Exit(_obj); return _ExceptionDictionary[@this]; } } public static object _obj = new object(); private static ConcurrentDictionary<Enum, string> _ConcurrentDictionary = new ConcurrentDictionary<Enum, string>(); public static string GetDescriptionByConcurrentDictionary(this Enum @this) { return _ConcurrentDictionary.GetOrAdd(@this, (key) => { var type = key.GetType(); var field = type.GetField(key.ToString()); return field == null ? key.ToString() : GetDescription(field); }); } }View Code
2.測試類EnumTest.cs代碼:
[TestFixture] public class EnumTest { [Test] public void SimpleTest() { Console.WriteLine(EnumGender.Female.GetDescriptionOriginal()); Console.WriteLine(EnumGender.Male.GetDescriptionOriginal()); Console.WriteLine(EnumGender.Other.GetDescriptionOriginal()); var t1 = EnumGender.Male | EnumGender.Female; Console.WriteLine((t1 & EnumGender.Male) == EnumGender.Male); Console.WriteLine(t1 & ~EnumGender.Male); Console.WriteLine(Enum.IsDefined(typeof(EnumGender), 0)); } [Test] public void GetDescriptionOriginal_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionOriginal(); } }); }); } [Test] public void GetDescriptionByDictionaryWithLocak_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionByDictionaryWithLocak(); } }); }); } [Test] public void GetDescriptionByDictionaryWithException_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionByDictionaryWithException(); } }); }); } [Test] public void GetDescriptionByConcurrentDictionary_Test() { var enums = this.GetTestEnums(); Console.WriteLine(enums.Count); TestHelper.InvokeAndWriteAll(() => { System.Threading.Tasks.Parallel.For(0, 1000000, (i, obj) => { foreach (var item in enums) { var a = item.GetDescriptionByConcurrentDictionary(); } }); }); } private List<Enum> GetTestEnums() { List<Enum> res = new List<Enum>(); res.Add(EnumMutliFTest.T1); res.Add(EnumMutliFTest.T2); res.Add(EnumMutliFTest.T3); res.Add(EnumMutliFTest.T4); res.Add(EnumMutliFTest.T5); res.Add(EnumMutliFTest.T6); res.Add(EnumMutliFTest.T7); res.Add(EnumMutliFTest.T8); res.Add(EnumMutliFTest.T9); res.Add(EnumMutliFTest.T10); res.Add(EnumMutliFTest.T11); res.Add(EnumMutliFTest.T12); res.Add(EnumMutliFTest.T13); res.Add(EnumMutliFTest.T14); res.Add(EnumMutliFTest.T15); res.Add(EnumMutliFTest.T16); res.Add(EnumMutliFTest.T17); res.Add(EnumMutliFTest.T18); res.Add(EnumMutliFTest.T19); res.Add(EnumMutliFTest.T20); res.Add(EnumMutliFTest.T21); res.Add(EnumMutliFTest.T22); res.Add(EnumMutliFTest.T23); res.Add(EnumMutliFTest.T24); res.Add(EnumMutliFTest.T25); res.Add(EnumMutliFTest.T26); res.Add(EnumMutliFTest.T27); res.Add(EnumMutliFTest.T28); res.Add(EnumMutliFTest.T29); res.Add(EnumMutliFTest.T30); res.Add(EnumMutliFTest.T31); res.Add(EnumMutliFTest.T32); res.Add(EnumMutliFTest.T33); res.Add(EnumMutliFTest.T34); res.Add(EnumMutliFTest.T35); res.Add(EnumMutliFTest.T36); res.Add(EnumMutliFTest.T37); res.Add(EnumMutliFTest.T38); res.Add(EnumMutliFTest.T3); res.Add(EnumMutliFTest.T18); res.Add(EnumMutliFTest2.T21); res.Add(EnumMutliFTest2.T22); res.Add(EnumMutliFTest2.T23); res.Add(EnumMutliFTest2.T24); res.Add(EnumMutliFTest2.T25); res.Add(EnumMutliFTest2.T26); res.Add(EnumMutliFTest2.T27); res.Add(EnumMutliFTest2.T28); res.Add(EnumMutliFTest2.T29); res.Add(EnumMutliFTest2.T210); res.Add(EnumMutliFTest2.T211); res.Add(EnumMutliFTest2.T212); res.Add(EnumMutliFTest2.T213); res.Add(EnumMutliFTest2.T214); res.Add(EnumMutliFTest2.T215); res.Add(EnumMutliFTest2.T216); res.Add(EnumMutliFTest2.T217); res.Add(EnumMutliFTest2.T218); res.Add(EnumMutliFTest2.T219); res.Add(EnumMutliFTest2.T220); res.Add(EnumMutliFTest2.T221); res.Add(EnumMutliFTest2.T222); res.Add(EnumMutliFTest2.T223); res.Add(EnumMutliFTest2.T224); res.Add(EnumMutliFTest2.T225); res.Add(EnumMutliFTest2.T226); res.Add(EnumMutliFTest2.T227); res.Add(EnumMutliFTest2.T228); res.Add(EnumMutliFTest2.T229); res.Add(EnumMutliFTest2.T230); res.Add(EnumMutliFTest2.T231); res.Add(EnumMutliFTest2.T232); res.Add(EnumMutliFTest2.T233); res.Add(EnumMutliFTest2.T234); res.Add(EnumMutliFTest2.T235); res.Add(EnumMutliFTest2.T236); res.Add(EnumMutliFTest2.T237); res.Add(EnumMutliFTest2.T238); res.Add(EnumMutliFTest2.T23); res.Add(EnumMutliFTest2.T218); return res; } public enum EnumMutliFTest { [System.ComponentModel.Description("DT1")] T1, [System.ComponentModel.Description("DT2")] T2, [System.ComponentModel.Description("DT3")] T3, [System.ComponentModel.Description("DT4")] T4, [System.ComponentModel.Description("DT5")] T5, [System.ComponentModel.Description("DT6")] T6, [System.ComponentModel.Description("DT7")] T7, [System.ComponentModel.Description("DT8")] T8, [System.ComponentModel.Description("DT9")] T9, [System.ComponentModel.Description("DT10")] T10, [System.ComponentModel.Description("DT11")] T11, [System.ComponentModel.Description("DT12")] T12, [System.ComponentModel.Description("DT13")] T13, [System.ComponentModel.Description("DT14")] T14, [System.ComponentModel.Description("DT15")] T15, [System.ComponentModel.Description("DT16")] T16, [System.ComponentModel.Description("DT17")] T17, [System.ComponentModel.Description("DT18")] T18, [System.ComponentModel.Description("DT19")] T19, [System.ComponentModel.Description("DT20")] T20, [System.ComponentModel.Description("DT21")] T21, [System.ComponentModel.Description("DT22")] T22, [System.ComponentModel.Description("DT23")] T23, [System.ComponentModel.Description("DT24")] T24, [System.ComponentModel.Description("DT25")] T25, [System.ComponentModel.Description("DT26")] T26, [System.ComponentModel.Description("DT27")] T27, [System.ComponentModel.Description("DT28")] T28, [System.ComponentModel.Description("DT29")] T29, [System.ComponentModel.Description("DT30")] T30, [System.ComponentModel.Description("DT31")] T31, [System.ComponentModel.Description("DT32")] T32, [System.ComponentModel.Description("DT33")] T33, [System.ComponentModel.Description("DT34")] T34, [System.ComponentModel.Description("DT35")] T35, [System.ComponentModel.Description("DT36")] T36, [System.ComponentModel.Description("DT37")] T37, [System.ComponentModel.Description("DT38")] T38, } public enum EnumMutliFTest2 { [System.ComponentModel.Description("DT21")] T21, [System.ComponentModel.Description("DT22")] T22, [System.ComponentModel.Description("DT23")] T23, [System.ComponentModel.Description("DT24")] T24, [System.ComponentModel.Description("DT25")] T25, [System.ComponentModel.Description("DT26")] T26, [System.ComponentModel.Description("DT27")] T27, [System.ComponentModel.Description("DT28")] T28, [System.ComponentModel.Description("DT29")] T29, [System.ComponentModel.Description("DT210")] T210, [System.ComponentModel.Description("DT211")] T211, [System.ComponentModel.Description("DT212")] T212, [System.ComponentModel.Description("DT213")] T213, [System.ComponentModel.Description("DT214")] T214, [System.ComponentModel.Description("DT215")] T215, [System.ComponentModel.Description("DT216")] T216, [System.ComponentModel.Description("DT217")] T217, [System.ComponentModel.Description("DT218")] T218, [System.ComponentModel.Description("DT219")] T219, [System.ComponentModel.Description("DT220")] T220, [System.ComponentModel.Description("DT221")] T221, [System.ComponentModel.Description("DT222")] T222, [System.ComponentModel.Description("DT223")] T223, [System.ComponentModel.Description("DT224")] T224, [System.ComponentModel.Description("DT225")] T225, [System.ComponentModel.Description("DT226")] T226, [System.ComponentModel.Description("DT227")] T227, [System.ComponentModel.Description("DT228")] T228, [System.ComponentModel.Description("DT229")] T229, [System.ComponentModel.Description("DT230")] T230, [System.ComponentModel.Description("DT231")] T231, [System.ComponentModel.Description("DT232")] T232, [System.ComponentModel.Description("DT233")] T233, [System.ComponentModel.Description("DT234")] T234, [System.ComponentModel.Description("DT235")] T235, [System.ComponentModel.Description("DT236")] T236, [System.ComponentModel.Description("DT237")] T237, [System.ComponentModel.Description("DT238")] T238, } //['dʒendə] [Flags] public enum EnumGender { None, [System.ComponentModel.Description("男")] Male, [System.ComponentModel.Description("女")] Female, Other, } }View Code
3.輔助測試類TestHelper.cs
public static class TestHelper { /// <summary> /// 執行一個方法並返回執行時間間隔 /// </summary> public static TimeSpan InvokeAndGetTimeSpan(Action call) { Stopwatch sw = new Stopwatch(); sw.Start(); call(); sw.Stop(); return sw.Elapsed; } ///