Go 表达式求值器

概述示例：表达式求值器 本篇将创建简单算术表达式的一个求值器。 定义接口和类型 开始，先确定要使用一个接口 Expr 来代表这种语言的任意一个表达式。暂时没有任何方法，稍后再逐个添加： // Expr: 算术表达式type Expr interface{} 我们的表达式语言将包括以下符号： 浮点数字面量 二元 *** 作符：加减乘除（+、-、*、\/） 一元 *** 作符：表示正数和负数的 -x 和 +x 函数调用 示例：表达式求值器

本篇将创建简单算术表达式的一个求值器。

定义接口和类型

开始，先确定要使用一个接口 Expr 来代表这种语言的任意一个表达式。暂时没有任何方法，稍后再逐个添加：

// Expr: 算术表达式type Expr interface{}

我们的表达式语言将包括以下符号：

浮点数字面量 二元 *** 作符：加减乘除（+、-、*、\/） 一元 *** 作符：表示正数和负数的 -x 和 +x 函数调用：pow(x,y)、sin(x) 和 sqrt(x) 变量：比如 x、pi，自己定义一个变量名称，每次可以提供不用的值

还要有标准的 *** 作符优先级，以及小括号。所有的值都是 float64 类型。

下面是几个示例表达式：

sqrt(A / pi)pow(x,3) + pow(y,3)(F - 32) * 5 / 9

下面5种具体类型代表特定类型的表达式：

Var ： 代表变量引用。这个类型是可导出的，至于为什么，后面会讲明 literal ： 代表浮点数常量 unary ： 代表有一个 *** 作数的 *** 作符表达式， *** 作数可以是任意的 Expr binary ： 代表有两个 *** 作数的 *** 作符表达式， *** 作数可以是任意的 Expr call ： 代表函数调用，这里限制它的 fn 字段只能是 pow、sin、sqrt

为了要计算包含变量的表达式，还需要一个上下文（environment）来把变量映射到数值。所有接口和类型的定义如下：

package eval// Expr: 算术表达式type Expr interface {    // 返回表达式在 env 上下文下的值    Eval(env Env) float64    // Check 方法报告表达式中的错误，并把表达式中的变量加入 Vars 中    Check(vars map[Var]bool) error}// Var 表示一个变量，比如：x.type Var string// Env 变量到数值的映射关系type Env map[Var]float64// literal 是一个数字常量，比如：3.1415926type literal float64// unary 表示一元 *** 作符表达式，比如：-xtype unary struct {    op rune // one of ‘+‘,‘-‘    x  Expr}// binary 表示二元 *** 作符表达式，比如：x+y.type binary struct {    op   rune // one of ‘+‘,‘-‘,‘*‘,‘/‘    x,y Expr}// call 表示函数调用表达式，比如：sin(x).type call struct {    fn   string // one of "pow","sin","sqrt"    args []Expr}

在定义好各种类型后，发现每个类型都需要提供一个 Eval 方法，于是加把这个方法加到接口中，已经添加到上面的代码中了。
这个包只导出了 Expr、Var、Env。客户端可以在不接触其他表达式类型的情况下使用这个求值器。

定义方法

接下来实现每个类型的 Eval 方法来满足接口：

Var 的 Eval 方法从上下文中查询结果，如果变量不存在，则会返回0。 literal 的 Eval 方法直接返回本身的值。 unbary 的 Eval 方法首先对 *** 作数递归求值，然后应用 op *** 作符。 binary 的 Eval 方法的处理逻辑和 unbary 一样。 call 的 Eval 方法先对 pow、sin、sqrt 函数的参数求值，再调用 math 包中的对应函数。

