在开发领域,我们经常会遇到需要动态加载和执行代码的场景。对于Python、JavaScript、Lua等脚本语言,动态性是它们的天性,而对于需要预先编译的语言,如C#,动态执行似乎并不那么直观。但随着AI的普及,例如我们想在C#程序中动态执行AI生成的代码段,这就要求我们能在运行时编译和执行C#代码。接下来,让我为你介绍一个强大的框架——Natasha。
Natasha:动态地构建你的.Net世界
Natasha是一个基于Roslyn的C#动态程序集构建库。它允许开发者在程序运行时动态地构建域、程序集、类、结构体、枚举、接口和方法等。这意味着开发者可以在不停止应用程序的情况下,为其增加新的程序集。
Natasha框架具备域管理和插件管理功能,支持域的隔离和卸载,实现了热插拔。它提供了完善的错误提示,自动添加引用,并且拥有完整的数据结构构建模板,从而让开发者专注于程序集脚本的编写。更何况它还有着跨平台的优势,并且对netcoreapp2.0+ / netcoreapp3.0+都兼容。
Natasha的使用场景
你可能会好奇,这样一个动态编译库是如何彰显其价值的?其实,动态编译技术是支撑如今.NET生态不可或缺的重要部分。无论是在官方还是非官方的库中,动态编译的技术都扮演着“服务”的角色。其核心是MSIL,官方为我们提供了Emit技术来编写IL代码。但Emit的编写和维护并不友好,给开发者带来了诸多挑战。
Roslyn的出现仿佛开启了新世界的大门,它使得Emit变得透明,并允许我们直接用C#进行动态编译。Natasha就是在这样的基础上发展起来的,经过精心设计与不断迭代,它正成为动态编译领域的佼佼者。
Natasha的简单应用场景
借助Natasha,你可以实现众多有趣而实用的功能,如创建AOP代理类或动态构建Controller来实现动态API,甚至在程序启动时与CodeFirst兼容的ORM一起使用,动态创建表结构,甚至通过动态执行AI创建的代码段,这是个非常有趣的事情!
不可否认,这些功能的实现需要一定的编程基础。例如,下面的代码展示了如何使用Natasha快速开始一个域,并利用其插件管理功能。
// 开始创建域
var domain = new NatashaDomain();
// 创建非主域
var domain = new NatashaDomain(key);
// 加载插件
var assembly = domain.LoadPlugin(pluginPath);
// 使用程序集比较器
domain.SetAssemblyLoadBehavior(AssemblyCompareInfomation.UseHighVersion);
// 封装
APIdomain.LoadPluginWithHighDependency(PluginPath);
在智能编译模式下,你可以使用如下代码快速地进行编译,Natasha将智能地合并元数据和Using声明,并进行语义检查。
AssemblyCSharpBuilder builder = new AssemblyCSharpBuilder(); var myAssembly = builder.UseRandomDomain() .UseSmartMode() .Add("public class A{ }") .GetAssembly();
Natasha的轻便编译模式
对于更加轻便的编译需求,Natasha提供了简洁编译模式。该模式会合并当前域的元数据和Using声明,并关闭语义检查,提供一种更加灵活快速的编译方式。
AssemblyCSharpBuilder builder = new AssemblyCSharpBuilder(); var myAssembly = builder.UseRandomDomain() .UseSimpleMode() .Add("public class A{ }") .GetAssembly();
元数据管理与微调
Natasha也提供了完整覆盖和部分覆盖引用和using代码的能力。例如,合并共享域的引用和using代码可以使用以下方法:
builder.WithCombineReferences(item => item.UseAllReferences()); builder.WithCombineUsingCode(UsingLoadBehavior.WithAll);
如果希望合并当前域的引用和using代码或者使用自定义的引用,可以使用如下方法:
builder.WithCurrentReferences(); builder.WithCombineUsingCode(UsingLoadBehavior.WithCurrent); // 使用自定义的元数据引用 builder.WithSpecifiedReferences(someMetadataReferences);
脚本教程
对于编写和加载脚本,Natasha采用灵活的配置API来覆盖using代码,并添加编译选项。这允许开发者指定脚本中要使用的C#语言版本,以及如何处理using指令。
// 配置语言版本 builder.ConfigSyntaxOptions(opt => opt.WithLanguageVersion(LanguageVersion.CSharp6)); // 添加脚本并覆盖Using Codebuilder.WithCombineUsingCode(UsingLoadBehavior.WithAll).Add(myCode); // 自定义覆盖Using Codebuilder.Add("script", UsingLoadBehavior.WithCurrent);
高级编译技巧
Natasha提供了一系列的With、Set和Config系列API来精细控制编译过程。你可以配置编译选项、诊断信息级别,甚至启用或关闭某些特殊的编译行为。例如,启用语义检查或添加语义处理插件:
// 启用语义检查 builder.WithSemanticCheck(); //增加语义处理插件 builder.AddSemanticAnalysistor();
动态调试
使用Natasha进行动态源代码调试是轻而易举的。开启调试模式可以帮助你更深入地了解代码执行情况,Natasha提供了多种选项来写入调试信息:
builder.WithDebugCompile(item => item.WriteToFile()); // 调试信息写入文件builder.WithDebugCompile(item => item.WriteToAssembly()); // 调试信息整合到程序集builder.WithReleaseCompile(); // 设置为Release模式
生成程序集
在程序集被编译前,你可以使用Natasha提供的API来进行各种配置,比如设置程序集名称或输出选项:
builder.SetAssemblyName("MyAssembly"); builder.WithSemanticCheck(); // 启用语义检查builder.WithFileOutput("path/to/dll", "path/to/pdb", "path/to/xml"); // 文件输出配置
使用 Codecov 的扩展
Natasha还提供了一个Codecov扩展,可帮助你获取代码覆盖率数据。首先你需要引入DotNetCore.Natasha.CSharp.Extension.Codecov
扩展包,然后像下面这样使用:
builder.WithCodecov(); Assembly asm = builder.GetAssembly(); List<(string MethodName, bool[] Usage)>? coverageData = asm.GetCodecovCollection(); Show(coverageData);
上面的Show
方法将遍历并显示每个方法的执行情况。这是一种很好的方式来监测你的代码如何执行,确保质量和可靠性。
Natasha 的类型扩展
最后,Natasha提供了类型扩展来帮助你更轻松地处理类型信息。例如,获取运行时或开发时的类型名称,或者检查类型是否实现了某个接口:
typeof(Dictionary<string,List<int>>[]).GetRuntimeName(); // 获取运行时类型名称typeof(Dictionary<string,List<int>>).IsImplementFrom<IDictionary>(); // 检查是否实现指定接口
当然这个项目也是开源的,不论是学习思路还是代码设计方案 ,查看下面的项目地址都是不错的选择
https://github.com/dotnetcore/Natasha
后面我会使用Natasha尝试通过AI来生成c#代码并动态执行,可以关注我,并持续关注我的下一步行动!