.NET Emit 入門教程:第二部分:構建動態程式集(追加構建靜態程式集教程)

来源:https://www.cnblogs.com/cyq1162/p/18085811
-Advertisement-
Play Games

在本章節中,我們討論瞭如何使用 C# Emit 來構建動態程式集,以獲得 AssemblyBuilder 這個程式集構建器,開啟構建程式集的第一步。同時我們也討論瞭如何使用 C# Emit 來構建動態程式集以及程式集的持久化。同時還分享了自己的乾貨,如何使用 CodeDom 和 Roslyn 來構建... ...


前言:

在本部分中,我們將深入探討如何使用C# Emit 來創建動態程式集。

動態程式集是在運行時生成的,為我們提供了一種靈活、動態地構建和載入程式集的能力。

1. 程式集的概念

程式集是.NET中的基本部署單位,它包含了可執行代碼、資源、元數據等信息,是.NET應用程式的基本組成單元之一。

與靜態程式集(即程式集持久化)不同,動態程式集是在運行時生成的,使得我們可以根據需要動態地構建和載入程式集。

動態程式集的重要性體現在多個方面,包括但不限於模塊化、版本控制、代碼復用等。

通過動態程式集,我們可以更好地管理和組織代碼,實現更靈活的程式設計和開發。

2、Emit 構建程式集支持情況:

.Net 系列:動態程式集:支持;程式集持久化:支持。

.Net Core 系列:動態程式集:支持;程式集持久化不支持
 

3、Emit 創建動態程式集:

在C#中,操作程式集的核心類是:AssemblyBuilder。

在這過程,我們可以使用  AssemblyName 來定義程式集的名稱和版本等信息。

AssemblyName assemblyName = new AssemblyName("MyDllName") { Version = new Version("1.0.0.0") };

創建程式集對象,在 .Net 和 .Net Core 中有所不同:

.NET 代碼:通過 AppDomain.DefineDynamicAssembly 來創建動態程式集對象:

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

AssemblyBuilderAccess 在 .Net 系列中的屬性:

AssemblyBuilderAccess.Run; 表示程式集可被執行,但不能被保存。  
AssemblyBuilderAccess.Save; 表示程式集可被保存,但不能被執行。  
AssemblyBuilderAccess.RunAndSave; 表示程式集可被保存並能被執行。
AssemblyBuilderAccess.ReflectionOnly; 表示程式集只能用於反射上下文環境中,不能被執行。 
AssemblyBuilderAccess.RunAndCollect; 表示程式集可以被卸載並且記憶體會被回收

.NET Core 代碼:通過 AssemblyBuilder.DefineDynamicAssembly 來創建動態程式集對象:

AssemblyBuilder ab = AssemblyBuilder.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.Run);

AssemblyBuilderAccess 在 .Net Core 系列中的屬性:

AssemblyBuilderAccess.Run; 表示程式集可被執行,但不能被保存。  
AssemblyBuilderAccess.Collect; 表示程式集可以被卸載並且記憶體會被回收
 

可以看到,目前版本是不支持持久化功能。

4:總結一:

在本章節中,我們討論瞭如何使用 C# Emit 來構建動態程式集,以獲得 AssemblyBuilder 這個程式集構建器,開啟構建程式集的第一步。

在之後的文章,我們會講解如何用它的 DefineDynamicModule 來定義模塊,以之後構建類、成員、方法等,來實現構建完整的程式集。

當然,對於構建動態程式集,本文章到此會顯的有點簡單,為了避免被大伙說文章太水。

於是,打算追加一下對於構建靜態程式集(即持久化程式集)的相關知識。

構建靜態程式集的三種方式:

.Net 系列:使用 EmitCodeDom(System.CodeDom.Compiler 系統集成)

.Net Core 系列:Roslyn(Microsoft.CodeAnalysis.CSharp 需要引用組件包)

5、Emit 構建靜態程式集:

在上述代碼中,我們通過 AssemblyName 來指定程式集名稱和版本號。

如果我們希望持久化程式集,並將程式集分發給其它人調用,則需要補充更多的相關信息:

比如:Taurus.MVC 微服務組件中就實現了動態生成 Rpc 調用程式集,以供其它微服務節點調用。

在定義完程式集名稱和版本後(AssemblyBuilderAccess 需要指定為 RunAndSave )。

我們可以通過 AssemblyBuilder  的 SetCustomAttribute 方法,來添加自定義屬性,最後通過 Save 方法,來持久化程式集:

internal class Program
{
    static void Main(string[] args)
    {
        string dllName = "MyDynamic";
        string title = "This is a dynamic title.";

        AssemblyName assemblyName = new AssemblyName(dllName) { Version = new Version("3.0.0.0") };
        AssemblyBuilder assemblyBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndSave);

