Golang基于S-expression动态表达式求值插件库evaluator的使用

动态求值表达式是一个常见需求，这就是我们创建这个库的原因。

S-expression

我们使用s-expression语法来解析和求值表达式。

在计算中，s-expressions（符号表达式）是一种用于嵌套列表（树结构）数据的表示法，最初由Lisp编程语言发明并推广，Lisp将其用于源代码和数据。

例如，普通表达式：

(gender = "female")
and
((age % 2) != 0)

对应的s-expression格式为：

(and
  (= gender "female")
  (!=
    (% age 2)
    0
  )
)

表达式中的元素类型

• number
  为了方便，我们将float64、int64等视为number类型。例如，float 100.0等于int 100，但不等于string "100"

• string
  用`、'或"引起来的字符串被视为string类型。您可以通过后面提到的类型转换函数将string类型转换为任何其他定义的类型

• function或variable
  没有引号的字符串被视为function或variable类型，这取决于该函数是否存在。例如在表达式(age birthdate)中，age和birthdate都没有引号。age是函数类型，因为我们注册了一个名为age的函数，而birthdate是变量类型。如果在求值时既没有名为birthdate的参数也没有函数，程序将会报错

使用方法

您可以直接求值：

params := evaluator.MapParams{
    "gender": "female",
}
res, err := evaluator.EvalBool(`(in gender ("female" "male"))`, params)
if err != nil {
    log.Fatal(err)
}
fmt.Println(res)
// 输出: true

或者您可以重用Expression来多次求值：

params := evaluator.MapParams{
    "gender": "female",
}
exp, err := evaluator.New(`(in gender ("female" "male"))`)
if err != nil {
    log.Fatal(err)
}
res, err := exp.EvalBool(params)
if err != nil {
    log.Fatal(err)
}
fmt.Println(res)
// 输出: true

您可以这样写表达式

• (in gender ("male", "female"))
• (between now (td_time "2017-01-02 12:00:00") (td_time "2017-12-02 12:00:00"))
• (ne (mod (age birthdate) 7) 5)
• 或者为了清晰使用多行：

(and
    (ne os "ios")
    (eq gender "male")
    (beteen version (t_version "2.7.1") (t_version "2.9.1"))
)

函数

已实现的函数

注意：表达式中可以使用操作符或函数

如何使用自定义函数

您可以按照以下步骤编写自己的函数：

1. 实现您的函数
2. 注册到函数中
3. 使用它

下面是一个示例：

package main

import (
    "errors"
    "log"
    "time"

    "github.com/nullne/evaluator"
    "github.com/nullne/evaluator/function"
)

// 定义您自己的函数并不要忘记注册
func age(params ...interface{}) (interface{}, error) {
    if len(params) != 1 {
        return nil, errors.New("only one params accepted")
    }
    birth, ok := params[0].(string)
    if !ok {
        return nil, errors.New("birth format need to be string")
    }
    r, err := time.Parse("2006-01-02", birth)
    if err != nil {
        return nil, err
    }
    now := time.Now()
    a := r.Year() - now.Year()
    if r.Month() < now.Month() {
        a--
    } else if r.Month() == now.Month() {
        if r.Day() < now.Day() {
            a--
        }
    }
    return a, nil
}

func main() {
    if err := function.Regist("age", age); err != nil {
        log.Print(err)
    }

    exp := `(not (between (age birthdate) 18 20))`
    vvf := evaluator.MapParams{
        "birthdate": "1980-02-01",
    }
    e, err := evaluator.New(exp)
    if err != nil {
        log.Print(err)
    }
    r, err := e.Eval(vvf)
    if err != nil {
        log.Print(err)
    }
    log.Printf("expression: `%s`, wanna: %+v, got: %+v\r", exp, true, r)
}

参数

• Params 接口，有一个名为Get的方法来获取所有需要的参数
• MapParams 一个简单的map实现的Params

性能测试

BenchmarkEqualString-8     3000000     473 ns/op
BenchmarkInString-8        2000000     916 ns/op
BenchmarkBetweenInt-8      3000000     467 ns/op
BenchmarkBetweenTime-8     1000000    2089 ns/op
BenchmarkOverlapInt-8       500000    2966 ns/op
BenchmarkTypeTime-8        2000000     638 ns/op
BenchmarkTypeVersion-8     3000000     539 ns/op

测试环境：MacBook Pro (Retina, 15-inch, Mid 2015), 内存: 16 GB 1600 MHz DDR3, 处理器: 2.2 GHz Intel Core i7