文章出處

開發程序的時候經常會引用一些第三方的DLL，然后編譯生成的exe文件就不能脫離這些DLL獨立運行了。

但是，很多時候我們本想開發一款只需要一個exe就能完美運行的小工具。那該怎么辦呢？

下文介紹一種超簡單的方法，不用寫一行代碼就可輕松實現。

這里我們需要用到一款名為Fody.Costura的工具。Fody.Costura是一個Fody框架下的插件，可通過Nuget安裝到VS工程中。安裝之后，就可以將項目所依賴的DLL（甚至PDB）文件全部打包到EXE文件里。

使用方法

在VS中，通過Nuget為目標EXE工程安裝Costura.Fody。或者通過NuGet控制臺用命令行安裝：Install-Package Costura.Fody -Version 1.3.3
重新構建項目。

構建完成后，到項目的輸出目錄下找到新生成的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的實現原理感到好奇，可以接著往下看。

合并非托管的DLL

 1 <?xml version="1.0" encoding="utf-8"?>
 2 <Weavers>
 3   <Costura>
 4     <Unmanaged32Assemblies>
 5       SQLite.Interop
 6     </Unmanaged32Assemblies>
 7     <Unmanaged64Assemblies>
 8       SQLite.Interop
 9     </Unmanaged64Assemblies>
10   </Costura>
11 </Weavers>

代碼

實現原理介紹

當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實現原理的簡單介紹。

文章列表