        // 添加自定義屬性到程式集
      var titleAttr = new CustomAttributeBuilder(
typeof(AssemblyTitleAttribute).GetConstructor(new Type[] { typeof(string) }), new object[] { title } ); assemblyBuilder.SetCustomAttribute(titleAttr); assemblyBuilder.DefineVersionInfoResource(); assemblyBuilder.Save(dllName + ".dll"); Console.WriteLine("程式集已生成"); } }

自定義支持哪些屬性,可以參考工程目錄下的:AssemblyInfo.cs 信息:

沒有指定完整的保存路徑時,程式運行之後預設在運行目錄下可以看到生成的程式集:

通過反編繹工具,可以看到程式集的相關信息:

在上面的示例代碼中,我們追加了一行代碼如下:

assemblyBuilder.DefineVersionInfoResource();

它讓生成的程式集在 Window 平臺可以看到相關信息,(不寫入的話,相關內容為空):

6、使用 CodeDom 生成靜態程式集

CodeDom 的使用比較簡單,無需要引用組件,代碼編寫也比較簡潔,唯一的缺點,就是不支持 .NET Core 系列。

使用示例代碼來自Taurus.MVC 微服務RPC代碼生成(CodeDom 版本):

更多源碼:https://github.com/cyq1162/Taurus.MVC/tree/master/src/Taurus.Core/Plugin/MicroService/Client/Proxy/DotNet

 /// <summary>
 /// Rpc 客戶端代理生成類
 /// </summary>
 internal static class RestProxyCreator
 {
     /// <summary>
     /// 構建並保存程式集
     /// </summary>
     /// <param name="assName">程式集名稱</param>
     /// <param name="savePath">保存路徑</param>
     public static bool BuildAssembly(string assName, string savePath)
     {
         if (string.IsNullOrEmpty(assName)) { assName = "RpcProxy"; }
         if (string.IsNullOrEmpty(savePath))
         {
             savePath = AppConst.WebRootPath + assName + ".dll";
         }
         else if (!savePath.StartsWith(AppConst.WebRootPath))
         {
             savePath = AppConst.WebRootPath + savePath;
         }
         string version;
         var code = RestProxyCoder.CreateCode(assName, out version);
         var title = assName + " for Taurus MicroService, build on .net " + Environment.Version.ToString();
         var versionCode = RestProxyCoder.CreateVersionCode(title, title, version);

         CodeDomProvider provider = CodeDomProvider.CreateProvider("C#");
         CompilerParameters cp = new CompilerParameters();
         cp.ReferencedAssemblies.Add("System.dll");
         cp.ReferencedAssemblies.Add("System.Web.dll");
         cp.ReferencedAssemblies.Add("System.Xml.dll");
         cp.ReferencedAssemblies.Add("System.Data.dll");
         cp.ReferencedAssemblies.Add(AppConst.AssemblyPath + "CYQ.Data.dll");
         cp.ReferencedAssemblies.Add(AppConst.AssemblyPath + "Taurus.Core.dll");
         cp.GenerateExecutable = false;
         cp.GenerateInMemory = false;
         cp.OutputAssembly = savePath;
         CompilerResults cr = provider.CompileAssemblyFromSource(cp, versionCode, code);
         if (cr == null || cr.Errors.Count > 0) { return false; }
         return true;

     }
 }

7、 使用 Roslyn 生成靜態程式集

Roslyn 需要引用組件,根據自己要支持的最低版本進行引用(如 4.1.0 就是最低支持.NET Core 2.1的版本):

而且使用麻煩,兩個距坑:

1、Win32 資源信息如何顯示。

2、程式集引用路徑錯誤問題。

為解決這兩個距坑問題,費了不少時間和精力,畢竟網上國內外只有零散的引導信息,還有那不靠譜的 GPT 系列。

使用示例代碼來自 Taurus.MVC 微服務RPC代碼生成(Roslyn 版本):

更多源碼:https://github.com/cyq1162/Taurus.MVC/tree/master/src/Taurus.Core/Plugin/MicroService/Client/Proxy/NetCore

