開發程式的時候經常會引用一些第三方的DLL,然後編譯生成的exe文件就不能脫離這些DLL獨立運行了。 但是,很多時候我們本想開發一款只需要一個exe就能完美運行的小工具。那該怎麼辦呢? 下文介紹一種超簡單的方法,不用寫一行代碼就可輕鬆實現。 這裡我們需要用到一款名為Fody.Costura的工具。F ...
開發程式的時候經常會引用一些第三方的DLL,然後編譯生成的exe文件就不能脫離這些DLL獨立運行了。
但是,很多時候我們本想開發一款只需要一個exe就能完美運行的小工具。那該怎麼辦呢?
下文介紹一種超簡單的方法,不用寫一行代碼就可輕鬆實現。
這裡我們需要用到一款名為Fody.Costura的工具。Fody.Costura是一個Fody框架下的插件,可通過Nuget安裝到VS工程中。安裝之後,就可以將項目所依賴的DLL(甚至PDB)文件全部打包到EXE文件里。
使用方法
- 在VS中,通過Nuget為目標EXE工程安裝Costura.Fody。
- 重新構建項目。
構建完成後,到項目的輸出目錄下找到新生成的EXE文件,你同時會發現輸出目錄下仍然存在那些DLL。不過不用擔心,這個EXE已經能夠獨立運行了。你可以把這些DLL全部刪除後再運行EXE試試。
另外,Fody.Costura還支持一些進階的特性,例如:
- 臨時程式集文件:在運行EXE前自動,自動將DLL從EXE中解壓到文件夾系統中,再通過常規的方式載入該DLL。
- 合併非托管的DLL:Fody.Costura可以合併非托管的DLL,但是不會自動合。如果你的程式涉及非托管DLL,那麼你需要通過修改Fody.Costura的配置文件來顯示地告訴它你想合併哪些非托管的DLL。
- 預載入DLL:Fody.Costura可以幫助你在程式啟動時預先載入某些DLL,你甚至可以指定這些DLL的載入順序。
以上這些進階特性都需要你通過修改Fody.Costura的配置文件來實現,具體的操作步驟可以參考它的官方文檔。
好了,Fody.Costura的使用方式已經介紹完了。如果你對Fody.Costura的實現原理感到好奇,可以接著往下看。
實現原理介紹
當CLR試圖載入一個程式集但載入失敗時,它會引發AppDomain.AssemblyResolve事件。我們的程式可以監聽這個事件,並且在這個事件的處理函數中返回這個CLR試圖載入的程式集,從而使程式得以繼續正常運行。
Fody.Costura在構建項目時會把EXE引用到的DLL全部嵌入到EXE文件中。當程式在運行的過程中用到其中某個DLL的時候(此時由於CLR無法找到該DLL文件,導致AppDomain.AssemblyResolve事件被觸發)再從EXE文件的嵌入資源中提取所需的DLL。
下麵這兩個函數就是Fody.Costura實現這部分邏輯的代碼。
1 public static void Attach() 2 { 3 var currentDomain = AppDomain.CurrentDomain; 4 currentDomain.AssemblyResolve += (s, e) => ResolveAssembly(e.Name); 5 } 6 public static Assembly ResolveAssembly(string assemblyName) 7 { 8 if (nullCache.ContainsKey(assemblyName)) 9 { 10 return null; 11 } 12 13 var requestedAssemblyName = new AssemblyName(assemblyName); 14 15 var assembly = Common.ReadExistingAssembly(requestedAssemblyName); 16 if (assembly != null) 17 { 18 return assembly; 19 } 20 21 Common.Log("Loading assembly '{0}' into the AppDomain", requestedAssemblyName); 22 23 assembly = Common.ReadFromEmbeddedResources(assemblyNames, symbolNames, requestedAssemblyName); 24 if (assembly == null) 25 { 26 nullCache.Add(assemblyName, true); 27 28 // Handles retargeted assemblies like PCL 29 if (requestedAssemblyName.Flags == AssemblyNameFlags.Retargetable) 30 { 31 assembly = Assembly.Load(requestedAssemblyName); 32 } 33 } 34 return assembly; 35 }View Code
可以看到,Attach方法監聽了AppDomain.AssemblyResolve事件。當CLR無法成功載入某個程式集時, AssemblyResolve事件處理函數會被執行。AssemblyResolve會嘗試通過Common.ReadFromEmbeddedResources方法從已載入的程式集的嵌入資源中獲取目標程式集,並返回給CLR。
看到這裡,你可能會問,Attach方法是在什麼時候執行的呢?
其實是這樣的,對於C#語言來說,CLR隱藏了一個大招——CLR可以在每個模塊(每個程式集都含有一個或多個模塊)載入之前執行一些初始化的代碼。但是很遺憾,C#語言無法控制這部分代碼。Fody.Costura則是在內部將IL代碼直接註入到EXE程式集內部模塊的初始化函數中,而這部分IL代碼其實就是執行了Attach方法。這樣一來,EXE程式集被載入後,Attach方法就能夠立即得到調用了。
以上就是Fody.Costura實現原理的簡單介紹。