Fireasy3 揭秘 -- 代码编译器及适配器

目录

• Fireasy3 揭秘 -- 依赖注入与服务发现
  
• Fireasy3 揭秘 -- 自动服务部署
  
• Fireasy3 揭秘 -- 使用 SourceGeneraor 改进服务发现
  
• Fireasy3 揭秘 -- 使用 SourceGeneraor 实现动态代理(AOP)
  
• Fireasy3 揭秘 -- 使用 Emit 构建程序集
  
• Fireasy3 揭秘 -- 代码编译器及适配器
  
• Fireasy3 揭秘 -- 使用缓存提高反射性能
  
• Fireasy3 揭秘 -- 动态类型及扩展支持
  
• Fireasy3 揭秘 -- 线程数据共享的实现
  
• Fireasy3 揭秘 -- 配置管理及解析处理
  
• Fireasy3 揭秘 -- 数据库适配器
  
• Fireasy3 揭秘 -- 解决数据库之间的语法差异
  
• Fireasy3 揭秘 -- 获取数据库的架构信息
  
• Fireasy3 揭秘 -- 数据批量插入的实现
  
• Fireasy3 揭秘 -- 使用包装器对数据读取进行兼容
  
• Fireasy3 揭秘 -- 数据行映射器
  
• Fireasy3 揭秘 -- 数据转换器的实现
  
• Fireasy3 揭秘 -- 通用序列生成器和雪花生成器的实现
  
• Fireasy3 揭秘 -- 命令拦截器的实现
  
• Fireasy3 揭秘 -- 数据库主从同步的实现
  
• Fireasy3 揭秘 -- 大数据分页的策略
  
• Fireasy3 揭秘 -- 数据按需更新及生成实体代理类
  
• Fireasy3 揭秘 -- 用对象池技术管理上下文
  
• Fireasy3 揭秘 -- Lambda 表达式解析的原理
  
• Fireasy3 揭秘 -- 扩展选择的实现
  
• Fireasy3 揭秘 -- 按需加载与惰性加载的区别与实现
  
• Fireasy3 揭秘 -- 自定义函数的解析与绑定
  
• Fireasy3 揭秘 -- 与 MongoDB 进行适配
  
• Fireasy3 揭秘 -- 模块化的实现原理
  

　　代码编译器是将一段源代码（C#或VisualBasic）编译成程序集，它的工作方式与 Emit 不一样。从 .net standard 开始，代码编译器就采用了 Roslyn 来编译源代码，前几篇文章里提到的 SourceGenerator 也正是基于此。
　　代码编译器使用的场景也很多，比如公式解析器，还有 CodeBuilder 里的架构扩展和属性扩展等等。
　　定义一个通用的编译器接口，实现不同语言的代码编译。如下：

1.     /// <summary>
2.     /// 代码编译器接口。
3.     /// </summary>
4.     public interface ICodeCompiler
5.     {
6.         /// <summary>
7.         /// 编译代码生成一个程序集。
8.         /// </summary>
9.         /// <param name="source">程序源代码。</param>
10.         /// <param name="options">配置选项。</param>
11.         /// <returns>由代码编译成的程序集。</returns>
12.         Assembly? CompileAssembly(string source, ConfigureOptions? options = null);
13.     }

复制代码

　　ConfigureOptions 主要提供了编译的相关配置，比如输出的程序集路径，引用的程序集等等。如下：

1.     /// <summary>
2.     /// 配置参数。
3.     /// </summary>
4.     public class ConfigureOptions
5.     {
6.         /// <summary>
7.         /// 获取或设置输出的程序集。
8.         /// </summary>
9.         public string? OutputAssembly { get; set; }
11.         /// <summary>
12.         /// 获取或设置编译选项。
13.         /// </summary>
14.         public string? CompilerOptions { get; set; }
16.         /// <summary>
17.         /// 获取附加的程序集。
18.         /// </summary>
19.         public List<string> Assemblies { get; private set; } = new List<string>();
20.     }

复制代码

