把C#程序（含多個Dll）合併成一個Exe的超簡單方法

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

可是，不少時候咱們本想開發一款只須要一個exe就能完美運行的小工具。那該怎麼辦呢？

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

這裏咱們須要用到一款名爲Fody.Costura的工具。Fody.Costura是一個Fody框架下的插件，可經過Nuget安裝到VS工程中。安裝以後，就能夠將項目所依賴的DLL（甚至PDB）文件所有打包到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的配置文件來實現，具體的操做步驟能夠參考它的官方文檔。

好了，Fody.Costura的使用方式已經介紹完了。若是你對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方法就可以當即獲得調用了。

以上就是Fody.Costura實現原理的簡單介紹。