Dynamic Expresso

支持的平台：.NET Core 3.1、.NET Core 5.0 及以上版本、.NET 4.6.2

Dynamic Expresso 是一个用 .NET Standard 2.0 编写的简单 C# 语句解释器。 Dynamic Expresso 内置了自己的解析逻辑，通过将 C# 语句转换为 .NET lambda 表达式或委托来真正解释 C# 语句。

使用 Dynamic Expresso，开发人员可以创建可脚本化的应用程序、执行无需编译的 .NET 代码或创建动态 LINQ 语句。

语句使用 C# 语言规范的一个子集编写。全局变量或参数可以被注入并在表达式中使用。它不生成程序集，而是即时创建表达式树。

dynamic expresso 工作流程

例如，您可以计算数学表达式：

var interpreter = new Interpreter();
var result = interpreter.Eval("8 / 2 + 2");

或解析带有变量或参数的表达式并多次调用它：

var interpreter = new Interpreter().SetVariable("service", new ServiceExample());
string expression = "x > 4 ? service.OneMethod() : service.AnotherMethod()";
Lambda parsedExpression = interpreter.Parse(expression, new Parameter("x", typeof(int)));
var result = parsedExpression.Invoke(5);

或生成委托和 lambda 表达式用于 LINQ 查询：

var prices = new [] { 5, 8, 6, 2 };
var whereFunction = new Interpreter().ParseAsDelegate<Func<int, bool>>("arg > 5");
var count = prices.Where(whereFunction).Count();

在线演示

Dynamic Expresso 在线演示：http://dynamic-expresso.azurewebsites.net/

快速入门

Dynamic Expresso 可在 [NuGet] 上获得。您可以使用以下命令安装软件包：

PM> Install-Package DynamicExpresso.Core

用于调试的源代码和符号（.pdb 文件）可在 [Symbol Source] 上获得。

特性