　　Roslyn 提供了不同的语法树解析适配器，C# 和 VB.Net 分别对应 CSharpSyntaxTree 及 VisualBasicSyntaxTree。下面使用 CSharpSyntaxTree 来实现 C# 代码的编译。

1.     /// <summary>
2.     /// CSharp 代码编译器。无法继承此类。
3.     /// </summary>
4.     public sealed class CSharpCodeCompiler : ICodeCompiler
5.     {
6.         /// <summary>
7.         /// 编译代码生成一个程序集。
8.         /// </summary>
9.         /// <param name="source">程序源代码。</param>
10.         /// <param name="options">配置选项。</param>
11.         /// <returns>由代码编译成的程序集。</returns>
12.         public Assembly? CompileAssembly(string source, ConfigureOptions? options = null)
13.         {
14.             options ??= new ConfigureOptions();
15.             var compilation = CSharpCompilation.Create(Guid.NewGuid().ToString())
16.                 .AddSyntaxTrees(CSharpSyntaxTree.ParseText(source))
17.                 .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location))
18.                 .AddReferences(options.Assemblies.Select(s => MetadataReference.CreateFromFile(s)))
19.                 .WithOptions(new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary, optimizationLevel: OptimizationLevel.Release));
21.             if (!string.IsNullOrEmpty(options.OutputAssembly))
22.             {
23.                 var result = compilation.Emit(options.OutputAssembly);
24.                 if (result.Success)
25.                 {
26.                     return Assembly.Load(options.OutputAssembly);
27.                 }
28.                 else
29.                 {
30.                     ThrowCompileException(result);
31.                     return null;
32.                 }
33.             }
34.             else
35.             {
36.                 using var ms = new MemoryStream();
37.                 var result = compilation.Emit(ms);
38.                 if (result.Success)
39.                 {
40.                     return Assembly.Load(ms.ToArray());
41.                 }
42.                 else
43.                 {
44.                     ThrowCompileException(result);
45.                     return null;
46.                 }
47.             }
48.         }
50.         private void ThrowCompileException(EmitResult result)
51.         {
52.             var errorBuilder = new StringBuilder();
54.             foreach (var diagnostic in result.Diagnostics.Where(diagnostic =>
55.                         diagnostic.IsWarningAsError ||
56.                         diagnostic.Severity == DiagnosticSeverity.Error))
57.             {
58.                 errorBuilder.AppendFormat("{0}: {1}", diagnostic.Id, diagnostic.GetMessage());
59.             }
61.             throw new CodeCompileException(errorBuilder.ToString());
62.         }
63.     }

复制代码

　　有了 C# 编译器的实现，但是又不想在公共库（Fireasy.Common）中实现 VB.Net，毕竟目前来说主流语言还是 C#，使用 VB.NET 的场景不是太多。但是你又得考虑这些语言，那该怎么办呢？
　　一个很明智的做法就是使用管理器，如下，定义一个 ICodeCompilerManager 接口：

1.     /// <summary>
2.     /// 提供代码编译器管理的接口。
3.     /// </summary>
4.     public interface ICodeCompilerManager
5.     {
6.         /// <summary>
7.         /// 注册指定语言类型的代码编译器类型。
8.         /// </summary>
9.         /// <typeparam name="TCompiler"></typeparam>
10.         /// <param name="languages">语言。</param>
11.         void Register<TCompiler>(params string[] languages) where TCompiler : ICodeCompiler;
13.         /// <summary>
14.         /// 创建代码编译器。
15.         /// </summary>
16.         /// <param name="language">语言。</param>
17.         /// <returns></returns>
18.         ICodeCompiler? CreateCompiler(string language);
19.     }

复制代码

　　管理器提供了注册和创建实例的方法，其实原理很简单，使用一个字典来管理语言和编译器类型即可，如下：

