前言:

在本部分中,我们将深入探讨如何使用C# Emit 来创建动态程序集。

动态程序集是在运行时生成的,为我们提供了一种灵活、动态地构建和加载程序集的能力。

1. 程序集的概念

程序集是.NET中的基本部署单位,它包含了可执行代码、资源、元数据等信息,是.NET应用程序的基本组成单元之一。

与静态程序集(即程序集持久化)不同,动态程序集是在运行时生成的,使得我们可以根据需要动态地构建和加载程序集。

动态程序集的重要性体现在多个方面,包括但不限于模块化、版本控制、代码复用等。

通过动态程序集,我们可以更好地管理和组织代码,实现更灵活的程序设计和开发。

2、Emit 构建程序集支持情况:

  1. .Net 系列:动态程序集:支持;程序集持久化:支持
  2.  
  3. .Net Core 系列:动态程序集:支持;程序集持久化:不支持
 

3、Emit 创建动态程序集:

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

在这过程,我们可以使用  AssemblyName 来定义程序集的名称和版本等信息。

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

创建程序集对象,在 .Net 和 .Net Core 中有所不同:

.NET 代码:通过 AppDomain.DefineDynamicAssembly 来创建动态程序集对象:

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

AssemblyBuilderAccess 在 .Net 系列中的属性:

  1. AssemblyBuilderAccess.Run; 表示程序集可被执行,但不能被保存。  
  2. AssemblyBuilderAccess.Save; 表示程序集可被保存,但不能被执行。  
  3. AssemblyBuilderAccess.RunAndSave; 表示程序集可被保存并能被执行。
  4. AssemblyBuilderAccess.ReflectionOnly; 表示程序集只能用于反射上下文环境中,不能被执行。 
  5. AssemblyBuilderAccess.RunAndCollect; 表示程序集可以被卸载并且内存会被回收

.NET Core 代码:通过 AssemblyBuilder.DefineDynamicAssembly 来创建动态程序集对象:

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

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

  1. AssemblyBuilderAccess.Run; 表示程序集可被执行,但不能被保存。  
  2. AssemblyBuilderAccess.Collect; 表示程序集可以被卸载并且内存会被回收
 

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

4:总结一:

在本章节中,我们讨论了如何使用 C# Emit 来构建动态程序集,以获得 AssemblyBuilder 这个程序集构建器,开启构建程序集的第一步。

在之后的文章,我们会讲解如何用它的 DefineDynamicModule 来定义模块,以之后构建类、成员、方法等,来实现构建完整的程序集。

当然,对于构建动态程序集,本文章到此会显的有点简单,为了避免被大伙说文章太水。

于是,打算追加一下对于构建静态程序集(即持久化程序集)的相关知识。

构建静态程序集的三种方式:

  1. .Net 系列:使用 Emit CodeDomSystem.CodeDom.Compiler 系统集成)
  2.  
  3. .Net Core 系列:RoslynMicrosoft.CodeAnalysis.CSharp 需要引用组件包)

5、Emit 构建静态程序集:

在上述代码中,我们通过 AssemblyName 来指定程序集名称和版本号。

如果我们希望持久化程序集,并将程序集分发给其它人调用,则需要补充更多的相关信息:

  1. 比如:Taurus.MVC 微服务组件中就实现了动态生成 Rpc 调用程序集,以供其它微服务节点调用。

在定义完程序集名称和版本后(AssemblyBuilderAccess 需要指定为 RunAndSave )。

