C#脚本引擎之AScript与Z.Expressions.Eval对比

一简介

1.1 AScript

AScript是一个开源的C#动态脚本解析执行引擎，支持自定义语法，支持扩展多种脚本语言（目前已支持C#/Python3/SQL/JavaScript/Lua五种语言），支持解释执行和编译执行两种执行模式，并且支持编译缓存。

目前官方最新版本：1.7.2

开源地址：

1.2 Z.Expressions.Eval

Z.Expression.Eval是一个非常强大的工具，使得开发人员可以动态编译和执行C#代码和表达式。

Execute C# Code
Compile C# Code
LINQ Dynamic

目前官方最新版本：6.3.13

官网地址：https://eval-expression.net

二功能

2.1 编译缓存

二者皆支持编译缓存功能：

1 // AScript默认不启用缓存
2 var script = new Script();
3 var result = script.Eval("5 + 6", -1);
4 
5 // Z.Expressions.Eval默认启用缓存
6 Z.Expressions.EvalManager.DefaultContext.UseCache = true;
7 var result = Z.Expressions.Eval.Execute<int>("5 + 6");

同时AScript支持缓存版本控制和定时清理缓存功能：

 1 /// <summary>
 2 /// 计算表达式，返回结果
 3 /// </summary>
 4 /// <param name="expression">脚本</param>
 5 /// <param name="cacheTime">
 6 /// <para>缓存时长</para>
 7 /// <para>为0表示不使用缓存（默认）；</para>
 8 /// <para>-1表示永久缓存；</para>
 9 /// <para>大于0表示缓存时长（单位：毫秒）</para>
10 /// </param>
11 /// <param name="cacheKey">
12 /// 缓存key（如果为空则取表达式字符串）
13 /// </param>
14 /// <param name="cacheVersion">
15 /// 缓存版本号，如果版本号有变化，则重新编译并缓存
16 /// </param>
17 /// <returns></returns>
18 public object Eval(string expression, int cacheTime = 0, string cacheKey = null, string cacheVersion = null);
19 public object Eval(Stream expression, int cacheTime = 0, string cacheKey = null, string cacheVersion = null);
20 public object Eval(Func<string> expression, int cacheTime = 0, string cacheKey = null, string cacheVersion = null);
21 public object Eval(Func<Stream> expression, int cacheTime = 0, string cacheKey = null, string cacheVersion = null);
22 public object EvalFile(string path, int cacheTime = 0, string cacheKey = null, string cacheVersion = null);

场景一

脚本保存在数据库或其他远程端，以业务标识为cacheKey，以修改时间戳为cacheVersion：

1 string cacheKey = "xxx";
2 string cacheVersion = "当前版本";
3 var script = new Script();
4 var result = script.Eval(()=>获取脚本, cacheTime: -1, cacheKey, cacheVersion);

如果版本未变化，则直接执行缓存中的委托；
如果版本有变化，则重新获取脚本-->编译-->缓存-->执行。

场景二

脚本保存在文件中，可以调用EvalFile方法，默认cacheKey为文件完整路径，cacheVersion可以设置为修改时间：

1 string cacheVersion = System.IO.File.GetLastWriteTimeUtc(path).Ticks.ToString();
2 var script = new Script();
3 var result = script.EvalFile(path, cacheTime: -1, cacheVersion: cacheVersion);

如果文件未修改，则直接执行缓存中的委托；
如果文件有修改，则重新读取文件-->编译-->缓存-->执行。

2.2 Compile

将脚本编译生成委托：

1 // AScript
2 var script = new Script();
3 Func<int, int> func = script.Compile<int, int>("a + 5", "a");
4 Func<int, int> func = script.Compile<Func<int, int>>("a + 5", new[] { "a" });
5 
6 // Z.Expressions.Eval
7 Func<int, int> func = Z.Expressions.Eval.Compile<Func<int, int>>("a + 5", "a");

2.3 注入函数

添加类中的方法

 1 // AScript
 2 var script = new Script();
 3 // 添加静态方法，支持扩展方法
 4 script.Context.AddFunc(typeof(MyClass));
 5 // 添加实例方法
 6 script.Context.AddFunc(new MyClass());
 7 script.Eval("Sum(5, 6)");
 8 script.Eval("Hello('tom')");
 9 
10 // Z.Expressions.Eval：支持静态方法，不支持实例方法
11 Z.Expressions.EvalManager.DefaultContext.RegisterStaticMethod(typeof(MyClass));
12 Z.Expressions.Eval.Execute("Sum(5, 6)");
13 
14 public class MyClass
15 {
16     public static int Sum(int a, int b) => a + b;
17 
18     public string Hello(string name) => $"hello {name}";
19 }

添加委托

1 // AScript
2 var script = new Script();
3 script.Context.AddFunc<int, int, int>("sum", (a, b) => a + b);
4 script.Eval("sum(5, 6)");
5 
6 // Z.Expressions.Eval不支持添加委托

2.4 递归函数

AScript支持定义递归函数，Z.Expressions.Eval不支持递归函数。

1 string code = @"
2 int fib(int n) {
3     if (n <= 1) return n;
4     return fib(n - 1) + fib(n - 2);
5 }
6 fib(10)
7 ";
8 var script = new Script();
9 var result = script.Eval<int>(code); // 55

