Expr语言自定义函数开发指南

Expr语言自定义函数开发指南

expr Expression language and expression evaluation for Go 项目地址: https://gitcode.com/gh_mirrors/ex/expr

Expr语言作为一种表达式求值引擎，提供了灵活的函数定义机制，开发者可以根据需求创建各种自定义函数。本文将全面介绍在Expr中定义和使用自定义函数的几种主要方式。

环境变量方式定义函数

最简单直接的方式是通过环境变量(map)来定义函数：

env := map[string]any{
    "add": func(a, b int) int {
        return a + b
    },
}

这种方式适合快速定义简单的工具函数，函数签名可以是任意Go支持的格式。当表达式调用add(1, 2)时，会直接调用这个匿名函数。

结构体方法定义函数

对于更复杂的场景，可以将函数定义为结构体的方法：

type MathEnv struct{}

func (MathEnv) Add(a, b int) int {
    return a + b
}

这种方式适合将相关函数组织在一起，形成逻辑分组。使用时需要创建结构体实例并传入环境。

性能优化：使用Function选项

对于性能敏感的场景，推荐使用expr.Function选项来定义函数：

atoi := expr.Function(
    "atoi",
    func(params ...any) (any, error) {
        return strconv.Atoi(params[0].(string))
    },
    strconv.Atoi,  // 类型签名
)

这种方式相比前两种有更好的性能表现，因为Expr编译器可以基于类型签名进行优化。

类型签名的重要性

类型签名让Expr的类型检查器了解函数的输入输出类型，这对编译时优化和错误检查都很关键。我们可以通过三种方式指定类型签名：

1. 直接使用现有函数作为签名：

strconv.Atoi

2. 使用函数类型定义：

new(func(string) int)

3. 定义多个重载签名：

new(func(float64) int),
new(func(string) int),

编译时常量函数

对于纯函数(输出仅依赖于输入且无副作用)，可以标记为编译时常量：

// 假设Add函数被标记为ConstExpr
program, err := expr.Compile(`add(1, 2)`, expr.ConstExpr("add"))

这类函数会在编译时就被求值，可以提升运行时性能。适合数学计算等确定性操作。

最佳实践建议

1. 简单场景使用环境变量方式，复杂逻辑考虑结构体方法
2. 高频调用函数使用Function选项定义
3. 为Function选项提供准确的类型签名
4. 纯函数标记为编译时常量
5. 相关函数按功能组织成结构体方法
6. 处理错误时返回error类型

通过合理使用这些函数定义方式，可以在Expr中构建出既灵活又高效的表达式求值环境。

expr Expression language and expression evaluation for Go 项目地址: https://gitcode.com/gh_mirrors/ex/expr