草庐IT

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

Fireasy.Net 2023-03-28 原文

目录

  • 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 里的架构扩展和属性扩展等等。
  定义一个通用的编译器接口,实现不同语言的代码编译。如下:

    /// <summary>
    /// 代码编译器接口。
    /// </summary>
    public interface ICodeCompiler
    {
        /// <summary>
        /// 编译代码生成一个程序集。
        /// </summary>
        /// <param name="source">程序源代码。</param>
        /// <param name="options">配置选项。</param>
        /// <returns>由代码编译成的程序集。</returns>
        Assembly? CompileAssembly(string source, ConfigureOptions? options = null);
    }

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

    /// <summary>
    /// 配置参数。
    /// </summary>
    public class ConfigureOptions
    {
        /// <summary>
        /// 获取或设置输出的程序集。
        /// </summary>
        public string? OutputAssembly { get; set; }

        /// <summary>
        /// 获取或设置编译选项。
        /// </summary>
        public string? CompilerOptions { get; set; }

        /// <summary>
        /// 获取附加的程序集。
        /// </summary>
        public List<string> Assemblies { get; private set; } = new List<string>();
    }

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

    /// <summary>
    /// CSharp 代码编译器。无法继承此类。
    /// </summary>
    public sealed class CSharpCodeCompiler : ICodeCompiler
    {
        /// <summary>
        /// 编译代码生成一个程序集。
        /// </summary>
        /// <param name="source">程序源代码。</param>
        /// <param name="options">配置选项。</param>
        /// <returns>由代码编译成的程序集。</returns>
        public Assembly? CompileAssembly(string source, ConfigureOptions? options = null)
        {
            options ??= new ConfigureOptions();
            var compilation = CSharpCompilation.Create(Guid.NewGuid().ToString())
                .AddSyntaxTrees(CSharpSyntaxTree.ParseText(source))
                .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location))
                .AddReferences(options.Assemblies.Select(s => MetadataReference.CreateFromFile(s)))
                .WithOptions(new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary, optimizationLevel: OptimizationLevel.Release));

            if (!string.IsNullOrEmpty(options.OutputAssembly))
            {
                var result = compilation.Emit(options.OutputAssembly);
                if (result.Success)
                {
                    return Assembly.Load(options.OutputAssembly);
                }
                else
                {
                    ThrowCompileException(result);
                    return null;
                }
            }
            else
            {
                using var ms = new MemoryStream();
                var result = compilation.Emit(ms);
                if (result.Success)
                {
                    return Assembly.Load(ms.ToArray());
                }
                else
                {
                    ThrowCompileException(result);
                    return null;
                }
            }
        }

        private void ThrowCompileException(EmitResult result)
        {
            var errorBuilder = new StringBuilder();

            foreach (var diagnostic in result.Diagnostics.Where(diagnostic =>
                        diagnostic.IsWarningAsError ||
                        diagnostic.Severity == DiagnosticSeverity.Error))
            {
                errorBuilder.AppendFormat("{0}: {1}", diagnostic.Id, diagnostic.GetMessage());
            }

            throw new CodeCompileException(errorBuilder.ToString());
        }
    }

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

    /// <summary>
    /// 提供代码编译器管理的接口。
    /// </summary>
    public interface ICodeCompilerManager
    {
        /// <summary>
        /// 注册指定语言类型的代码编译器类型。
        /// </summary>
        /// <typeparam name="TCompiler"></typeparam>
        /// <param name="languages">语言。</param>
        void Register<TCompiler>(params string[] languages) where TCompiler : ICodeCompiler;

        /// <summary>
        /// 创建代码编译器。
        /// </summary>
        /// <param name="language">语言。</param>
        /// <returns></returns>
        ICodeCompiler? CreateCompiler(string language);
    }

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

    /// <summary>
    /// 缺省的代码编译器管理器。
    /// </summary>
    public class DefaultCodeCompilerManager : ICodeCompilerManager
    {
        private readonly Dictionary<string, Type> _languageMappers = new(new StringIgnoreCaseComparer());

        private class StringIgnoreCaseComparer : IEqualityComparer<string>
        {
            public bool Equals(string x, string y)
            {
                return string.Compare(x, y, true) == 0;
            }

            public int GetHashCode(string obj)
            {
                return obj?.GetHashCode() ?? 0;
            }
        }

        /// <summary>
        /// 初始化 <see cref="DefaultCodeCompilerManager"/> 类新实例。
        /// </summary>
        public DefaultCodeCompilerManager()
        {
            Register<CSharpCodeCompiler>("csharp", "c#");
        }

        /// <summary>
        /// 注册指定语言类型的代码编译器类型。
        /// </summary>
        /// <typeparam name="TCompiler"></typeparam>
        /// <param name="languages">语言。</param>
        public void Register<TCompiler>(params string[] languages) where TCompiler : ICodeCompiler
        {
            foreach (var language in languages)
            {
                _languageMappers.AddOrReplace(language, typeof(TCompiler));
            }
        }

        /// <summary>
        /// 创建代码编译器。
        /// </summary>
        /// <param name="language">语言。</param>
        /// <returns></returns>
        public ICodeCompiler? CreateCompiler(string language)
        {
            if (_languageMappers.TryGetValue(language, out var compilerType))
            {
                return Activator.CreateInstance(compilerType) as ICodeCompiler;
            }

            return null;
        }
    }

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

        /// <summary>
        /// 添加框架的基本支持。
        /// </summary>
        /// <param name="services"><see cref="IServiceCollection"/> 实例。</param>
        /// <param name="configure">配置方法。</param>
        /// <returns></returns>
        public static SetupBuilder AddFireasy(this IServiceCollection services, Action<SetupOptions>? configure = null)
        {
            services.AddSingleton<ICodeCompilerManager>(new DefaultCodeCompilerManager());

            var options = new SetupOptions();
            //省略后面的代码

            return builder;
        }

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

    /// <summary>
    /// VisualBasic 代码编译器。无法继承此类。
    /// </summary>
    public class VisualBasicCodeCompiler : ICodeCompiler
    {
        /// <summary>
        /// 编译代码生成一个程序集。
        /// </summary>
        /// <param name="source">程序源代码。</param>
        /// <param name="options">配置选项。</param>
        /// <returns>由代码编译成的程序集。</returns>
        public Assembly? CompileAssembly(string source, ConfigureOptions? options = null)
        {
            options ??= new ConfigureOptions();
            var compilation = VisualBasicCompilation.Create(Guid.NewGuid().ToString())
                .AddSyntaxTrees(VisualBasicSyntaxTree.ParseText(source))
                .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location))
                .AddReferences(options.Assemblies.Select(s => MetadataReference.CreateFromFile(s)))
                .WithOptions(new VisualBasicCompilationOptions(OutputKind.DynamicallyLinkedLibrary, optimizationLevel: OptimizationLevel.Release));

            if (!string.IsNullOrEmpty(options.OutputAssembly))
            {
                var result = compilation.Emit(options.OutputAssembly);
                if (result.Success)
                {
                    return Assembly.Load(options.OutputAssembly);
                }
                else
                {
                    ThrowCompileException(result);
                    return null;
                }
            }
            else
            {
                using var ms = new MemoryStream();
                var result = compilation.Emit(ms);
                if (result.Success)
                {
                    return Assembly.Load(ms.ToArray());
                }
                else
                {
                    ThrowCompileException(result);
                    return null;
                }
            }
        }

        private void ThrowCompileException(EmitResult result)
        {
            var errorBuilder = new StringBuilder();

            foreach (var diagnostic in result.Diagnostics.Where(diagnostic =>
                        diagnostic.IsWarningAsError ||
                        diagnostic.Severity == DiagnosticSeverity.Error))
            {
                errorBuilder.AppendFormat("{0}: {1}", diagnostic.Id, diagnostic.GetMessage());
            }

            throw new CodeCompileException(errorBuilder.ToString());
        }
    }

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

