一. 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;
}
ps：.NET獲取枚舉值的描述
一、給枚舉值定義描述的方式
public enum TimeOfDay
{
[Description("早晨")]
Moning = 1,
[Description("下午")]
Afternoon = 2,
[Description("晚上")]
Evening = 3,
}
二、獲取枚舉值的描述的方法
public static string GetDescriptionFromEnumValue(Type enumType, object enumValue)
{
try
{
object o = Enum.Parse(enumType, enumValue.ToString());
string name = o.ToString();
DescriptionAttribute[] customAttributes = (DescriptionAttribute[])enumType.GetField(name).GetCustomAttributes(typeof(DescriptionAttribute), false);
if ((customAttributes != null) && (customAttributes.Length == 1))
{
return customAttributes[0].Description;
}
return name;
}
catch
{
return "未知";
}
}
三、獲取枚舉值的描述的方法的使用
string strMoning = GetDescriptionFromEnumValue( typeof (TimeOfDay) , 2 );