我们可以通过 AssemblyBuilder  的 SetCustomAttribute 方法,来添加自定义属性,最后通过 Save 方法,来持久化程序集:

  1. internal class Program
  2. {
  3. static void Main(string[] args)
  4. {
  5. string dllName = "MyDynamic";
  6. string title = "This is a dynamic title.";
  7.  
  8. AssemblyName assemblyName = new AssemblyName(dllName) { Version = new Version("3.0.0.0") };
  9. AssemblyBuilder assemblyBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndSave);
  10.  
  11. // 添加自定义属性到程序集var titleAttr = new CustomAttributeBuilder(
  12. typeof(AssemblyTitleAttribute).GetConstructor(new Type[] { typeof(string) }),
  13. new object[] { title }
  14. );
  15. assemblyBuilder.SetCustomAttribute(titleAttr);
  16.  
  17. assemblyBuilder.DefineVersionInfoResource();
  18.  
  19. assemblyBuilder.Save(dllName + ".dll");
  20.  
  21. Console.WriteLine("程序集已生成");
  22. }
  23. }

自定义支持哪些属性,可以参考工程目录下的:AssemblyInfo.cs 信息:

没有指定完整的保存路径时,程序运行之后默认在运行目录下可以看到生成的程序集:

通过反编绎工具,可以看到程序集的相关信息:

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

  1. 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

  1. /// <summary>
  2. /// Rpc 客户端代理生成类
  3. /// </summary>
  4. internal static class RestProxyCreator
  5. {
  6. /// <summary>
  7. /// 构建并保存程序集
  8. /// </summary>
  9. /// <param name="assName">程序集名称</param>
  10. /// <param name="savePath">保存路径</param>
  11. public static bool BuildAssembly(string assName, string savePath)
  12. {
  13. if (string.IsNullOrEmpty(assName)) { assName = "RpcProxy"; }
  14. if (string.IsNullOrEmpty(savePath))
  15. {
  16. savePath = AppConst.WebRootPath + assName + ".dll";
  17. }
  18. else if (!savePath.StartsWith(AppConst.WebRootPath))
  19. {
  20. savePath = AppConst.WebRootPath + savePath;
  21. }
  22. string version;
  23. var code = RestProxyCoder.CreateCode(assName, out version);
  24. var title = assName + " for Taurus MicroService, build on .net " + Environment.Version.ToString();
  25. var versionCode = RestProxyCoder.CreateVersionCode(title, title, version);
  26.  
  27. CodeDomProvider provider = CodeDomProvider.CreateProvider("C#");
  28. CompilerParameters cp = new CompilerParameters();
  29. cp.ReferencedAssemblies.Add("System.dll");
  30. cp.ReferencedAssemblies.Add("System.Web.dll");
  31. cp.ReferencedAssemblies.Add("System.Xml.dll");
  32. cp.ReferencedAssemblies.Add("System.Data.dll");
  33. cp.ReferencedAssemblies.Add(AppConst.AssemblyPath + "CYQ.Data.dll");
  34. cp.ReferencedAssemblies.Add(AppConst.AssemblyPath + "Taurus.Core.dll");
  35. cp.GenerateExecutable = false;
  36. cp.GenerateInMemory = false;
  37. cp.OutputAssembly = savePath;
  38. CompilerResults cr = provider.CompileAssemblyFromSource(cp, versionCode, code);
  39. if (cr == null || cr.Errors.Count > 0) { return false; }
  40. return true;
  41.  
  42. }
  43. }

7、 使用 Roslyn 生成静态程序集

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

而且使用麻烦,两个距坑:

  1. 1Win32 资源信息如何显示。
  2.  
  3. 2、程序集引用路径错误问题。

为解决这两个距坑问题,费了不少时间和精力,毕竟网上国内外只有零散的引导信息,还有那不靠谱的 GPT 系列。