[assembly: ServicesDeploy(typeof(VisualBasicServicesDeployer))]

namespace Fireasy.Data.DependencyInjection
{
    /// <summary>
    /// 服务部署。
    /// </summary>
    public class VisualBasicServicesDeployer : IServicesDeployer
    {
        void IServicesDeployer.Configure(IServiceCollection services)
        {
            var manager = services.GetSingletonInstance<ICodeCompilerManager>();
            manager!.Register<VisualBasicCodeCompiler>("vb");
        }
    }
}

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

        /// <summary>
        /// 使用c#源代码
        /// </summary>
        [TestMethod]
        public void TestCompileAssembly()
        {
            var source = @"
public class A
{
    public string Hello(string str)
    {
        return str;
    }
}";
            var codeCompilerManager = ServiceProvider.GetService<ICodeCompilerManager>();
            var codeCompiler = codeCompilerManager!.CreateCompiler("csharp");

            var assembly = codeCompiler!.CompileAssembly(source);

            var type = assembly!.GetType("A");

            Assert.IsNotNull(type);
        }

        /// <summary>
        /// 使用vb源代码
        /// </summary>
        [TestMethod]
        public void TestCompileAssemblyUseVb()
        {
            var source = @"
Public Class A
    Public Function Hello(ByVal str As String) As String
        Return str
    End Function
End Class";
            var codeCompilerManager = ServiceProvider.GetService<ICodeCompilerManager>();
            var codeCompiler = codeCompilerManager!.CreateCompiler("vb");

            var assembly = codeCompiler!.CompileAssembly(source);

            var type = assembly!.GetType("A");

            Assert.IsNotNull(type);
        }

  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 。