相关文章：AScript之编译递归函数

2.5 Queryable/Enumerable扩展方法

 1 string code = @"
 2 var list = new List<int>() { 1, 2, 3, 4 };
 3 return list.Where(x => x > 2).ToList();
 4 ";
 5 
 6 // AScript
 7 var script = new Script();
 8 var result = script.Eval<List<int>>(code);
 9 
10 // Z.Expressions.Eval
11 var result = Z.Expressions.Eval.Execute<List<int>>(code);

2.6 LINQ Dynamic

1 List<int> list = new List<int> { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
2 // AScript动态LINQ扩展
3 var result = list.WhereScript(x => "x % 2 == 0").ToList();
4 // Z.Expressions.Eval动态LINQ扩展
5 var result = list.WhereDynamic(x => "x % 2 == 0").ToList();

2.7 LINQ查询语法

AScript支持查询语法，Z.Expressions.Eval不支持。

1 string code = @"
2 var list = new List<int>() { 1, 2, 3, 4 };
3 var q = from item in list
4     where item > 2
5     select item * 10;
6 return q.ToList();
7 ";
8 var script = new Script();
9 var result = script.Eval<List<int>>(code);

2.8 混合多语言脚本

AScript脚本中使用@lang/@end指定语言：

 1 Script.Langs.Set("js", JavaScriptLang.Instance);
 2 Script.Langs.Set("lua", LuaLang.Instance);
 3 
 4 string code = @"
 5 int a = 12;
 6 string s = 'hello';
 7 
 8 // 调用lua语言中的打包/解包方法
 9 @lang lua
10 local data = string.pack('<i4c10', a, s)
11 local a2,s2 = string.unpack('i4c10', data)
12 @end
13 
14 Console.WriteLine(a2 + s2); // 12hello
15 
16 // 调用js语言中的控制台输出
17 @lang js
18 console.log(a2, s2); // 12,hello
19 @end
20 ";
21 var script = new Script();
22 script.Eval(code);

2.9 层级上下文

Z.Expressions.Eval中的EvalContext不支持层级，创建EvalContext实例成本高
AScript中的ScriptContext支持层级，ScriptContext.Root为全局顶级上下文

 1 // 创建业务上下文：context.Parent为ScriptContext.Root
 2 var context = new ScriptContext();
 3 // TODO: context中设置共享业务数据
 4 context.SetVar("order", order);
 5 
 6 // 创建子上下文1：subContext1.Parent为context
 7 var subContext1 = new ScriptContext(context);
 8 // TODO: subContext1中设置子业务数据
 9 subContext1.SetVar("user", user1);
10 // 执行脚本
11 var script1 = new Script(subContext1);
12 script1.Eval(code1);
13 
14 // 创建子上下文2：subContext2.Parent为context
15 var subContext2 = new ScriptContext(context);
16 // TODO: subContext2中设置子业务数据
17 subContext2.SetVar("user", user2);
18 // 执行脚本
19 var script2 = new Script(subContext2);
20 script2.Eval(code2);

三性能测试

使用Benchmark工具进行性能基准测试，测试环境：

BenchmarkDotNet v0.14.0, Windows 11 (10.0.22621.4317/22H2/2022Update/SunValley2)
AMD Ryzen 7 7840H with Radeon 780M Graphics, 1 CPU, 16 logical and 8 physical cores
.NET SDK 9.0.316
  [Host]     : .NET 6.0.36 (6.0.3624.51421), X64 RyuJIT AVX2
  DefaultJob : .NET 6.0.36 (6.0.3624.51421), X64 RyuJIT AVX2

安装nuget包：

install-package AScript
install-package Z.Expressions.Eval

3.1 常量表达式

 1 private static readonly string s = "100 * (5 + 5) * (6-2)";
 2 private static readonly int r = 100 * (5 + 5) * (6 - 2);
 3 
 4 // 解释执行
 5 [Benchmark]
 6 public void AScript1()
 7 {
 8     var script = new Script();
 9     var result = script.Eval<int>(s);
10     if (result != r) throw new Exception("result error");
11 }
12 
13 // 编译执行
14 [Benchmark]
15 public void AScript2_Compile()
16 {
17     var script = new Script();
18     var result = script.Eval<int>(s, ECompileMode.All);
19     if (result != r) throw new Exception("result error");
20 }
21 
22 [Benchmark]
23 public void ZExpressions2()
24 {
25     Z.Expressions.EvalManager.DefaultContext.UseCache = false;
26     var result = Z.Expressions.Eval.Execute<int>(s);
27     if (result != r) throw new Exception("result error");
28 }
29 
30 // 编译缓存
31 [Benchmark]
32 public void AScript3_Cache()
33 {
34     var script = new Script();
35     var result = script.Eval<int>(s, -1);
36     if (result != r) throw new Exception("result error");
37 }
38 
39 [Benchmark]
40 public void ZExpressions3()
41 {
42     Z.Expressions.EvalManager.DefaultContext.UseCache = true;
43     var result = Z.Expressions.Eval.Execute<int>(s);
44     if (result != r) throw new Exception("result error");
45 }

测试结果：

46a7ca0d912a8d86ea3c094fc60faedd_v2-6734fd7a84cc91a12c6cd52d2194bce8_r