開發程序的時候經常會引用一些第三方的DLL,然后編譯生成的exe文件就不能脫離這些DLL獨立運行了。這樣交給用戶很不方便,希望的效果是直接交付一個exe文件。
這時候就需要借助一款名為Fody.Costura的插件。Fody.Costura是一個Fody框架下的插件,可通過Nuget安裝到VS工程中。安裝之后,就可以將項目所依賴的DLL(甚至PDB)文件全部打包到EXE文件里。
使用 Costura.Fody ,這個強大之處是可以在build階段直接將依賴的DLL合並在目標EXE中,支持非托管DLL進行mixed mode 打包。不足之處是只能將DLL合並到EXE中,不支持DLL和DLL的合並。
github地址:https://github.com/Fody/Costura
nuget地址:https://www.nuget.org/packages/Costura.Fody/
使用場景:最終發布只有一個EXE,將依賴的DLL合並到一個EXE中。
使用方法
1、在VS中,通過Nuget為目標EXE工程安裝Costura.Fody。
2、重新構建項目。
構建完成后,到項目的輸出目錄下找到新生成的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的配置文件來實現,具體的操作步驟可以參考它的官方文檔。
實現原理介紹
當CLR試圖加載一個程序集但加載失敗時,它會引發AppDomain.AssemblyResolve事件。我們的程序可以監聽這個事件,並且在這個事件的處理函數中返回這個CLR試圖加載的程序集,從而使程序得以繼續正常運行。
Fody.Costura在構建項目時會把EXE引用到的DLL全部嵌入到EXE文件中。當程序在運行的過程中用到其中某個DLL的時候(此時由於CLR無法找到該DLL文件,導致AppDomain.AssemblyResolve事件被觸發)再從EXE文件的嵌入資源中提取所需的DLL。
下面這兩個函數就是Fody.Costura實現這部分邏輯的代碼。
public static void Attach() { var currentDomain = AppDomain.CurrentDomain; currentDomain.AssemblyResolve += (s, e) => ResolveAssembly(e.Name); }
public static Assembly ResolveAssembly(string assemblyName) { if (nullCache.ContainsKey(assemblyName)) { return null; } var requestedAssemblyName = new AssemblyName(assemblyName); var assembly = Common.ReadExistingAssembly(requestedAssemblyName); if (assembly != null) { return assembly; } Common.Log("Loading assembly '{0}' into the AppDomain", requestedAssemblyName); assembly = Common.ReadFromEmbeddedResources(assemblyNames, symbolNames, requestedAssemblyName); if (assembly == null) { nullCache.Add(assemblyName, true); // Handles retargeted assemblies like PCL if (requestedAssemblyName.Flags == AssemblyNameFlags.Retargetable) { assembly = Assembly.Load(requestedAssemblyName); } } return assembly; }
可以看到,Attach方法監聽了AppDomain.AssemblyResolve事件。當CLR無法成功加載某個程序集時, AssemblyResolve事件處理函數會被執行。AssemblyResolve會嘗試通過Common.ReadFromEmbeddedResources方法從已加載的程序集的嵌入資源中獲取目標程序集,並返回給CLR。
Attach方法是在什么時候執行的呢?
其實是這樣的,對於C#語言來說,CLR隱藏了一個大招——CLR可以在每個模塊(每個程序集都含有一個或多個模塊)加載之前執行一些初始化的代碼。但是很遺憾,C#語言無法控制這部分代碼。Fody.Costura則是在內部將IL代碼直接注入到EXE程序集內部模塊的初始化函數中,而這部分IL代碼其實就是執行了Attach方法。這樣一來,EXE程序集被加載后,Attach方法就能夠立即得到調用了。
與此相同原理的將DLL添加到EXE的資源(http://blogs.msdn.com/b/microsoft_press/archive/2010/02/03/jeffrey-richter-excerpt-2-from-clr-via-c-third-edition.aspx);