package evalimport (    "fmt"    "math")func (v Var) Eval(env Env) float64 {    return env[v] // 如果查询不到变量名，则返回类型的零值，就是0}func (l literal) Eval(_ Env) float64 {    return float64(l)}func (u unary) Eval(env Env) float64 {    switch u.op {    case ‘+‘:        return +u.x.Eval(env)    case ‘-‘:        return -u.x.Eval(env)    }    panic(fmt.Sprintf("unsupported unary operator: %q",u.op))}func (b binary) Eval(env Env) float64 {    switch b.op {    case ‘+‘:        return b.x.Eval(env) + b.y.Eval(env)    case ‘-‘:        return b.x.Eval(env) - b.y.Eval(env)    case ‘*‘:        return b.x.Eval(env) * b.y.Eval(env)    case ‘/‘:        return b.x.Eval(env) / b.y.Eval(env)    }    panic(fmt.Sprintf("unsupported binary operator: %q",b.op))}func (c call) Eval(env Env) float64 {    switch c.fn {    case "pow":        return math.Pow(c.args[0].Eval(env),c.args[1].Eval(env))    case "sin":        return math.Sin(c.args[0].Eval(env))    case "sqrt":        return math.Sqrt(c.args[0].Eval(env))    }    panic(fmt.Sprintf("unsupported function call: %s",c.fn))}

某些方法可能会失败，有些错误会导致 Eval 崩溃，还有些会导致返回不正确的结果。所有这些错误可以在求值之前做检查来发现，所以还需要一个Check方法。不过暂时可以先不管Check方法，而是把 Eval 方法用起来，并通过测试进行验证。

Parse函数

要验证 Eval 方法，首先需要得到对象，然后调用对像的 Eval 方法。而对象需要通过解析字符串来获取，这就需要一个 Parse 函数。

text/scanner 包的使用
词法分析器 lexer 使用 text/scanner 包提供的扫描器 Scanner 类型来把输入流分解成一系列的标记（token），包括注释、标识符、字符串字面量和数字字面量。扫描器的 Scan 方法将提前扫描并返回下一个标记（类型为 rune）。大部分标记（比如‘(‘）都只包含单个rune，但 text/scanner 包也可以支持由多个字符组成的记号。调用 Scan 会返回标记的类型，调用 TokenText 则会返回标记的文本。
因为每个解析器可能需要多次使用当前的记号，但是 Scan 会一直向前扫描，所以把扫描器封装到一个 lexer 辅助类型中，其中保存了 Scan 最近返回的标记。下面是一个简单的用法示例：

package mainimport (    "fmt"    "os"    "strings"    "text/scanner")type lexer struct {    scan  scanner.Scanner    token rune // 当前标记}func (lex *lexer) next()        { lex.token = lex.scan.Scan() }func (lex *lexer) text() string { return lex.scan.TokenText() }// consume 方法并没有被使用到，包括后面的Pause函数// 不过这是一个可复用的处理逻辑func (lex *lexer) consume(want rune) {    if lex.token != want { // 注意: 错误处理不是这篇的重点，简单粗暴的处理了        panic(fmt.Sprintf("got %q,want %q",lex.text(),want))    }    lex.next()}func main() {    for _,input := range os.Args[1:] {        lex := new(lexer)        lex.scan.Init(strings.NewReader(input))        lex.scan.Mode = scanner.ScanIDents | scanner.ScanInts | scanner.Scanfloats        fmt.Println(input,":")        lex.next()        for lex.token != scanner.EOF {            fmt.Println("\t",scanner.TokenString(lex.token),lex.text())            lex.next()        }    }}

执行效果如下：

PS G:\Steed\documents\Go\src\localdemo\parse> go run main.go "sqrt(A / pi)" "pow(x,3)" "(F - 32) * 5 / 9"sqrt(A / pi) :         IDent sqrt         "(" (         IDent A         "/" /         IDent pi         ")" )pow(x,3) :         IDent pow         "(" (         IDent x         ",",Int 3         ")" )         "+" +         IDent pow         "(" (         IDent y         ",Int 3         ")" )(F - 32) * 5 / 9 :         "(" (         IDent F         "-" -         Int 32         ")" )         "*" *         Int 5         "/" /         Int 9PS G:\Steed\documents\Go\src\localdemo\parse>

Parse 函数
Parse 函数，递归地将字符串解析为表达式，下面是完整的代码：

package evalimport (    "fmt"    "strconv"    "strings"    "text/scanner")type lexer struct {    scan  scanner.Scanner    token rune // 当前标记}func (lex *lexer) next()        { lex.token = lex.scan.Scan() }func (lex *lexer) text() string { return lex.scan.TokenText() }type lexPanic string// describe 返回一个描述当前标记的字符串，用于错误处理func (lex *lexer) describe() string {    switch lex.token {    case scanner.EOF:        return "end of file"    case scanner.IDent:        return fmt.Sprintf("IDentifIEr %s",lex.text())    case scanner.Int,scanner.float:        return fmt.Sprintf("number %s",lex.text())    }    return fmt.Sprintf("%q",rune(lex.token)) // any other rune}func precedence(op rune) int {    switch op {    case ‘*‘,‘/‘:        return 2    case ‘+‘,‘-‘:        return 1    }    return 0}// Parse 将字符串解析为表达式////   expr = num                         a literal number,e.g.,3.14159//        | ID                          a variable name,x//        | ID ‘(‘ expr ‘,‘ ... ‘)‘     a function call//        | ‘-‘ expr                    a unary operator (+-)//        | expr ‘+‘ expr               a binary operator (+-*/)//func Parse(input string) (_ Expr,err error) {    defer func() {        // 选择性地使用 recover        // 已经将 panic value 设置成特殊类型 lexPanic        // 在 recover 时对 panic value 进行检查        switch x := recover().(type) {        case nil:            // no panic        case lexPanic:            // 如果发现 panic value 是特殊类型，就将这个 panic 作为 errror 处理            err = fmt.Errorf("%s",x)        default:            // 如果不是，则按照正常的 panic 进行处理            panic(x)        }    }()    lex := new(lexer)    lex.scan.Init(strings.NewReader(input))    lex.scan.Mode = scanner.ScanIDents | scanner.ScanInts | scanner.Scanfloats    lex.next() // 获取第一个标记    e := parseExpr(lex)    if lex.token != scanner.EOF {        return nil,fmt.Errorf("unexpected %s",lex.describe())    }    return e,nil}func parseExpr(lex *lexer) Expr { return parseBinary(lex,1) }// binary = unary (‘+‘ binary)*// parseBinary 遇到优先级低于 prec1 的运算符时就停止// 这个递归处理计算优先级的循环策略比较难理解func parseBinary(lex *lexer,prec1 int) Expr {    lhs := parseUnary(lex)    for prec := precedence(lex.token); prec >= prec1; prec-- {        for precedence(lex.token) == prec {            op := lex.token            lex.next() // consume operator            rhs := parseBinary(lex,prec+1) // 优先级加1，进入下一次递归            lhs = binary{op,lhs,rhs}        }    }    return lhs}// unary = ‘+‘ expr | primaryfunc parseUnary(lex *lexer) Expr {    if lex.token == ‘+‘ || lex.token == ‘-‘ {        op := lex.token        lex.next() // consume ‘+‘ or ‘-‘        return unary{op,parseUnary(lex)}    }    return parsePrimary(lex)}// primary = ID//         | ID ‘(‘ expr ‘,‘ ... ‘,‘ expr ‘)‘//         | num//         | ‘(‘ expr ‘)‘func parsePrimary(lex *lexer) Expr {    switch lex.token {    case scanner.IDent:        ID := lex.text()        lex.next() // consume IDent        if lex.token != ‘(‘ {            return Var(ID)        }        lex.next() // consume ‘(‘        var args []Expr        if lex.token != ‘)‘ {            for {                args = append(args,parseExpr(lex))                if lex.token != ‘,‘ {                    break                }                lex.next() // consume ‘,‘            }            if lex.token != ‘)‘ {                msg := fmt.Sprintf("got %q,want ‘)‘",lex.token)                panic(lexPanic(msg))            }        }        lex.next() // consume ‘)‘        return call{ID,args}    case scanner.Int,scanner.float:        f,err := strconv.Parsefloat(lex.text(),64)        if err != nil {            panic(lexPanic(err.Error()))        }        lex.next() // consume number        return literal(f)    case ‘(‘:        lex.next() // consume ‘(‘        e := parseExpr(lex)        if lex.token != ‘)‘ {            msg := fmt.Sprintf("got %s,lex.describe())            panic(lexPanic(msg))        }        lex.next() // consume ‘)‘        return e    }    msg := fmt.Sprintf("unexpected %s",lex.describe())    panic(lexPanic(msg))}

整体的逻辑都比较难理解。parseBinary 函数是负责解析二元表达式的，其中包括了对运算符优先级的处理（逻辑比较难懂，自己想不出来，看也没完全看懂，以后有类似的实现或许可以借鉴）。

测试函数

下面的 TestEval 函数用于测试求值器，它使用 testing 包，使用基于表的测试方式。表格中定义了三个表达式并为每个表达式准备了不同的上下文。第一个表达式用于根据圆面积A求半径，第二个用于计算两个变量x和y的立方和，第三个把华氏温度F转为摄氏温度：

package evalimport (    "fmt"    "math"    "testing")func TestEval(t *testing.T) {    tests := []struct {        expr string        env  Env        want string    }{        {"sqrt(A / pi)",Env{"A": 87616,"pi": math.Pi},"167"},{"pow(x,3)",Env{"x": 12,"y": 1},"1729"},Env{"x": 9,"y": 10},{"5 / 9 * (F - 32)",Env{"F": -40},"-40"},Env{"F": 32},"0"},Env{"F": 212},"100"},}    var prevExpr string    for _,test := range tests {        // 仅在表达式变更时才输出        if test.expr != prevExpr {            fmt.Printf("\n%s\n",test.expr)            prevExpr = test.expr        }        expr,err := Parse(test.expr)        if err != nil {            t.Error(err) // 解析出错            continue        }        got := fmt.Sprintf("%.6g",expr.Eval(test.env))        fmt.Printf("\t%v => %s\n",test.env,got)        if got != test.want {            t.Errorf("%s.Eval() in %v = %q,want %q\n",test.expr,got,test.want)        }    }}

对于表格中的每一行记录，先解析表达式，在上下文中求值，再输出表达式。启用 -v 选项查看测试的输出：

PS G:\Steed\documents\Go\src\gopl\output\Expression_evaluator\eval> go test -v=== RUN   TestEvalsqrt(A / pi)        map[A:87616 pi:3.141592653589793] => 167pow(x,3)        map[x:12 y:1] => 1729        map[x:9 y:10] => 17295 / 9 * (F - 32)        map[F:-40] => -40        map[F:32] => 0        map[F:212] => 100--- PASS: TestEval (0.00s)PASSok      gopl/output/Expression_evaluator/eval   0.329sPS G:\Steed\documents\Go\src\gopl\output\Expression_evaluator\eval>

check 方法

到目前为止，所有的输入都是合法的，但是并不是总能如此。即使在解释性语言中，通过语法检查来发现静态错误（即不用运行程序也能检测出来的错误）也是很常见的。通过分离静态检查和动态检查，可以更快发现错误，也可以只在运行前检查一次，而不用在表达式求值时每次都检查。
现在就给 Expr 加上一个 Check 方法，用于在表达式语法树上检查静态错误。这个 Check 方法有一个 vars 参数，并不是因为需要传参，而是为了让递归调用的实现起来更方便，具体看后面的代码和说明：

// Expr: 算术表达式type Expr interface {    // 返回表达式在 env 上下文下的值    Eval(env Env) float64    // Check 方法报告表达式中的错误，并把表达式中的变量加入 Vars 中    Check(vars map[Var]bool) error}

具体的 Check 方法如下所示。literal 和 Var 的求值不可能出错，所以直接返回 nil。unary 和 binary 的方法首先检查 *** 作符是否合法，再递归地检查 *** 作数。类似地，call 的方法首先检查函数是否是已知的，然后检查参数个数，最后递归地检查每个参数：

package evalimport (    "fmt"    "strings")func (v Var) Check(vars map[Var]bool) error {    vars[v] = true    return nil}func (literal) Check(vars map[Var]bool) error {    return nil}func (u unary) Check(vars map[Var]bool) error {    if !strings.ContainsRune("+-",u.op) {        return fmt.Errorf("unexpected unary op %q",u.op)    }    return u.x.Check(vars)}func (b binary) Check(vars map[Var]bool) error {    if !strings.ContainsRune("+-*/",b.op) {        return fmt.Errorf("unexpected binary op %q",b.op)    }    if err := b.x.Check(vars); err != nil {        return err    }    return b.y.Check(vars)}func (c call) Check(vars map[Var]bool) error {    arity,ok := numParams[c.fn]    if !ok {        return fmt.Errorf("unkNown function %q",c.fn)    }    if len(c.args) != arity {        return fmt.Errorf("call to %s has %d args,want %d",c.fn,len(c.args),arity)    }    for _,arg := range c.args {        if err := arg.Check(vars); err != nil {            return err        }    }    return nil}// 已知的函数名称和对应的参数个数var numParams = map[string]int{"pow": 2,"sin": 1,"sqrt": 1}

关于递归的实现。Check 的输入参数是一个 Var 集合，这个集合是表达式中的变量名。要让表达式能成功求值，上下文必须包含所有的变量。从逻辑上来讲，这个集合应当是 Check 的输出结果而不是输入参数，但因为这个方法是递归调用的，在这种情况下使用参数更为方便。调用方最初调用时需要提供一个空的集合。

Web 应用

这篇里已经有一个绘制函数 z=f(x,y) 的 SVG 图形的实现了：
https://blog.51cto.com/steed/2356431
不过当时的函数 f 是在编译的时候指定的。既然这里可以对字符串形式的表达式进行解析、检查和求值，那么就可以构建一个 Web 应用，在运行时从客户端接收一个表达式，并绘制函数的曲面图。可以使用 vars 集合来检查表达式是否是一个只有两个变量x、y的函数（为了简单起见，还提供了半径r，所以实际上是3个变量）。使用 Check 方法来拒绝掉不规范的表达式，这样就不会在下面函数的40000个计算过程中（100x100的格子，每一个有4个角）重复这些检查。
表达式求值器已经完成了，把它作为一个包引入。然后把绘制函数图形加上 Web 应用的代码重新实现一遍，完整的代码如下：

package mainimport (    "fmt"    "io"    "log"    "math"    "net/http")import "gopl/output/Expression_evaluator/eval"const (    wIDth,height = 600,320            // canvas size in pixels    cells         = 100                 // number of grID cells    xyrange       = 30.0                // x,y axis range (-xyrange..+xyrange)    xyscale       = wIDth / 2 / xyrange // pixels per x or y unit    zscale        = height * 0.4        // pixels per z unit)var sin30,cos30 = 0.5,math.Sqrt(3.0 / 4.0) // sin(30°),cos(30°)func corner(f func(x,y float64) float64,i,j int) (float64,float64) {    // find point (x,y) at corner of cell (i,j)    x := xyrange * (float64(i)/cells - 0.5)    y := xyrange * (float64(j)/cells - 0.5)    z := f(x,y) // compute surface height z    // project (x,y,z) isometrically onto 2-D SVG canvas (sx,sy)    sx := wIDth/2 + (x-y)*cos30*xyscale    sy := height/2 + (x+y)*sin30*xyscale - z*zscale    return sx,sy}func surface(w io.Writer,f func(x,y float64) float64) {    fmt.Fprintf(w,"<svg xmlns=‘http://www.w3.org/2000/svg‘ "+        "style=‘stroke: grey; fill: white; stroke-wIDth: 0.7‘ "+        "wIDth=‘%d‘ height=‘%d‘>",wIDth,height)    for i := 0; i < cells; i++ {        for j := 0; j < cells; j++ {            ax,ay := corner(f,i+1,j)            bx,by := corner(f,j)            cx,cy := corner(f,j+1)            dx,dy := corner(f,j+1)            fmt.Fprintf(w,"<polygon points=‘%g,%g %g,%g‘/>\n",ax,ay,bx,by,cx,cy,dx,dy)        }    }    fmt.Fprintln(w,"</svg>")}// 组合了解析（Parse方法）和检查（Check方法）步骤func parseAndCheck(s string) (eval.Expr,error) {    if s == "" {        return nil,fmt.Errorf("empty Expression")    }    expr,err := eval.Parse(s)    if err != nil {        return nil,err    }    vars := make(map[eval.Var]bool)    if err := expr.Check(vars); err != nil {        return nil,err    }    for v := range vars {        if v != "x" && v != "y" && v != "r" {            return nil,fmt.Errorf("undefined variable: %s",v)        }    }    return expr,nil}// 解析并检查Get请求的表达式，用它来创建一个有两个变量的匿名函数。// 这个匿名函数与曲面绘制程序中的f有同样的签名。func plot(w http.ResponseWriter,r *http.Request) {    r.ParseForm()    expr,err := parseAndCheck(r.Form.Get("expr"))    if err != nil {        http.Error(w,"bad expr: "+err.Error(),http.StatusBadRequest)        return    }    w.header().Set("Content-Type","image/svg+xml")    surface(w,func(x,y float64) float64 {        r := math.Hypot(x,y) // distance from (0,0)        return expr.Eval(eval.Env{"x": x,"y": y,"r": r})    })}func main() {    fmt.Println("http://localhost:8000/plot?expr=sin(-x)*pow(1.5,-r)")    fmt.Println("http://localhost:8000/plot?expr=pow(2,sin(y))*pow(2,sin(x))/12")    fmt.Println("http://localhost:8000/plot?expr=sin(x*y/10)/10")    http.HandleFunc("/plot",plot)    log.Fatal(http.ListenAndServe("localhost:8000",nil))}

重点看 parseAndCheck 函数，组合了解析和检查的步骤。 还有 plot 函数，函数的签名与 http.HandlerFunc 类似。解析并检查 http 请求中的表达式，并用它来创建一个有两个变量的匿名函数。这个匿名函数与原始曲面绘制程序中的 f 有同样的签名，并且能对用户提供的表达式进行求值。上下文定义了x、y和半径r。最后，plot 调用了 surface 函数，这里略做了修改，原本直接使用函数 f，现在把函数 f 作为参数传入。

总结

以上是内存溢出为你收集整理的Go 表达式求值器全部内容，希望文章能够帮你解决Go 表达式求值器所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。