使用示例代码来自 Taurus.MVC 微服务RPC代码生成(Roslyn 版本):

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

  1. /// <summary>
  2. /// Rpc 客户端代理生成类
  3. /// </summary>
  4. internal static class RestProxyCreator
  5. {
  6. /// <summary>
  7. /// 构建并保存程序集
  8. /// </summary>
  9. /// <param name="assName">程序集名称</param>
  10. /// <param name="savePath">保存路径</param>
  11. public static bool BuildAssembly(string assName, string savePath)
  12. {
  13. if (string.IsNullOrEmpty(assName)) { assName = "RpcProxy"; }
  14. if (string.IsNullOrEmpty(savePath))
  15. {
  16. savePath = AppConst.WebRootPath + assName + ".dll";
  17. }
  18. else if (!savePath.StartsWith(AppConst.WebRootPath))
  19. {
  20. savePath = AppConst.WebRootPath + savePath;
  21. }
  22. string version;
  23. var code = RestProxyCoder.CreateCode(assName, out version);
  24. var title = assName + " for Taurus MicroService, build on .netcore " + Environment.Version.ToString();
  25. var versionCode = RestProxyCoder.CreateVersionCode(title, title, version);
  26.  
  27. SyntaxTree syntaxVersionTree = CSharpSyntaxTree.ParseText(versionCode);
  28. SyntaxTree syntaxCodeTree = CSharpSyntaxTree.ParseText(code);
  29.  
  30. // 定义编译选项
  31. CSharpCompilationOptions compilationOptions = new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)
  32. .WithOptimizationLevel(OptimizationLevel.Release); // 设置优化级别
  33.  
  34. // 创建 Compilation
  35. CSharpCompilation compilation = CSharpCompilation.Create(assName,
  36. new[] { syntaxVersionTree, syntaxCodeTree },
  37. references: AddRef(),
  38. options: compilationOptions);
  39.  
  40. // 编译并生成程序集
  41. using (MemoryStream ms = new MemoryStream())
  42. {
  43. using (Stream win32resStream = compilation.CreateDefaultWin32Resources(
  44. versionResource: true, // 生成版本号。
  45. noManifest: false,
  46. manifestContents: null,
  47. iconInIcoFormat: null))
  48. {
  49.  
  50. EmitResult result = compilation.Emit(ms, win32Resources: win32resStream);
  51.  
  52. if (!result.Success)
  53. {
  54. //foreach (var diagnostic in result.Diagnostics)
  55. //{
  56. // Console.WriteLine(diagnostic);
  57. //}
  58. //Console.WriteLine("fail....");
  59. return false;
  60. }
  61. else
  62. {
  63. // 保存程序集到文件
  64. using (FileStream file = new FileStream(savePath, FileMode.Create))
  65. {
  66. ms.Seek(0, SeekOrigin.Begin);
  67. ms.CopyTo(file);
  68. }
  69. //Console.WriteLine("OK....");
  70. }
  71. }
  72. }
  73.  
  74. return true;
  75.  
  76. }
  77.  
  78. /// <summary>
  79. /// 添加程序集引用
  80. /// </summary>
  81. /// <returns></returns>
  82. private static PortableExecutableReference[] AddRef()
  83. {
  84. List<PortableExecutableReference> exeRefs = new List<PortableExecutableReference>();
  85.  
  86. string path = typeof(object).Assembly.Location;
  87.  
  88. #region 引用路径修正
  89. path = Path.GetDirectoryName(path);
  90. if (path.Contains("\\shared\\Microsoft.NETCore.App"))
  91. {
  92. // windows 平台,这是nuget 实现程序集路径
  93. string refPath = path.Replace("\\shared\\Microsoft.NETCore.App", "\\\\packs\\Microsoft.NETCore.App.Ref") + "\\ref";
  94. if (Directory.Exists(refPath))
  95. {
  96. string[] files = Directory.GetDirectories(refPath);
  97. if (files.Length > 0) { path = files[0] + "\\"; }
  98. }
  99. }
  100. #endregion
  101. foreach (string dllFilePath in Directory.GetFiles(path, "*.dll"))
  102. {
  103. var dll = Path.GetFileName(dllFilePath);
  104.  
  105. if (dll.Split(".").Length > 4) { continue; }
  106. if (dll.StartsWith("Microsoft.")) { continue; }
  107. if (dll.StartsWith("System.Drawing.")) { continue; }
  108. if (dll.StartsWith("System.IO.")) { continue; }
  109. if (dll.StartsWith("System.Linq.")) { continue; }
  110. if (dll.StartsWith("System.Net.")) { continue; }
  111. if (dll.StartsWith("System.Reflection.")) { continue; }
  112. if (dll.StartsWith("System.Security.")) { continue; }
  113. if (dll.StartsWith("System.Text.")) { continue; }
  114. if (dll.StartsWith("System.Threading.")) { continue; }
  115. if (dll.StartsWith("System.Globalization.")) { continue; }
  116. if (dll.StartsWith("System.Resources.")) { continue; }
  117. if (dll.StartsWith("System.Transactions.")) { continue; }
  118. if (dll.StartsWith("System.Memory.")) { continue; }
  119. if (dll.StartsWith("System.Formats.")) { continue; }
  120. if (dll.StartsWith("System.ComponentModel.")) { continue; }
  121. if (dll.StartsWith("System.Windows.")) { continue; }
  122. if (dll.StartsWith("System.Diagnostics.")) { continue; }
  123. if (dll.Contains("VisualBasic")) { continue; }
  124.  
  125. exeRefs.Add(MetadataReference.CreateFromFile(dllFilePath));
  126. }
  127.  
  128. //添加引用程序集
  129. string cyqdata = AppConst.AssemblyPath + "CYQ.Data.dll";
  130. string taurus = AppConst.AssemblyPath + "Taurus.Core.dll";
  131.  
  132. exeRefs.Add(MetadataReference.CreateFromFile(cyqdata));
  133. exeRefs.Add(MetadataReference.CreateFromFile(taurus));
  134. return exeRefs.ToArray();
  135. }
  136. }