1.     /// <summary>
2.     /// 缺省的代码编译器管理器。
3.     /// </summary>
4.     public class DefaultCodeCompilerManager : ICodeCompilerManager
5.     {
6.         private readonly Dictionary<string, Type> _languageMappers = new(new StringIgnoreCaseComparer());
8.         private class StringIgnoreCaseComparer : IEqualityComparer<string>
9.         {
10.             public bool Equals(string x, string y)
11.             {
12.                 return string.Compare(x, y, true) == 0;
13.             }
15.             public int GetHashCode(string obj)
16.             {
17.                 return obj?.GetHashCode() ?? 0;
18.             }
19.         }
21.         /// <summary>
22.         /// 初始化 <see cref="DefaultCodeCompilerManager"/> 类新实例。
23.         /// </summary>
24.         public DefaultCodeCompilerManager()
25.         {
26.             Register<CSharpCodeCompiler>("csharp", "c#");
27.         }
29.         /// <summary>
30.         /// 注册指定语言类型的代码编译器类型。
31.         /// </summary>
32.         /// <typeparam name="TCompiler"></typeparam>
33.         /// <param name="languages">语言。</param>
34.         public void Register<TCompiler>(params string[] languages) where TCompiler : ICodeCompiler
35.         {
36.             foreach (var language in languages)
37.             {
38.                 _languageMappers.AddOrReplace(language, typeof(TCompiler));
39.             }
40.         }
42.         /// <summary>
43.         /// 创建代码编译器。
44.         /// </summary>
45.         /// <param name="language">语言。</param>
46.         /// <returns></returns>
47.         public ICodeCompiler? CreateCompiler(string language)
48.         {
49.             if (_languageMappers.TryGetValue(language, out var compilerType))
50.             {
51.                 return Activator.CreateInstance(compilerType) as ICodeCompiler;
52.             }
54.             return null;
55.         }
56.     }

复制代码

　　然后将其在 AddFireasy 调用时，注册到 IServiceCollection 里。如下：

1.         /// <summary>
2.         /// 添加框架的基本支持。
3.         /// </summary>
4.         /// <param name="services"><see cref="IServiceCollection"/> 实例。</param>
5.         /// <param name="configure">配置方法。</param>
6.         /// <returns></returns>
7.         public static SetupBuilder AddFireasy(this IServiceCollection services, Action<SetupOptions>? configure = null)
8.         {
9.             services.AddSingleton<ICodeCompilerManager>(new DefaultCodeCompilerManager());
11.             var options = new SetupOptions();
12.             //省略后面的代码
14.             return builder;
15.         }

复制代码

　　这样，要任何时候都可以使用注入的方式，获取到代码编译器了。那么，VB.NET 代码编译的实现，可以单独创建一个项目（称之为实现库），来实现代码编译器的接口，注意需要从 Nuget 里安装 Microsoft.CodeAnalysis.VisualBasic。如下：

1.     /// <summary>
2.     /// VisualBasic 代码编译器。无法继承此类。
3.     /// </summary>
4.     public class VisualBasicCodeCompiler : ICodeCompiler
5.     {
6.         /// <summary>
7.         /// 编译代码生成一个程序集。
8.         /// </summary>
9.         /// <param name="source">程序源代码。</param>
10.         /// <param name="options">配置选项。</param>
11.         /// <returns>由代码编译成的程序集。</returns>
12.         public Assembly? CompileAssembly(string source, ConfigureOptions? options = null)
13.         {
14.             options ??= new ConfigureOptions();
15.             var compilation = VisualBasicCompilation.Create(Guid.NewGuid().ToString())
16.                 .AddSyntaxTrees(VisualBasicSyntaxTree.ParseText(source))
17.                 .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location))
18.                 .AddReferences(options.Assemblies.Select(s => MetadataReference.CreateFromFile(s)))
19.                 .WithOptions(new VisualBasicCompilationOptions(OutputKind.DynamicallyLinkedLibrary, optimizationLevel: OptimizationLevel.Release));
21.             if (!string.IsNullOrEmpty(options.OutputAssembly))
22.             {
23.                 var result = compilation.Emit(options.OutputAssembly);
24.                 if (result.Success)
25.                 {
26.                     return Assembly.Load(options.OutputAssembly);
27.                 }
28.                 else
29.                 {
30.                     ThrowCompileException(result);
31.                     return null;
32.                 }
33.             }
34.             else
35.             {
36.                 using var ms = new MemoryStream();
37.                 var result = compilation.Emit(ms);
38.                 if (result.Success)
39.                 {
40.                     return Assembly.Load(ms.ToArray());
41.                 }
42.                 else
43.                 {
44.                     ThrowCompileException(result);
45.                     return null;
46.                 }
47.             }
48.         }
50.         private void ThrowCompileException(EmitResult result)
51.         {
52.             var errorBuilder = new StringBuilder();
54.             foreach (var diagnostic in result.Diagnostics.Where(diagnostic =>
55.                         diagnostic.IsWarningAsError ||
56.                         diagnostic.Severity == DiagnosticSeverity.Error))
57.             {
58.                 errorBuilder.AppendFormat("{0}: {1}", diagnostic.Id, diagnostic.GetMessage());
59.             }
61.             throw new CodeCompileException(errorBuilder.ToString());
62.         }
63.     }