/// <summary>
/// Rpc 客戶端代理生成類
/// </summary>
internal static class RestProxyCreator
{
    /// <summary>
    /// 構建並保存程式集
    /// </summary>
    /// <param name="assName">程式集名稱</param>
    /// <param name="savePath">保存路徑</param>
    public static bool BuildAssembly(string assName, string savePath)
    {
        if (string.IsNullOrEmpty(assName)) { assName = "RpcProxy"; }
        if (string.IsNullOrEmpty(savePath))
        {
            savePath = AppConst.WebRootPath + assName + ".dll";
        }
        else if (!savePath.StartsWith(AppConst.WebRootPath))
        {
            savePath = AppConst.WebRootPath + savePath;
        }
        string version;
        var code = RestProxyCoder.CreateCode(assName, out version);
        var title = assName + " for Taurus MicroService, build on .netcore " + Environment.Version.ToString();
        var versionCode = RestProxyCoder.CreateVersionCode(title, title, version);

        SyntaxTree syntaxVersionTree = CSharpSyntaxTree.ParseText(versionCode);
        SyntaxTree syntaxCodeTree = CSharpSyntaxTree.ParseText(code);


        // 定義編譯選項
        CSharpCompilationOptions compilationOptions = new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)
        .WithOptimizationLevel(OptimizationLevel.Release); // 設置優化級別

        // 創建 Compilation
        CSharpCompilation compilation = CSharpCompilation.Create(assName,
            new[] { syntaxVersionTree, syntaxCodeTree },
            references: AddRef(),
            options: compilationOptions);

        // 編譯並生成程式集
        using (MemoryStream ms = new MemoryStream())
        {
            using (Stream win32resStream = compilation.CreateDefaultWin32Resources(
                                                                        versionResource: true, // 生成版本號。
                                                                        noManifest: false,
                                                                        manifestContents: null,
                                                                        iconInIcoFormat: null))
            {

                EmitResult result = compilation.Emit(ms, win32Resources: win32resStream);

                if (!result.Success)
                {
                    //foreach (var diagnostic in result.Diagnostics)
                    //{
                    //    Console.WriteLine(diagnostic);
                    //}
                    //Console.WriteLine("fail....");
                    return false;
                }
                else
                {
                    // 保存程式集到文件
                    using (FileStream file = new FileStream(savePath, FileMode.Create))
                    {
                        ms.Seek(0, SeekOrigin.Begin);
                        ms.CopyTo(file);
                    }
                    //Console.WriteLine("OK....");
                }
            }
        }

        return true;

    }

    /// <summary>
    /// 添加程式集引用
    /// </summary>
    /// <returns></returns>
    private static PortableExecutableReference[] AddRef()
    {
        List<PortableExecutableReference> exeRefs = new List<PortableExecutableReference>();

        string path = typeof(object).Assembly.Location;

        #region 引用路徑修正
        path = Path.GetDirectoryName(path);
        if (path.Contains("\\shared\\Microsoft.NETCore.App"))
        {
            // windows 平臺,這是nuget 實現程式集路徑
            string refPath = path.Replace("\\shared\\Microsoft.NETCore.App", "\\\\packs\\Microsoft.NETCore.App.Ref") + "\\ref";
            if (Directory.Exists(refPath))
            {
                string[] files = Directory.GetDirectories(refPath);
                if (files.Length > 0) { path = files[0] + "\\"; }
            }
        }
        #endregion
        foreach (string dllFilePath in Directory.GetFiles(path, "*.dll"))
        {
            var dll = Path.GetFileName(dllFilePath);

            if (dll.Split(".").Length > 4) { continue; }
            if (dll.StartsWith("Microsoft.")) { continue; }
            if (dll.StartsWith("System.Drawing.")) { continue; }
            if (dll.StartsWith("System.IO.")) { continue; }
            if (dll.StartsWith("System.Linq.")) { continue; }
            if (dll.StartsWith("System.Net.")) { continue; }
            if (dll.StartsWith("System.Reflection.")) { continue; }
            if (dll.StartsWith("System.Security.")) { continue; }
            if (dll.StartsWith("System.Text.")) { continue; }
            if (dll.StartsWith("System.Threading.")) { continue; }
            if (dll.StartsWith("System.Globalization.")) { continue; }
            if (dll.StartsWith("System.Resources.")) { continue; }
            if (dll.StartsWith("System.Transactions.")) { continue; }
            if (dll.StartsWith("System.Memory.")) { continue; }
            if (dll.StartsWith("System.Formats.")) { continue; }
            if (dll.StartsWith("System.ComponentModel.")) { continue; }
            if (dll.StartsWith("System.Windows.")) { continue; }
            if (dll.StartsWith("System.Diagnostics.")) { continue; }
            if (dll.Contains("VisualBasic")) { continue; }


            exeRefs.Add(MetadataReference.CreateFromFile(dllFilePath));
        }


        //添加引用程式集
        string cyqdata = AppConst.AssemblyPath + "CYQ.Data.dll";
        string taurus = AppConst.AssemblyPath + "Taurus.Core.dll";

        exeRefs.Add(MetadataReference.CreateFromFile(cyqdata));
        exeRefs.Add(MetadataReference.CreateFromFile(taurus));
        return exeRefs.ToArray();
    }
}

