為什么 .NET的反射這么慢?
大家都知道 .NET 的反射很慢,但是為什么會出現這種情況呢?這篇文章會帶你尋找這個問題的真正原因。
CLR 類型系統的設計目標
原因之一是,在設計的時候反射本身就不是以高性能為目標的,可以參考Type System Overview – ‘Design Goals and Non-goals’(類型系統概覽 – ‘設計目標和非目標’):
目標
- 運行時通過快速執行(非反射)代碼訪問需要的信息。
- 編譯時直接訪問所需要的信息來生成代碼。
- 垃圾回收/遍歷棧可以訪問需要信息而不需要鎖或分配內存。
- 一次只加載最少量的類型。
- 類型加載時只加載最少需要加載的類型。
- 類型系統的數據結構必須在 NGEN 映像中保存。
非目標
- 元數據的所有信息能直接反射 CLR 數據結構。
- 快速使用反射。
參閱出處相同的 Type Loader Design – ‘Key Data Structures’(類型加載器設計 – ‘關鍵數據結構’):
EEClass
MethodTable(方法表)數據分為“熱”和“冷”兩種結構,以提高工作集和緩存的利用率。MethodTable 本身只存儲程序穩定狀態的“熱”數據。EEClass 存儲“冷”數據,它們通常是類型加載、JITing或反射所需要的。每個 MethodTable 指向一個 EEClass。
反射是如何工作的?
我們已經知道反射本身就不是以快為目標來設計的,但是它為什么需要那么多時間呢?
為了說明這個問題,來看看反射調用過程中,托管代碼和非托管代碼的調用棧。
- System.Reflection.RuntimeMethodInfo.Invoke(..) - 源碼鏈接
- 調用 System.Reflection.RuntimeMethodInfo.UnsafeInvokeInternal(..)
- System.RuntimeMethodHandle.PerformSecurityCheck(..) - 鏈接
- 調用 System.GC.KeepAlive(..)
- System.Reflection.RuntimeMethodInfo.UnsafeInvokeInternal(..) - 鏈接
- 調用 System.RuntimeMethodHandle.InvokeMethod(..) 的存根
- System.RuntimeMethodHandle.InvokeMethod(..) 的存根 - 鏈接
即使不點擊鏈接,想必你也能直觀感受到改方法執行的大量代碼。參考示例:System.RuntimeMethodHandle.InvokeMethodis 超過 400 行代碼!
那么,它具體在做什么?
獲取方法信息
要使用反射來調用字段/屬性/方法,你必須獲得 FieldInfo/PropertyInfo/MethodInfo,使用這樣的代碼:
Type t = typeof(Person);
FieldInfo m = t.GetField("Name");
這需要一定的成本,因為需要提取相關的元數據,并對其進行解析。運行時會幫我們維持一個內部緩存,緩存著所有字段/屬性/方法。這個緩存由 RuntimeTypeCache 類實現,用法示例在 RuntimeMethodInfo 類中.
運行 gist 中的代碼你可以看到緩存的何運作方式,它恰如其分地使用反射檢查運行時內部!
gist 上的代碼會在你使用反射獲得 FieldInfo 之前輸出下列內容:
Type: ReflectionOverhead.Program
Reflection Type: System.RuntimeType (BaseType: System.Reflection.TypeInfo)
m_fieldInfoCache is null, cache has not been initialised yet
不過一旦你獲得字段,就會輸出:
Type: ReflectionOverhead.Program
Reflection Type: System.RuntimeType (BaseType: System.Reflection.TypeInfo)
RuntimeTypeCache: System.RuntimeType+RuntimeTypeCache,
m_cacheComplete = True, 4 items in cache
[0] - Int32 TestField1 - Private
[1] - System.String TestField2 - Private
[2] - Int32 <TestProperty1>k__BackingField - Private
[3] - System.String TestField3 - Private, Static
ReflectionOverhead.Program 看起來像這樣:
class Program
{
private int TestField1;
private string TestField2;
private static string TestField3;
private int TestProperty1 { get; set; }
}
看來運行時會篩選已經創建過的東西,這意味著調用 GetFeild 或 GetFields 不需要多大代價。對于 GetMethod 和 GetProperty 來說也是如此,MethodInfo 或 PropertyInfo 會在你***次調用的時候創建并緩存起來。
參數校驗和錯誤處理
得到 MethodInfo 之后,如果調用它的 Invoke 方法,會要處理很多事項。假設編寫代碼如下:
PropertyInfo stringLengthField =
typeof(string).GetProperty("Length",
BindingFlags.Instance | BindingFlags.Public);
var length = stringLengthField.GetGetMethod().Invoke(new Uri(), new object[0]);
如果運行上述代碼,會得到下面的異常:
System.Reflection.TargetException: Object does not match target type.
at System.Reflection.RuntimeMethodInfo.CheckConsistency(..)
at System.Reflection.RuntimeMethodInfo.InvokeArgumentsCheck(..)
at System.Reflection.RuntimeMethodInfo.Invoke(..)
at System.Reflection.RuntimePropertyInfo.GetValue(..)
這是因為我們獲得了 String 類 Length 屬性的 PropertyInfo,但是卻在 Uri 對象上調用它,顯然,這是個錯誤的類型!
此外,你還必須在調用方法時對傳遞給方法的參數進行校驗。為了能傳遞參數,反射 API 使用了一個 object 的數組作為參數,其中每一個元素表示一個參數。所以,如果你使用反射來調用 Add(int x, int y) 方法,你得調用 methodInfo.Invoke(.., new [] { 5, 6 })。運行時會對傳入參數的數量和類型進行檢查,在這個示例中你要確保是 2 個 int 類型的參數。這些工作不好的地方是常常需要裝箱,這會增加額外的成本。希望這在將來會降到***。
安全性檢查
另一個主要任務是多重安全性檢查。例如,你不允許使用反射來任意調用你想調用的方法。這里存在一些限制的或 ‘危險方法’,只能由可信度高的 .NET 框架代碼調用。除了黑名單外,還有動態安全檢查,它由調用時必須檢查的的當前代碼訪問安全權限決定。
反射機制耗時多少?
了解反射的實際操作后,我們來看看實際耗時。請注意,這些基準測試是通過反射直接比較讀/寫屬性來完成的。在 .NET 中屬性是一對 Get/Set 方法,這是由編譯器生成的,但當屬性只包含一個簡單的內嵌字段時,.NET JIT 會使用內聯 Get/Set 方法以提升性能。這意味著使用反射訪問屬性可能會遇到反射性能最差的情況,但它會被選擇是因為這是最常見的用例,數據位于 ORMs, Json 序列化/反序列化庫和對象映射工具中。
以下是由 BenchmarkDotNet 提供的原始結果,后面是在2個單獨的表中顯示的相同結果。 (全部Benchmark代碼由此下載 )
讀取屬性值(‘Get’)
寫屬性值(‘Set’)
我們可以清楚地看到,正常的反射代碼(GetViaReflection/SetViaReflection)比直接訪問屬性(GetViaProperty/SetViaProperty)要慢得多。 其他結果,我們還要進一步分析。
設置
首先我們從 aTestClass 開始,代碼如下:
public class TestClass
{
public TestClass(String data) {
Data = data;
}
private string data;
private string Data
{
get { return data; }
set { data = value; }
}
}
以及下面的通用代碼,這里包含了所有可用的選項:
// Setup code, done only once
TestClass testClass = new TestClass("A String");
Type @class = testClass.GetType();
BindingFlag bindingFlags = BindingFlags.Instance |
BindingFlags.NonPublic |
BindingFlags.Public;
正常的反射
首先我們使用常規基準代碼來表示我們的起始情況和“最壞情況”:
[Benchmark]public string GetViaReflection() {
PropertyInfo property = @class.GetProperty("Data", bindingFlags);
return (string)property.GetValue(testClass, null);
}
選擇1 – 緩存 PropertyInfo
接下來,我們通過保存引用至 PropertyInfo 以獲得速度上的少量提升,而不是每次都去獲取。但即使這樣,與直接訪問屬性相比,也仍然慢得多,這就表明在反射的“調用”部分成本很高。
// Setup code, done only once
PropertyInfo cachedPropertyInfo = @class.GetProperty("Data", bindingFlags);
[Benchmark]
public string GetViaReflection() {
return (string)cachedPropertyInfo.GetValue(testClass, null);
}
選擇2 – 使用 FastMember
這里使用了 Marc Gravell 優秀的 Fast Member 庫,這個庫用起來很簡單!
// Setup code, done only once
TypeAccessor accessor = TypeAccessor.Create(@class, allowNonPublicAccessors: true);
[Benchmark]
public string GetViaFastMember() {
return (string)accessor[testClass, "Data"];
}
注意,與其他選擇稍有不同,它創建了一個 TypeAccessor 來訪問類型中的所有屬性,而不僅是某一個。這帶來的負面影響是會導致運行時間變長,因為它在內部首先要為你請求的屬性(這個例子中是‘Data’)創建委托,然后再獲取其值。不過這種開銷是很小的,FastMember 仍然比其它反射方法更快,也更易用。所以我建議你先去看看。
這個選擇及隨后的選擇將反射代碼轉換委托,這樣就可以直接調用而不再需要每次都進行反射,速度因此得到提升!
必須指出創建一個委托需要一定的成本(可以從 ‘相關閱讀’ 了解更多)。總之,速度提升是因為我們在其中進行過一次大投入(安全檢查等)并保存了一個強類型的委托,之后我們只要稍微付出一點就可以一次次調用。如果反射只進行一次,那你大可不必使用這些技術。但是如果你只進行一次反射操作,它也不會出現性能瓶頸,你就完全不用在乎它會變慢!
通過委托讀某個屬性仍然不如直接訪問來得快,因為 .NET JIT 不會將對委托方法的調用進行內聯優化,而直接訪問屬性則會。因此即使使用委托,我們也需要為調用方法付出成本,而直接訪問屬性就不會。
選項3——創建代理(Delegate)
在這個選項中,我們使用 CreateDelegate 函數來將 PropertyInfo 轉換為常規的 delegate:
// Setup code, done only once
PropertyInfo property = @class.GetProperty("Data", bindingFlags);
Func<TestClass, string> getDelegate =
(Func<TestClass, string>)Delegate.CreateDelegate(
typeof(Func<TestClass, string>),
property.GetGetMethod(nonPublic: true));
[Benchmark]
public string GetViaDelegate() {
return getDelegate(testClass);
}
它的缺點是你必須知道編譯時的具體類型,也就是上面的代碼中的 Func<TestClass,string> 部分(如果使用 Func<object,string>,編譯器會拋出一個異常!)。不過,在大多數情況下,使用反射不會遇到這么多麻煩。
有效避免麻煩,請參閱 MagicMethodHelper 代碼(在 Jon Skeet 發布的“Making Reflection fly and exploring delegates“博客中),或閱讀下面的選項 4 或 5。
選項4——編譯表達式樹(Compiled Expression Trees)
這里我們生成一個 delegate,但不同的是我們可以傳入一個 object,所以我們會看到“選項4”的限制。我們使用支持動態代碼生成的 .NET Expression tree API:
// Setup code, done only once
PropertyInfo property = @class.GetProperty("Data", bindingFlags);
ParameterExpression = Expression.Parameter(typeof(object), "instance");
UnaryExpression instanceCast =
!property.DeclaringType.IsValueType ?
Expression.TypeAs(instance, property.DeclaringType) :
Expression.Convert(instance, property.DeclaringType);
Func<object, object> GetDelegate =
Expression.Lambda<Func<object, object>>(
Expression.TypeAs(
Expression.Call(instanceCast, property.GetGetMethod(nonPublic: true)),
typeof(object)),
instance)
.Compile();
[Benchmark]
public string GetViaCompiledExpressionTrees() {
return (string)GetDelegate(testClass);
}
關于 Expression 的全部代碼可以從“Faster Reflection using Expression Trees(使用表達式樹的快速反射機制)“博客下載。
選項 5——IL Emit 動態代碼生成
***,雖然“權力越大,責任越大”,但這里我們還是使用***層的方法調用原始 IL,:
// Setup code, done only once
PropertyInfo property = @class.GetProperty("Data", bindingFlags);
Sigil.Emit getterEmiter = Emit<Func<object, string>>
.NewDynamicMethod("GetTestClassDataProperty")
.LoadArgument(0)
.CastClass(@class)
.Call(property.GetGetMethod(nonPublic: true))
.Return();
Func<object, string> getter = getterEmiter.CreateDelegate();
[Benchmark]
public string GetViaILEmit() {
return getter(testClass);
}
使用 Expression tress(如選項 4 中所說),并沒有給出像直接調用 IL 代碼那么多的靈活性,盡管它確實能防止你調用無效代碼! 考慮到這一點,如果你發現自己確實需要 emit IL,我強烈推薦你使用性能卓越的 Sigil 庫,因為它能在出錯時提供更好的錯誤提示消息!
小結
如果(也只是如果)你發現自己在使用反射的時候有性能問題,有一些辦法可以讓它變得更快。獲得這些速度提升是因為委托帶來的對屬性/字段/方法進行直接訪問,這避免了每次進行反射的開銷。
請在 /r/programming 和 /r/csharp 參考討論這篇文章