表达式可以使用 C# 语法的子集编写（有关更多信息，请参阅语法部分）
支持变量和参数
可以生成委托或 lambda 表达式
完整的单元测试套件
与其他类似项目相比，性能良好
部分支持泛型、params 数组和扩展方法（仅支持隐式泛型参数检测）
部分支持 dynamic（ExpandoObject 用于获取属性、方法调用和索引(#142)，见 #72。DynamicObject 用于获取属性和索引，见 #142）
部分支持 lambda 表达式（默认禁用，因为会略微影响性能）
不区分大小写的表达式（默认区分大小写）
能够发现给定表达式的标识符（变量、类型、参数）
占用空间小，生成的表达式是托管类，可以卸载并在单个应用程序域中执行
易于使用和部署，所有功能都包含在一个程序集中，没有其他外部依赖项
使用 .NET Standard 2.0 编写
- 可用于 .NET 4.6.1 和 .NET Core 2.0 的构建
开源（MIT 许可证）

返回值

您可以解析和执行无返回值的表达式（void 表达式），也可以返回任何有效的 .NET 类型。解析表达式时，您可以指定预期的表达式返回类型。例如，您可以这样写：

var target = new Interpreter();
double result = target.Eval<double>("Math.Pow(x, y) + 5",
				    new Parameter("x", typeof(double), 10),
				    new Parameter("y", typeof(double), 2));

内置解析器还可以理解任何给定表达式的返回类型，因此您可以检查表达式是否返回您期望的内容。

变量

可以使用 Interpreter.SetVariable 方法在表达式中使用变量：

var target = new Interpreter().SetVariable("myVar", 23);

Assert.AreEqual(23, target.Eval("myVar"));

变量可以是基本类型或自定义复杂类型（类、结构、委托、数组、集合等）。

可以使用 Interpreter.SetFunction 方法通过委托变量传递自定义函数：

Func<double, double, double> pow = (x, y) => Math.Pow(x, y);
var target = new Interpreter().SetFunction("pow", pow);

Assert.AreEqual(9.0, target.Eval("pow(3, 2)"));

可以使用 Interpreter.SetExpression 方法传递自定义 Expression。

参数

解析的表达式可以接受一个或多个参数：

var interpreter = new Interpreter();

var parameters = new[] {
	new Parameter("x", 23),
	new Parameter("y", 7)
};

Assert.AreEqual(30, interpreter.Eval("x + y", parameters));

参数可以是基本类型或自定义类型。您可以解析一次表达式，然后多次使用不同的参数值调用它：

var target = new Interpreter();

var parameters = new[] {
	new Parameter("x", typeof(int)),
	new Parameter("y", typeof(int))
};

var myFunc = target.Parse("x + y", parameters);

Assert.AreEqual(30, myFunc.Invoke(23, 7));
Assert.AreEqual(30, myFunc.Invoke(32, -2));

特殊标识符

名为 this 的变量或参数可以被隐式引用。

class Customer { public string Name { get; set; } }

var target = new Interpreter();

// 'this' 被视为特殊标识符，可以隐式访问
target.SetVariable("this", new Customer { Name = "John" });

// 通过 'this' 变量显式引用上下文
Assert.AreEqual("John", target.Eval("this.Name"));

// 隐式引用 'this' 变量
Assert.AreEqual("John", target.Eval("Name"));

内置类型和自定义类型

当前可用的预定义类型有：

Object object 
Boolean bool 
Char char
String string
SByte Byte byte
Int16 UInt16 Int32 int UInt32 Int64 long UInt64 
Single Double double Decimal decimal 
DateTime TimeSpan
Guid
Math Convert

您可以使用 Interpreter.Reference 方法引用任何其他自定义 .NET 类型：

var target = new Interpreter().Reference(typeof(Uri));

Assert.AreEqual(typeof(Uri), target.Eval("typeof(Uri)"));
Assert.AreEqual(Uri.UriSchemeHttp, target.Eval("Uri.UriSchemeHttp"));

生成动态委托

您可以使用 Interpreter.ParseAsDelegate<TDelegate> 方法直接将表达式解析为可以正常调用的 .NET 委托类型。在下面的示例中，我生成了一个 Func<Customer, bool> 委托，可以在 LINQ where 表达式中使用。

class Customer
{
	public string Name { get; set; }
	public int Age { get; set; }
	public char Gender { get; set; }
}

[Test]
public void Linq_Where()
{
	var customers = new List<Customer> {
		new Customer() { Name = "David", Age = 31, Gender = 'M' },
		new Customer() { Name = "Mary", Age = 29, Gender = 'F' },
		new Customer() { Name = "Jack", Age = 2, Gender = 'M' },
		new Customer() { Name = "Marta", Age = 1, Gender = 'F' },
		new Customer() { Name = "Moses", Age = 120, Gender = 'M' },
	};

	string whereExpression = "customer.Age > 18 && customer.Gender == 'F'";

	var interpreter = new Interpreter();
	Func<Customer, bool> dynamicWhere = interpreter.ParseAsDelegate<Func<Customer, bool>>(whereExpression, "customer");

	Assert.AreEqual(1, customers.Where(dynamicWhere).Count());
}

这是解析表达式的首选方法，您在编译时就知道它可以接受什么参数以及必须返回什么值。

生成 lambda 表达式

您可以使用 Interpreter.ParseAsExpression<TDelegate> 方法直接将表达式解析为 .NET lambda 表达式（Expression<TDelegate>）。

在下面的示例中，我生成了一个 Expression<Func<Customer, bool>> 表达式，可以在可查询的 LINQ where 表达式中使用，或在需要表达式的任何其他地方使用。比如 Entity Framework 或其他类似的库。

class Customer
{
	public string Name { get; set; }
	public int Age { get; set; }
	public char Gender { get; set; }
}

[Test]
public void Linq_Queryable_Expression_Where()
{
	IQueryable<Customer> customers = (new List<Customer> {
		new Customer() { Name = "David", Age = 31, Gender = 'M' },
		new Customer() { Name = "Mary", Age = 29, Gender = 'F' },
		new Customer() { Name = "Jack", Age = 2, Gender = 'M' },
		new Customer() { Name = "Marta", Age = 1, Gender = 'F' },
		new Customer() { Name = "Moses", Age = 120, Gender = 'M' },
	}).AsQueryable();

	string whereExpression = "customer.Age > 18 && customer.Gender == 'F'";

	var interpreter = new Interpreter();
	Expression<Func<Customer, bool>> expression = interpreter.ParseAsExpression<Func<Customer, bool>>(whereExpression, "customer");

	Assert.AreEqual(1, customers.Where(expression).Count());
}

语法和运算符

语句可以使用C#语法的一个子集来编写。以下是支持的表达式列表：

运算符

支持的运算符：

类别	运算符
主要	`x.y f(x) a[x] new typeof`
一元	`+ - ! (T)x`
乘法	`* / %`
加法	`+ -`
关系和类型测试	`< > <= >= is as`
相等	`== !=`
逻辑与	`&`
逻辑或	`\|`
逻辑异或	`^`
条件与	`&&`
条件或	`\|\|`
条件	`?:`
赋值	`=`
空合并	`??`

运算符优先级遵循C#规则（运算符优先级和结合性）。

出于安全原因，一些运算符（如赋值运算符）可能被禁用。

字面量

类别	运算符
常量	`true false null`
实数字面量后缀	`d f m`
整数字面量后缀	`u l ul lu`
字符串/字符	`"" ''`

字符串或字符字面量中支持以下字符转义序列：

\' - 单引号，用于字符字面量
\" - 双引号，用于字符串字面量
\\ - 反斜杠
\0 - Unicode字符0
\a - 警报（字符7）
\b - 退格（字符8）
\f - 换页（字符12）
\n - 换行（字符10）
\r - 回车（字符13）
\t - 水平制表符（字符9）
\v - 垂直引号（字符11）

类型成员调用

可以调用任何标准.NET方法、字段、属性或构造函数。

var service = new MyTestService();
var context = new MyTestContext();

var target = new Interpreter()
  .SetVariable("x", service)
  .SetVariable("this", context);

Assert.AreEqual(service.HelloWorld(), target.Eval("x.HelloWorld()"));
Assert.AreEqual(service.AProperty, target.Eval("x.AProperty"));
Assert.AreEqual(service.AField, target.Eval("x.AField"));

// 隐式上下文引用
Assert.AreEqual(context.GetContextId(), target.Eval("GetContextId()"));
Assert.AreEqual(context.ContextName, target.Eval("ContextName"));
Assert.AreEqual(context.ContextField, target.Eval("ContextField"));

var target = new Interpreter();
Assert.AreEqual(new DateTime(2015, 1, 24), target.Eval("new DateTime(2015, 1, 24)"));

Dynamic Expresso还支持：

扩展方法

var x = new int[] { 10, 30, 4 };
var target = new Interpreter()
	.Reference(typeof(System.Linq.Enumerable))
	.SetVariable("x", x);
Assert.AreEqual(x.Count(), target.Eval("x.Count()"));

索引器方法（如array[0]）
泛型，仅部分支持（只支持隐式，不能调用显式泛型方法）
参数数组（参见C#的params关键字）

Lambda表达式

Dynamic Expresso对Lambda表达式提供部分支持。例如，您可以使用任何Linq方法：

var x = new string[] { "this", "is", "awesome" };
var options = InterpreterOptions.Default | InterpreterOptions.LambdaExpressions; // 启用Lambda表达式
var target = new Interpreter(options)
	.SetVariable("x", x);

var results = target.Eval<IEnumerable<string>>("x.Where(str => str.Length > 5).Select(str => str.ToUpper())");
Assert.AreEqual(new[] { "AWESOME" }, results);

请注意，默认情况下解析Lambda表达式是禁用的，因为它会稍微影响性能。要启用它们，您必须设置InterpreterOptions.LambdaExpressions标志。

也可以直接从Lambda表达式创建委托：

var options = InterpreterOptions.Default | InterpreterOptions.LambdaExpressions; // 启用Lambda表达式
var target = new Interpreter(options)
	.SetVariable("increment", 3); // 从Lambda表达式访问变量

var myFunc = target.Eval<Func<int, string, string>>("(i, str) => str.ToUpper() + (i + increment)");
Assert.AreEqual("TEST8", lambda.Invoke(5, "test"));

区分大小写/不区分大小写

默认情况下，所有表达式都区分大小写（VARX与varx不同，就像在C#中一样）。有一个选项可以使用不区分大小写的解析器。例如：

var target = new Interpreter(InterpreterOptions.DefaultCaseInsensitive);

double x = 2;
var parameters = new[] {
	new Parameter("x", x.GetType(), x)
};

Assert.AreEqual(x, target.Eval("x", parameters));
Assert.AreEqual(x, target.Eval("X", parameters));

标识符检测

有时您需要在解析表达式之前检查表达式中使用了哪些标识符（变量、类型、参数）。可能是因为您想验证它，或者您想要求用户输入给定表达式的参数值。因为如果您解析一个没有正确参数的表达式，会抛出异常。

在这些情况下，您可以使用Interpreter.DetectIdentifiers方法获取已使用的标识符列表，包括已知和未知的。

var target = new Interpreter();

var detectedIdentifiers = target.DetectIdentifiers("x + y");

CollectionAssert.AreEqual(new[] { "x", "y" }, 
			  detectedIdentifiers.UnknownIdentifiers.ToArray());

默认数字类型

在C#中，数字通常被解释为整数，或者如果有小数点则解释为双精度浮点数。

在某些情况下，如果没有指定特定后缀，能够配置数字的默认类型可能会很有用：例如在金融计算中，通常数字被解释为decimal类型。

在这些情况下，您可以使用Interpreter.SetDefaultNumberType方法设置默认数字类型。

var target = new Interpreter();

target.SetDefaultNumberType(DefaultNumberType.Decimal);

Assert.IsInstanceOf(typeof(System.Decimal), target.Eval("45"));
Assert.AreEqual(10M/3M, target.Eval("10/3")); // 3.33333333333 而不是 3

限制

并非所有C#语法都受支持。以下是一些不支持的功能示例：

多行表达式
for/foreach/while/do运算符
数组/列表/字典初始化
显式泛型调用（如method<type>(arg)）
Lambda/委托声明（委托和Lambda仅作为变量或参数或表达式的返回类型支持）
数组/列表/字典元素赋值（设置索引器运算符）
其他dynamic对象操作（目前只支持属性、方法调用和索引）

异常

如果在解析过程中出现错误，总是会抛出ParseException类型的异常。 ParseException有几个基于错误类型的专门化类（UnknownIdentifierException、NoApplicableMethodException等）。

性能和多线程

Interpreter类可以被多个线程使用，但不能修改它。本质上只有获取属性、Parse和Eval方法是线程安全的。其他方法（SetVariable、Reference等）必须在初始化阶段调用。 Lambda和Parameter类完全线程安全。

如果您需要多次运行相同的表达式但使用不同的参数，我建议先解析一次，然后多次调用解析后的表达式。

安全性

如果您允许最终用户编写表达式，您必须考虑一些安全隐患。已解析的表达式只能访问您使用 Interpreter.Reference 方法引用的 .NET 类型，或作为变量或参数传递的类型。您必须注意暴露哪些类型。无论如何，生成的委托都会像其他委托一样执行，可以应用标准的 .NET 安全规则（更多信息请参见 .NET Framework 中的安全性）。

如果表达式测试可以直接由用户编写，您必须确保只有某些功能可用。以下是一些指导原则：

例如，您可以禁用赋值运算符，以确保用户不会更改一些您意料之外的值。默认情况下，赋值运算符是启用的，但您可以使用以下方式禁用它：

var target = new Interpreter().EnableAssignment(AssignmentOperators.None);

从 1.3 版本开始，为防止恶意用户在表达式中调用意外的类型或程序集，一些反射方法被阻止。例如，您不能写：

var target = new Interpreter();
target.Eval("typeof(double).GetMethods()");
// 或
target.Eval("typeof(double).Assembly");

这条规则的唯一例外是 Type.Name 属性，出于调试原因允许使用。要启用标准反射功能，您可以使用 Interpreter.EnableReflection 方法，如：

var target = new Interpreter().EnableReflection();

使用场景

以下是 Dynamic Expresso 的一些可能使用场景：

可编程应用程序
允许用户注入自定义规则和逻辑，无需重新编译
评估动态函数或命令
LINQ 动态查询

未来路线图

请查看 GitHub 上的未解决问题和里程碑。

帮助和支持

如果您需要帮助，可以尝试以下方式：

FAQ wiki 页面
GitHub 官方仓库

维护者

目前 Dynamic Expresso 由 @davideicardi 和 @metoule 维护。

致谢

本项目基于两个旧项目：

"Converting String expressions to Funcs with FunctionFactory by Matthew Abbott"（链接不再可用）
DynamicQuery - Dynamic LINQ - Visual Studio 2008 示例：http://msdn.microsoft.com/en-us/vstudio/bb894665.aspx

感谢所有贡献者！

其他资源或类似项目

以下是我评估过或可能有助于学习的一些类似项目列表。由于种种原因，这些项目都不能完全满足我的需求，所以我决定编写自己的解释器。

Roslyn 项目 - Scripting API - https://github.com/dotnet/roslyn/wiki/Scripting-API-Samples
- 这是新的微软官方编译器即服务库。对于复杂场景，我建议考虑使用 Roslyn 而不是 DynamicExpresso。
Mono.CSharp - C# 编译器服务和运行时评估器 - http://docs.go-mono.com/index.aspx?link=N%3AMono.CSharp
NCalc - .NET 数学表达式评估器 - http://ncalc.codeplex.com/
David Wynne CSharpEval https://github.com/DavidWynne/CSharpEval
CSharp Eval http://csharp-eval.com/
C# Expression Evaluator http://csharpeval.codeplex.com/
Jint - .NET 的 Javascript 解释器 - http://jint.codeplex.com/
Jurassic - .NET 的 Javascript 编译器 - http://jurassic.codeplex.com/
Javascrpt.net - javascript V8 引擎 - http://javascriptdotnet.codeplex.com/
CS-Script - http://www.csscript.net/
IronJS, IronRuby, IronPython
paxScript.NET http://eco148-88394.innterhost.net/paxscriptnet/

持续集成

使用 Github Actions 配置了持续集成管道，请参见 .github/workflows 文件夹。

每当创建新的发布版本时，都会发布 Nuget 包。对于快照版本，包只发布到 Github。对于正式发布版本，包会同时发布到 GitHub 和 Nuget。

编译和运行测试

要编译解决方案，您可以运行：

dotnet build DynamicExpresso.sln -c Release

创建 nuget 包：

dotnet pack DynamicExpresso.sln -c Release

运行单元测试：

dotnet test DynamicExpresso.sln -c Release

或者为特定项目使用特定框架运行单元测试：

dotnet test DynamicExpresso.sln --no-restore -c Release --verbosity normal -f netcoreapp3.1

添加 --logger:trx 以生成 VSTS 的测试结果。

发布说明

请参见发布页面。