8、總結:

在本章節中,我們討論瞭如何使用 C# Emit 來構建動態程式集,以獲得 AssemblyBuilder 這個程式集構建器,開啟構建程式集的第一步。

同時我們也討論瞭如何使用 C# Emit 來構建動態程式集以及程式集的持久化。

同時還分享了自己的乾貨,如何使用 CodeDom 和 Roslyn 來構建靜態程式集。

通過本章節的內容,讀者可以掌握如何利用 C# Emit 技術構建動態程式集和靜態程式集,從而實現靈活、動態的程式設計和開發。

動態程式集的應用能夠提升代碼的模塊化性、版本控制和代碼復用性,為.NET應用程式的開發提供更多可能性。

9、補充: Emit 在 .NET 9 開始重新支持持久化程式集:

示例代碼:

public void CreateAndSaveAssembly(string assemblyPath)
{
    AssemblyBuilder ab = AssemblyBuilder.DefinePersistedAssembly(
        new AssemblyName("MyAssembly"),
        typeof(object).Assembly
        );
    TypeBuilder tb = ab.DefineDynamicModule("MyModule")
        .DefineType("MyType", TypeAttributes.Public | TypeAttributes.Class);

    MethodBuilder mb = tb.DefineMethod(
        "SumMethod",
        MethodAttributes.Public | MethodAttributes.Static,
        typeof(int), [typeof(int), typeof(int)]
        );
    ILGenerator il = mb.GetILGenerator();
    il.Emit(OpCodes.Ldarg_0);
    il.Emit(OpCodes.Ldarg_1);
    il.Emit(OpCodes.Add);
    il.Emit(OpCodes.Ret);

    tb.CreateType();
    ab.Save(assemblyPath); // or could save to a Stream
}

public void UseAssembly(string assemblyPath)
{
    Assembly assembly = Assembly.LoadFrom(assemblyPath);
    Type type = assembly.GetType("MyType");
    MethodInfo method = type.GetMethod("SumMethod");
    Console.WriteLine(method.Invoke(null, [5, 10]));
}

.NET 9 新功能相關鏈接:https://learn.microsoft.com/zh-tw/dotnet/core/whats-new/dotnet-9/overview?source=recommendations

版權聲明:本文原創發表於 博客園,作者為 路過秋天 本文歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連接,否則視為侵權。
個人微信公眾號
創業QQ群:617713515
Donation(掃碼支持作者):支付寶:
Donation(掃碼支持作者):微信:
騰訊雲產品福利專區

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 3月19日,Java22重磅發佈。Java22新增了12項增強功能,其中包括七個預覽特性和一個孵化器特性,這些功能都顯著到足以引起JDK增強提案(JEPs)的關註。它們涵蓋了Java語言、其API、性能以及JDK中包含的工具的改進。 ...
  • 在當今數字化時代,構建高效、可靠的分散式系統是許多企業和開發團隊面臨的挑戰。微軟的 Orleans 框架為解決這些挑戰提供了一個強大而簡單的解決方案。本文將介紹 Orleans 的核心概念,並通過一個簡單的示例代碼來演示其用法。 什麼是 Orleans? Orleans 是由微軟開發的一個開源分散式 ...
  • 嗯,構建模塊,一行代碼的事情,愣是讓我寫成了一篇教程,太難了。在這個入門教程的第三部分中,我們學習瞭如何使用.NET Emit 構建模塊(Module)。通過創建和定義模塊,我們可以更好地組織和管理我們的代碼。在這個過程中,我們瞭解瞭如何使用 AssemblyBuilder 和 ModuleBuil... ...
  • 在 PostgreSQL 中,bytea_output 參數控制在查詢結果中 bytea 類型的顯示格式。預設情況下,bytea_output 的值為 hex,這意味著在查詢結果中,bytea 類型的數據以十六進位格式顯示。但是,如果你的應用程式期望以二進位格式獲取圖像數據,則將 bytea_out... ...
  • 為了優化我們公司網站的性能,我最近引入了瀏覽器預載入技術(Preload)。 這項技術可以顯著減少級聯情況,提高資源載入的並行度,從而加速網站的載入速度。 Preload的原理 Preload的原理是在瀏覽器解析HTML文檔時,提前載入頁面所需的關鍵資源,如樣式表、腳本文件和字體等。 通過預載入這些 ...
  • 前言 文本主要講 MinimalApis 中的使用自定義IResultModel和系統自帶IResult做響應返回值。 MinimalApis支持以下類型的返回值: string - 這包括 Task<string> 和 ValueTask<string> T(任何其他類型)- 這包括 Task<T ...
  • 一:背景 1. 講故事 前幾天有位朋友找到我,說他們的API服務程式跑著跑著CPU滿了降不下去,讓我幫忙看下怎麼回事,現在貌似民間只有我一個人專註dump分析,還是申明一下我dump分析是免費的,如果想學習.NET高級調試的分析技術,可以來我的訓練營看看,話不多說,dump分析走起! 二:WinDb ...
  • 前言 好久不用Arcgis,突然發現想用時,有點不會安裝了,所以這裡記錄一下安裝過程。 下載Arcgis 首先,下載一個arcgis版本,我這裡下的是10.1。 推薦【 gis思維(公眾號)】,【麻辣GIS(網站)】。 當然了,這都是很舊很舊的版本了,基本上沒有三維功能。 一定要下載帶註冊機的。 a ...