复制代码

　　再添加一个 服务部署器，将 VB.NET 语言的编译器注册到 ICodeCompilerManager 的单例里去，如下：

1. [assembly: ServicesDeploy(typeof(VisualBasicServicesDeployer))]
3. namespace Fireasy.Data.DependencyInjection
4. {
5.     /// <summary>
6.     /// 服务部署。
7.     /// </summary>
8.     public class VisualBasicServicesDeployer : IServicesDeployer
9.     {
10.         void IServicesDeployer.Configure(IServiceCollection services)
11.         {
12.             var manager = services.GetSingletonInstance<ICodeCompilerManager>();
13.             manager!.Register<VisualBasicCodeCompiler>("vb");
14.         }
15.     }
16. }

复制代码

　　这样，项目里如果需要使用 VB.NET 语言编译器，只需要引用该实现库，而不会侵入和破坏公共库，再如有其他的语言，都可以使用此种方法进行扩展。
　　代码编译器的使用就变得很简单了，如下：

1.         /// <summary>
2.         /// 使用c#源代码
3.         /// </summary>
4.         [TestMethod]
5.         public void TestCompileAssembly()
6.         {
7.             var source = @"
8. public class A
9. {
10.     public string Hello(string str)
11.     {
12.         return str;
13.     }
14. }";
15.             var codeCompilerManager = ServiceProvider.GetService<ICodeCompilerManager>();
16.             var codeCompiler = codeCompilerManager!.CreateCompiler("csharp");
18.             var assembly = codeCompiler!.CompileAssembly(source);
20.             var type = assembly!.GetType("A");
22.             Assert.IsNotNull(type);
23.         }
25.         /// <summary>
26.         /// 使用vb源代码
27.         /// </summary>
28.         [TestMethod]
29.         public void TestCompileAssemblyUseVb()
30.         {
31.             var source = @"
32. Public Class A
33.     Public Function Hello(ByVal str As String) As String
34.         Return str
35.     End Function
36. End Class";
37.             var codeCompilerManager = ServiceProvider.GetService<ICodeCompilerManager>();
38.             var codeCompiler = codeCompilerManager!.CreateCompiler("vb");
40.             var assembly = codeCompiler!.CompileAssembly(source);
42.             var type = assembly!.GetType("A");
44.             Assert.IsNotNull(type);
45.         }

复制代码

　　ICodeCompiler 还有几个扩展方法，可以获取对应的类型、方法及委托，只不过是通过反射对程序集的操作罢了。
　　最后，奉上 Fireasy 3 的开源地址：https://gitee.com/faib920/fireasy3 ，欢迎大家前来捧场。
　　本文相关代码请参考：
　　https://gitee.com/faib920/fireasy3/src/libraries/Fireasy.Common/Compiler
　　https://gitee.com/faib920/fireasy3/src/libraries/Fireasy.CodeCompiler.VisualBasic
　　https://gitee.com/faib920/fireasy3/tests/Fireasy.Common.Tests/CodeCompilerTests.cs
　　更多内容请移步官网 http://www.fireasy.cn 。
扫码加入QQ群：
扫码加入微信群(3月20日前有效)：

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！