8、总结:

在本章节中,我们讨论了如何使用 C# Emit 来构建动态程序集,以获得 AssemblyBuilder 这个程序集构建器,开启构建程序集的第一步。

同时我们也讨论了如何使用 C# Emit 来构建动态程序集以及程序集的持久化。

同时还分享了自己的干货,如何使用 CodeDom 和 Roslyn 来构建静态程序集。

通过本章节的内容,读者可以掌握如何利用 C# Emit 技术构建动态程序集和静态程序集,从而实现灵活、动态的程序设计和开发。

动态程序集的应用能够提升代码的模块化性、版本控制和代码复用性,为.NET应用程序的开发提供更多可能性。

.NET Emit 入门教程:第二部分:构建动态程序集(追加构建静态程序集教程)的更多相关文章

  1. esri-leaflet入门教程(5)- 动态要素加载

    esri-leaflet入门教程(5)- 动态要素加载 by 李远祥 在上一章节中已经说明了esr-leaflet是如何加载ArcGIS Server提供的各种服务,这些都是服务本身来决定的,API脚 ...

  2. [ABP教程]第二章 图书列表页面

    Web应用程序开发教程 - 第二章: 图书列表页面 关于本教程 在本系列教程中, 你将构建一个名为 Acme.BookStore 的用于管理书籍及其作者列表的基于ABP的应用程序. 它是使用以下技术开 ...

  3. 使用Expression Tree构建动态LINQ查询

    这篇文章介绍一个有意思的话题,也是经常被人问到的:如何构建动态LINQ查询?所谓动态,主要的意思在于查询的条件可以随机组合,动态添加,而不是固定的写法.这个在很多系统开发过程中是非常有用的. 我这里给 ...

  4. 动态共享库(so)开发精悍教程

    动态共享库(so)开发精悍教程 翻译并根据实际情况进行了小小修改,仅关注Linux下动态共享库(Dynamic shared library .so)的开发. 1 简单的so实例 源文件 //test ...

  5. Android Studio 入门级教程(三):gradle项目构建

    声明 生命壹号:http://www.cnblogs.com/smyhvae/ 文章来源:http://www.cnblogs.com/smyhvae/p/4456420.html [系列] Andr ...

  6. 使用 FirewallD 构建动态防火墙

    使用 FirewallD 构建动态防火墙 FirewallD 提供了支持网络/防火墙区域(zone)定义网络链接以及接口安全等级的动态防火墙管理工具.它支持 IPv4, IPv6 防火墙设置以及以太网 ...

  7. axure rp教程(四)动态面板滑动效果

    转载自: http://www.iaxure.com/74.html 实现目标: 1.  点击登录滑出登录面板 2.  点击确定滑出动态面板 最终效果如下: 这种效果可以通过两种方法实现: 首先准备需 ...

  8. javascript进阶教程第二章对象案例实战

    javascript进阶教程第二章对象案例实战 一.学习任务 通过几个案例练习回顾学过的知识 通过案例练习补充几个之前没有见到或者虽然讲过单是讲的不仔细的知识点. 二.具体实例 温馨提示 面向对象的知 ...

  9. EnjoyingSoft之Mule ESB开发教程第二篇:Mule ESB基本概念

    目录 1. 使用Anypoint Studio开发 2. Mule ESB Application Structure - Mule ESB应用程序结构 3. Mule ESB Application ...

  10. ASP动态网页(网站)设计教程

    ASP动态网页(网站)设计教程 文件名 大小 ASP获取时间函数大全 35KB 项目6 ASP数据表数据操作功能设计.pptx 3.34 MB 项目5 WEB数据库与数据库管理.pptx 3.34 M ...