一周排行
    -Advertisement-
    Play Games
  • 通過WPF的按鈕、文本輸入框實現了一個簡單的SpinBox數字輸入用戶組件並可以通過數據綁定數值和步長。本文中介紹了通過Xaml代碼實現自定義組件的佈局,依賴屬性的定義和使用等知識點。 ...
  • 以前,我看到一個朋友在對一個系統做初始化的時候,通過一組魔幻般的按鍵,調出來一個隱藏的系統設置界面,這個界面在常規的菜單或者工具欄是看不到的,因為它是一個後臺設置的關鍵界面,不公開,同時避免常規用戶的誤操作,它是作為一個超級管理員的入口功能,這個是很不錯的思路。其實Winform做這樣的處理也是很容... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他的程式每次關閉時就會自動崩潰,一直找不到原因讓我幫忙看一下怎麼回事,這位朋友應該是第二次找我了,分析了下 dump 還是挺經典的,拿出來給大家分享一下吧。 二:WinDbg 分析 1. 為什麼會崩潰 找崩潰原因比較簡單,用 !analyze -v 命 ...
  • 在一些報表模塊中,需要我們根據用戶操作的名稱,來動態根據人員姓名,更新報表的簽名圖片,也就是電子手寫簽名效果,本篇隨筆介紹一下使用FastReport報表動態更新人員簽名圖片。 ...
  • 最新內容優先發佈於個人博客:小虎技術分享站,隨後逐步搬運到博客園。 創作不易,如果覺得有用請在Github上為博主點亮一顆小星星吧! 博主開始學習編程於11年前,年少時還只會使用cin 和cout ,給單片機點點燈。那時候,類似async/await 和future/promise 模型的認知還不是 ...
  • 之前在阿裡雲ECS 99元/年的活動實例上搭建了一個測試用的MINIO服務,以前都是直接當基礎設施來使用的,這次準備自己學一下S3相容API相關的對象存儲開發,因此有了這個小工具。目前僅包含上傳功能,後續計劃開發一個類似圖床的對象存儲應用。 ...
  • 目錄簡介快速入門安裝 NuGet 包實體類User資料庫類DbFactory增刪改查InsertSelectUpdateDelete總結 簡介 NPoco 是 PetaPoco 的一個分支,具有一些額外的功能,截至現在 github 星數 839。NPoco 中文資料沒多少,我是被博客園群友推薦的, ...
  • 前言 前面使用 Admin.Core 的代碼生成器生成了通用代碼生成器的基礎模塊 分組,模板,項目,項目模型,項目欄位的基礎功能,本篇繼續完善,實現最核心的模板生成功能,並提供生成預覽及代碼文件壓縮下載 準備 首先清楚幾個模塊的關係,如何使用,簡單畫一個流程圖 前面完成了基礎的模板組,模板管理,項目 ...
  • 假設需要實現一個圖標和文本結合的按鈕 ,普通做法是 直接重寫該按鈕的模板; 如果想作為通用的呢? 兩種做法: 附加屬性 自定義控制項 推薦使用附加屬性的形式 第一種:附加屬性 創建Button的附加屬性 ButtonExtensions 1 public static class ButtonExte ...
  • 在C#中,委托是一種引用類型的數據類型,允許我們封裝方法的引用。通過使用委托,我們可以將方法作為參數傳遞給其他方法,或者將多個方法組合在一起,從而實現更靈活的編程模式。委托類似於函數指針,但提供了類型安全和垃圾回收等現代語言特性。 基本概念 定義委托 定義委托需要指定它所代表的方法的原型,包括返回類 ...