Natasha 编译单元（四）

AssemblyCSharpBuilder

• 最基本编译单元，涵盖了编译流程所需的基本功能，包括创建域，加载dll文件，创建各种类，输出路径更换，调用特定域中的方法等。

• Natasha有两种方式编译流程，一种就是AssemblyCSharpBuilder ，相比较而言，它是轻量级的，个人怀疑另一种编译流程的底层也是使用了AssemblyCSharpBuilder 。

• 引用NuGet：DotNetCore.Natasha.CSharp

• 编译单元基本举例

  NatashaManagement.Preheating();
  //创建一个变量，用于参数带入和后期的参数比较
  String key = "HelloWorld";
  // 创建一个Test类，类中添加了一个变量和一个静态方法
  // 变量为key值，静态方法中放回声明的key值
  string code = "public class Test{" +
      "public string Name=\"" + key + "\"; " +
          "public static string GetName(){  " +
          "    return (new Test()).Name; " +
          "}" +
      "}";
  // 创建了一个myDomain域，指定了该域的使用范围
  using (DomainManagement.Create("myDomain").CreateScope())
  {
      // 声明基础编译单元
      AssemblyCSharpBuilder builder = new();
      // 添加code
      builder.Add(code);
      ///////////////调用使用//////////////////////////////////
      // 获得Test类的GetName方法
      var func = builder.GetDelegateFromShortName<Func<string>>("Test", "GetName");
      // 调用GetName方法，并返回
      String result = func();
      // 判断返回值是否与key相同
      if (key.Equals(result))
      {
          //相同
          System.Console.WriteLine("匹配");
      }
      else {
          // 不同时返回result数值，可查看为什么不同
          System.Console.WriteLine($"不匹配:{result}");
      }
  }
  

  返回结果：

  

AssemblyCSharpBuilder相关属性方法

属性

• Domain 编译单元所在域

  为什么要着重描述域的概念？当代码量越来越大，所需的插件逐渐增多时，一旦引用版本出现问题，会给程序本身带来灾难，而且一旦全部引用，程序所占的内存也是灾难级的。例如我们加载了两个不同平台版本的相同dll，调用时，系统无法判断我们应该用哪个，特别是两个版本的dll方法不同时，都无法判定哪里错了。例如java中使用maven去管理版本，vue使用npm管理版本一样，而域中的版本管理也很重要。

  建议：

  1.写代码时，就要设计好引用管理问题，不然日积月累，会越来越臃肿

  2.建议类似maven的pom一样管理dll版本，这样不至于导致版本引用混乱

  3.划分不同的域，每个域用反射调用，主要用于解耦。

  4.封装每个域，让每个域成为独立的个体，完全解耦，适用于独立功能，功能简单的情况

  5.在LoadPluginWith**Dependency 时进行依赖引用判断

  ​ LoadPluginWithAllDependency ("*.dll", asmName=>{依赖列表，返回true为不包含，false为包含})。

• 为空时先从上下文中获得，如上文例子中的myDomain域，当上下文也为空，则设置为：NatashaReferenceDomain.DefaultDomain。

• Domain为NatashaReferenceDomain类，因该类重载了AssemblyLoadContext类，因此会有基类的特性：

  1. LoadFromStream和LoadAssemblyFromFile等方法

     加载文件流或文件到该域中，也可以加载Natasha生成的相关文件

     当域中存在相同的文件时，直接跳过。

  2. 当遇到相同文件时，希望可以选择，则可以使用下列方法

     LoadPluginWithAllDependency [全加载]

     LoadPluginWithHighDependency[高版本加载]

     LoadPluginWithLowDependency [低版本加载]

     LoadPluginUseDefaultDependency[使用主域版本]

• DllFilePath，PdbFilePath，XmlFilePath

  生成的dll，pdb，xml文件的路径地址，绝对路径

• DefaultUsing.UsingScript 可以添加默认的引用

方法

• 引用相关方法

  // LoadBehaviorEnum
  // 		UseHighVersion		使用高版本
  //		UseLowVersion		使用低版本
  // 当编译后加载程序集时，程序集中依赖存在高版本，则使用高版本依赖
  CompileWithAssemblyLoadBehavior(LoadBehaviorEnum.UseHighVersion) 
  // 当合并引用时,引用列表中存在高版本, 则使用高版本引用           
  CompileWithReferenceLoadBehavior(LoadBehaviorEnum.UseHighVersion)
  // 引用过滤逻辑 
  CompileWithReferencesFilter((defaultAsmName, targetAsmName)=> LoadVersionResultEnum.UseDefault) 
  

• 更改输出路径

  // 参数可以更换目录
  builder.UseNatashaFileOut();
  builder.SetDllFilePath(path);               //设置生成的 DLL 文件路径  c:/1.dll
  builder.SetPdbFilePath(path);               //设置生成的 PDB 文件路径  c:/1.pdb
  builder.SetXmlFilePath(path);              //设置生成的 XML 文件路径  c:/1.xml
  

• 配置编译器参数

  目前水平碰不得

  ConfigCompilerOption(opt => { });

• 配置语法树

  目前水平碰不得

  ConfigSyntaxOptions(opt => opt)

• 语义过滤器(委托)

  参数一和参数二返回一个参数二一致的类型

  AddSemanticAnalysistor((currentBuilder, currentCompiler) => currentCompiler)

  这个感觉知道就好，一般用不到

  builder1.AddSemanticAnalysistor((build, compla) =>
  {
      // 重新创建了一个Test的动态编译
      var complation = CSharpCompilation.Create("Test")
          // 添加本地资源
          .AddReferences(
              MetadataReference.CreateFromFile(
                  typeof(object).Assembly.Location)
              )
          // 添加编译代码  
          .AddSyntaxTrees(CSharpSyntaxTree.ParseText("public class A {public String Hello(){return \"Hello\"}}"))
          // 添加配置项
          .WithOptions(new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary));
      return complation;
  });
  

• 清除所有语义过滤器

  ClearInnerSemanticAnalysistor

  内部实际调用UsingAnalysistor._usingSemanticDelegate，在我理解就是删除了语义委托的缓存

• 添加代码

  Add(String code) 添加脚本

  Add(SyntaxTree tree) 添加语法树，例如：CSharpSyntaxTree.ParseText

• 获取编译后的动态程序集

  GetAssembly获得Assembly

  获得Assembly后可获得相关信息

  通过Assembly.GetType()获得具体类型信息，也可通过Activator.CreateInstance()进行实例化

• 获取到类型

  直接获得类型

  GetTypeFromShortName("Test")

  GetTypeFromFullName("xxNamespace.xxClassName")

已知问题

摘自官网

• 缺少引用文件报错 NatashaException:“找不到 RuntimeMetadataVersion 的值。找不到包含 System.Object 的程序集，或未通过选项为 RuntimeMetadataVersion 指定值。”
  • 使用 NatashaManagement.AddGlobalReference(); 来手动添加默认域的引用文件.
  • 使用 domain.LoadAssemblyFromFile / LoadPluginXXXDependency 来手东添加其他域的引用文件.
• 缺少 Using 引用;
  • 使用 NatashaManagement.AddGlobalUsing("mynamespace") 来手动添加全局 using.
  • 使用 domain.UsingRecorder.Using("mynamespace") 来手动添加其他域的 using.