.NET Emit 入門教程：第三部分：構建模組（Module）

路过秋天發表於2024-03-22
MIT

前言：

在這一部分中，我們將深入討論動態程式集中模組的概念以及如何構建和管理模組。

1、模組的概念：

模組是動態程式集中的基本單位，它類似於一個獨立的程式碼單元，可以包含型別、方法、欄位等成員。

在動態程式集中，模組扮演著組織程式碼和實現程式碼複用的關鍵角色。

它們允許開發人員將相關功能和資料組織在一起，並在需要時進行引用和重用。

一個程式集可以包含一個或多個模組，這種模組化的設計有助於提高程式碼的可維護性和可擴充套件性。

通俗的講人話：

即在設計上：在執行時，一個程式集可以包含多個模組，每個模組允許用不同的語言編寫，比如VB模組混合C#模組。

在使用上：在編繹後，一個程式集只能包含一個模組。

下面來看一個組問答題：

2、程式集和模組的關係問答：

既然一個程式集可以定義多個Module，為什麼透過反編繹dll，發現所有的dll檔案都只有一個module呢？

在使用 C# 或 .NET Framework 動態建立程式集和模組時，無論你建立了多個模組，最終生成的 DLL 檔案通常只會包含一個預設模組。

這是因為在 .NET 中，一個程式集（assembly）通常對應一個 DLL 或者 EXE 檔案，而每個程式集只包含一個預設的模組。

即使你在程式碼中使用 DefineDynamicModule 建立了多個模組，最終生成的 DLL 檔案也只會包含預設模組的資訊。

其他透過 DefineDynamicModule 建立的模組並不會以獨立的形式出現在最終的 DLL 檔案中。

實際上，在 .NET 中，程式集可以包含多個模組，但這些附加的模組一般不會直接儲存在磁碟檔案中，而是在執行時動態載入到程式集中。這也是為什麼反編譯時只能看到一個模組的原因。

總的來說，即使你在程式碼中動態建立了多個模組，最終生成的 DLL 檔案也只會包含一個預設模組。其他動態建立的模組會以其他方式與程式集關聯，並不會直接體現在生成的 DLL 檔案中。

瞭解完程式集與模組的對應關係，下面看看如何建立動態模組：

3、建立動態模組：

使用C# Emit 技術可以在執行時動態建立模組。

首先，需要獲得 AssemblyBuilder（這個在構建程式集一文中，已經講解了 .NET 和 .NET Core 下的相關獲取用法）。

然後，透過 AssemblyBuilder 的 DefineDynamicModule方法，即可獲得 ModuleBuilder（後續章節會透過它，來新增型別、方法、欄位等成員到模組中，從而構建出所需的模組結構）。

下面是一個獲得 ModuleBuilder 示例程式碼：

 AssemblyBuilder ab = ......
 ModuleBuilder mb = ab.DefineDynamicModule("一個名稱");

4、建立靜態模組（僅.NET系列支援）：

在.NET中，如果要將該模組持久化到 dll 中，則需要在過載中指定 dll 的名稱，如：

 AssemblyBuilder assemblyBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndSave);

//......

 ModuleBuilder moduleBuilder = assemblyBuilder.DefineDynamicModule("一個名稱", dllName + ".dll");

//......

 assemblyBuilder.Save(dllName + ".dll");

正如問答所說，一個程式集在持久化到檔案中時，只能包含一個預設模組。

因此，透過指定和程式集相同的名稱，來持久化到相同的程式集中。

如果定義多個模組，都指向同一個程式集名稱中呢？

如下圖，拋重複的檔名異常：

如果定義多個模組，都給予不同的程式集名稱呢？

如下圖，每個模組單獨生成程式集：

因此，在執行時，可以定義多個模組，模組在執行時可以互動，但持久化到檔案中，只能有一個模組。

5、模組間的互動

模組之間可能存在依賴關係，一個模組可能需要引用另一個模組中的型別或成員。

在動態程式集中，可以使用 AssemblyBuilder 來建立程式集並將模組進行組合，從而實現模組間的互動和依賴管理。

通常而言，不建議嘗試在程式集中定義多個模組，下面給幾個教訓的示例：

因情節需要，以下內容中會提前出現 TypeBuilder、MethodBuilder 和 IL程式碼。

在 .NET 中定義多個模組，並嘗試進行互動：

public static void Start()
{
    // 建立第一個模組
    AssemblyName assemblyName = new AssemblyName("MyAssembly");
    AssemblyBuilder assemblyBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.Run);
    ModuleBuilder moduleBuilder1 = assemblyBuilder.DefineDynamicModule("Module1");

    // 在第一個模組中定義一個型別
    TypeBuilder typeBuilder1 = moduleBuilder1.DefineType("MyClass", TypeAttributes.Public);

    MethodBuilder methodBuilder1 = typeBuilder1.DefineMethod("MyMethod", MethodAttributes.Public | MethodAttributes.Static, typeof(void), null);
    ILGenerator ilGenerator = methodBuilder1.GetILGenerator();
    ilGenerator.EmitWriteLine("Call hello from Module1!");
    ilGenerator.Emit(OpCodes.Ret);
    typeBuilder1.CreateType();


    // 在第二個模組中引用第一個模組中定義的型別
    MethodInfo myMethod = moduleBuilder1.GetType("MyClass").GetMethod("MyMethod");


    // 建立第二個模組
    ModuleBuilder moduleBuilder2 = assemblyBuilder.DefineDynamicModule("Module2");
    TypeBuilder typeBuilder2 = moduleBuilder2.DefineType("MyClass2", TypeAttributes.Public);
    MethodBuilder methodBuilder2 = typeBuilder2.DefineMethod("MyMethod2", MethodAttributes.Public | MethodAttributes.Static, typeof(void), null);
    var ilGenerator2 = methodBuilder2.GetILGenerator();
    ilGenerator2.EmitWriteLine("Exe hello from Module2!");
    ilGenerator2.EmitCall(OpCodes.Call, myMethod, null);
    ilGenerator2.Emit(OpCodes.Ret);
    typeBuilder2.CreateType();


    //assemblyBuilder.LoadModule()

    var myMethod2 = moduleBuilder2.GetType("MyClass2").GetMethod("MyMethod2");

    //myMethod.Invoke(null, null);
    myMethod2.Invoke(null, null);

    Console.Read();
}

結果如下：

同樣的程式碼，在 .NET Core 中執行，你將得到以下結果：

所以，你懂的，別折騰這個。

總結：

嗯，構建模組，一行程式碼的事情，愣是讓我寫成了一篇教程，太難了，下面進行總結。

在這個入門教程的第三部分中，我們學習瞭如何使用.NET Emit 構建模組（Module）。

透過建立和定義模組，我們可以更好地組織和管理我們的程式碼。

在這個過程中，我們瞭解瞭如何使用 AssemblyBuilder 和 ModuleBuilder 來動態生成模組。

透過學習構建模組的過程，我們可以更深入地理解.NET Emit 的強大功能，並且能夠在執行時動態地生成和載入程式碼。

構建模組是.NET Emit中非常重要的一部分，它為我們提供了靈活性和擴充套件性，讓我們能夠更好地應對各種程式設計需求。

在接下來的學習中，我們將繼續探索.NET Emit的各種功能和用法，不斷豐富我們的動態程式碼生成技能，為我們的專案帶來更多可能性。

希望這個入門教程能夠幫助你更好地理解.NET Emit，併為你的程式設計之路增添新的技能和知識！

相關文章