随机推荐

  1. 【简写MyBatis】01-简单映射器

    前言 新开一个坑,为了学习一下MyBatis的源码,写代码是次要的,主要为了吸收一下其中的思想和手法. 目的 关联对象接口和映射类的问题,把 DAO 接口使用代理类,包装映射操作. 知识点 动态代理 ...

  2. JS leetcode 搜索插入位置 题解分析

    壹 ❀ 引 今天来做一道特别特别简单的题,来自leetcode35. 搜索插入位置,题目描述如下: 给定一个排序数组和一个目标值,在数组中找到目标值,并返回其索引.如果目标值不存在于数组中,返回它将会 ...

  3. Nand flash基本原理

    Nand flash基本原理       Flash全名叫做Flash Memory,属于非易失性存储设备(Non-volatile Memory Device),与此相对应的是易失性存储设备(Vol ...

  4. Centos中安装deb报错

    centos7中安装deb包   概要:deb包和rpm包区别:deb后缀的软件包是for Debian系的(包括Ubuntu),不是给centos安装的:rpm后缀的软件包才是for Redhat系 ...

  5. Python递归遍历目录并删除文件中的前N行

    1 import os 2 3 # 遍历目录下的所有文件 4 def check_file(file_path): 5 os.chdir(file_path) 6 print(os.path.absp ...

  6. Java图片加水印

    采用Java自带的Image IO 废话不多说,上菜 1.  文字水印 1 import sun.font.FontDesignMetrics; 2 3 import javax.imageio.Im ...

  7. openai chatGPT 原理通俗介绍

    引言 近年来,随着深度学习技术的不断发展,自然语言处理(NLP)领域取得了长足的进步.ChatGPT(Generative Pre-trained Transformer)作为一种先进的语言生成模型, ...

  8. Ubuntu/Centos下OpenJ9 POI输出Excel的Bug

    项目更换 JDK为 OpenJ9 后, 使用 POI 导出 Excel 遇到的问题 OpenJ9 版本信息 /opt/jdk/jdk-11.0.17+8/bin/java -version openj ...

  9. 【Unity3D】半球卷屏特效

    1 原理 ​ 凸镜贴图 和 渐变凸镜贴图 中介绍了使用 OpenGL 实现凸镜贴图及其原理,通过顶点坐标映射到纹理坐标,并构造三角形网格,构建了真正的三维凸镜模型.本文通过 Shader 实现半球卷屏 ...

  10. 【Unity3D】基于深度和法线纹理的边缘检测方法

    1 前言 ​ 边缘检测特效中使用屏后处理技术,通过卷积运算计算梯度,检测每个像素周围像素的亮度差异,以识别是否是边缘像素:选中物体描边特效中也使用了屏后处理技术,通过 CommandBuffer 获取 ...