有关Fireasy3 揭秘 -- 代码编译器及适配器的更多相关文章

  1. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

    如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  2. ruby-on-rails - Rails 源代码 : initialize hash in a weird way? - 2

    在rails源中:https://github.com/rails/rails/blob/master/activesupport/lib/active_support/lazy_load_hooks.rb可以看到以下内容@load_hooks=Hash.new{|h,k|h[k]=[]}在IRB中,它只是初始化一个空哈希。和做有什么区别@load_hooks=Hash.new 最佳答案 查看rubydocumentationforHashnew→new_hashclicktotogglesourcenew(obj)→new_has

  3. ruby-on-rails - 浏览 Ruby 源代码 - 2

    我的主要目标是能够完全理解我正在使用的库/gem。我尝试在Github上从头到尾阅读源代码,但这真的很难。我认为更有趣、更温和的踏脚石就是在使用时阅读每个库/gem方法的源代码。例如,我想知道RubyonRails中的redirect_to方法是如何工作的:如何查找redirect_to方法的源代码?我知道在pry中我可以执行类似show-methodmethod的操作,但我如何才能对Rails框架中的方法执行此操作?您对我如何更好地理解Gem及其API有什么建议吗?仅仅阅读源代码似乎真的很难,尤其是对于框架。谢谢! 最佳答案 Ru

  4. ruby - 模块嵌套代码风格偏好 - 2

    我的假设是moduleAmoduleBendend和moduleA::Bend是一样的。我能够从thisblog找到解决方案,thisSOthread和andthisSOthread.为什么以及什么时候应该更喜欢紧凑语法A::B而不是另一个,因为它显然有一个缺点?我有一种直觉,它可能与性能有关,因为在更多命名空间中查找常量需要更多计算。但是我无法通过对普通类进行基准测试来验证这一点。 最佳答案 这两种写作方法经常被混淆。首先要说的是,据我所知,没有可衡量的性能差异。(在下面的书面示例中不断查找)最明显的区别,可能也是最著名的,是你的

  5. ruby - 寻找通过阅读代码确定编程语言的ruby gem? - 2

    几个月前,我读了一篇关于ruby​​gem的博客文章,它可以通过阅读代码本身来确定编程语言。对于我的生活,我不记得博客或gem的名称。谷歌搜索“ruby编程语言猜测”及其变体也无济于事。有人碰巧知道相关gem的名称吗? 最佳答案 是这个吗:http://github.com/chrislo/sourceclassifier/tree/master 关于ruby-寻找通过阅读代码确定编程语言的rubygem?,我们在StackOverflow上找到一个类似的问题:

  6. ruby - Net::HTTP 获取源代码和状态 - 2

    我目前正在使用以下方法获取页面的源代码:Net::HTTP.get(URI.parse(page.url))我还想获取HTTP状态,而无需发出第二个请求。有没有办法用另一种方法做到这一点?我一直在查看文档,但似乎找不到我要找的东西。 最佳答案 在我看来,除非您需要一些真正的低级访问或控制,否则最好使用Ruby的内置Open::URI模块:require'open-uri'io=open('http://www.example.org/')#=>#body=io.read[0,50]#=>"["200","OK"]io.base_ur

  7. ruby - Sinatra set cache_control to static files in public folder编译错误 - 2

    我不知道为什么,但是当我设置这个设置时它无法编译设置:static_cache_control,[:public,:max_age=>300]这是我得到的syntaxerror,unexpectedtASSOC,expecting']'(SyntaxError)set:static_cache_control,[:public,:max_age=>300]^我只想将“过期”header设置为css、javaascript和图像文件。谢谢。 最佳答案 我猜您使用的是Ruby1.8.7。Sinatra文档中显示的语法似乎是在Ruby1.

  8. 程序员如何提高代码能力? - 2

    前言作为一名程序员,自己的本质工作就是做程序开发,那么程序开发的时候最直接的体现就是代码,检验一个程序员技术水平的一个核心环节就是开发时候的代码能力。众所周知,程序开发的水平提升是一个循序渐进的过程,每一位程序员都是从“菜鸟”变成“大神”的,所以程序员在程序开发过程中的代码能力也是根据平时开发中的业务实践来积累和提升的。提高代码能力核心要素程序员要想提高自身代码能力,尤其是新晋程序员的代码能力有很大的提升空间的时候,需要针对性的去提高自己的代码能力。提高代码能力其实有几个比较关键的点,只要把握住这些方面,就能很好的、快速的提高自己的一部分代码能力。1、多去阅读开源项目,如有机会可以亲自参与开源

  9. 7个大一C语言必学的程序 / C语言经典代码大全 - 2

    嗨~大家好,这里是可莉!今天给大家带来的是7个C语言的经典基础代码~那一起往下看下去把【程序一】打印100到200之间的素数#includeintmain(){ inti; for(i=100;i 【程序二】输出乘法口诀表#includeintmain(){inti;for(i=1;i 【程序三】判断1000年---2000年之间的闰年#includeintmain(){intyear;for(year=1000;year 【程序四】给定两个整形变量的值,将两个值的内容进行交换。这里提供两种方法来进行交换,第一种为创建临时变量来进行交换,第二种是不创建临时变量而直接进行交换。1.创建临时变量来

  10. git使用常见问题(提交代码,合并冲突) - 2

    文章目录git常用命令(简介,详细参数往下看)Git提交代码步骤gitpullgitstatusgitaddgitcommitgitpushgit代码冲突合并问题方法一:放弃本地代码方法二:合并代码常用命令以及详细参数gitadd将文件添加到仓库:gitdiff比较文件异同gitlog查看历史记录gitreset代码回滚版本库相关操作远程仓库相关操作分支相关操作创建分支查看分支:gitbranch合并分支:gitmerge删除分支:gitbranch-ddev查看分支合并图:gitlog–graph–pretty=oneline–abbrev-commit撤消某次提交git用户名密码相关配置g

随机推荐