《JAVA与模式》之解释器模式

在阎宏博士的《JAVA与模式》一书中开头是这样描述解释器（Interpreter）模式的：

解释器模式是类的行为模式。给定一个语言之后，解释器模式可以定义出其文法的一种表示，并同时提供一个解释器。客户端可以使用这个解释器来解释这个语言中的句子。

解释器模式的结构

下面就以一个示意性的系统为例，讨论解释器模式的结构。系统的结构图如下所示：

模式所涉及的角色如下所示：

1. 抽象表达式(Expression)角色：声明一个所有的具体表达式角色都需要实现的抽象接口。这个接口主要是一个interpret()方法，称做解释操作。

2. 终结符表达式(Terminal Expression)角色：实现了抽象表达式角色所要求的接口，主要是一个interpret()方法；文法中的每一个终结符都有一个具体终结表达式与之相对应。比如有一个简单的公式R=R1+R2，在里面R1和R2就是终结符，对应的解析R1和R2的解释器就是终结符表达式。

3. 非终结符表达式(Nonterminal Expression)角色：文法中的每一条规则都需要一个具体的非终结符表达式，非终结符表达式一般是文法中的运算符或者其他关键字，比如公式R=R1+R2中，“+"就是非终结符，解析“+”的解释器就是一个非终结符表达式。

4. 环境(Context)角色：这个角色的任务一般是用来存放文法中各个终结符所对应的具体值，比如R=R1+R2，我们给R1赋值100，给R2赋值200。这些信息需要存放到环境角色中，很多情况下我们使用Map来充当环境角色就足够了。

为了说明解释器模式的实现办法，这里给出一个最简单的文法和对应的解释器模式的实现，这就是模拟Java语言中对布尔表达式进行操作和求值。

在这个语言中终结符是布尔变量，也就是常量true和false。非终结符表达式包含运算符and，or和not等布尔表达式。这个简单的文法如下：

解释器模式的结构图如下所示：

源代码

抽象表达式角色

 1public abstract class Expression {
 2    /**
 3     * 以环境为准，本方法解释给定的任何一个表达式
 4     */
 5    public abstract boolean interpret(Context ctx);
 6    /**
 7     * 检验两个表达式在结构上是否相同
 8     */
 9    public abstract boolean equals(Object obj);
10    /**
11     * 返回表达式的hash code
12     */
13    public abstract int hashCode();
14    /**
15     * 将表达式转换成字符串
16     */
17    public abstract String toString();
18}

一个Constant对象代表一个布尔常量

 1public class Constant extends Expression{
 2
 3    private boolean value;
 4
 5    public Constant(boolean value){
 6        this.value = value;
 7    }
 8
 9    @Override
10    public boolean equals(Object obj) {
11
12        if(obj != null && obj instanceof Constant){
13            return this.value == ((Constant)obj).value;
14        }
15        return false;
16    }
17
18    @Override
19    public int hashCode() {
20        return this.toString().hashCode();
21    }
22
23    @Override
24    public boolean interpret(Context ctx) {
25
26        return value;
27    }
28
29    @Override
30    public String toString() {
31        return new Boolean(value).toString();
32    }
33
34}

一个Variable对象代表一个有名变量

 1public class Variable extends Expression {
 2
 3    private String name;
 4
 5    public Variable(String name){
 6        this.name = name;
 7    }
 8    @Override
 9    public boolean equals(Object obj) {
10
11        if(obj != null && obj instanceof Variable)
12        {
13            return this.name.equals(
14                    ((Variable)obj).name);
15        }
16        return false;
17    }
18
19    @Override
20    public int hashCode() {
21        return this.toString().hashCode();
22    }
23
24    @Override
25    public String toString() {
26        return name;
27    }
28
29    @Override
30    public boolean interpret(Context ctx) {
31        return ctx.lookup(this);
32    }
33
34}

代表逻辑“与”操作的And类，表示由两个布尔表达式通过逻辑“与”操作给出一个新的布尔表达式的操作

 1public class And extends Expression {
 2
 3    private Expression left,right;
 4
 5    public And(Expression left , Expression right){
 6        this.left = left;
 7        this.right = right;
 8    }
 9    @Override
10    public boolean equals(Object obj) {
11        if(obj != null && obj instanceof And)
12        {
13            return left.equals(((And)obj).left) &&
14                right.equals(((And)obj).right);
15        }
16        return false;
17    }
18
19    @Override
20    public int hashCode() {
21        return this.toString().hashCode();
22    }
23
24    @Override
25    public boolean interpret(Context ctx) {
26
27        return left.interpret(ctx) && right.interpret(ctx);
28    }
29
30    @Override
31    public String toString() {
32        return "(" + left.toString() + " AND " + right.toString() + ")";
33    }
34
35}

代表逻辑“或”操作的Or类，代表由两个布尔表达式通过逻辑“或”操作给出一个新的布尔表达式的操作

 1public class Or extends Expression {
 2    private Expression left,right;
 3
 4    public Or(Expression left , Expression right){
 5        this.left = left;
 6        this.right = right;
 7    }
 8    @Override
 9    public boolean equals(Object obj) {
10        if(obj != null && obj instanceof Or)
11        {
12            return this.left.equals(((Or)obj).left) && this.right.equals(((Or)obj).right);
13        }
14        return false;
15    }
16
17    @Override
18    public int hashCode() {
19        return this.toString().hashCode();
20    }
21
22    @Override
23    public boolean interpret(Context ctx) {
24        return left.interpret(ctx) || right.interpret(ctx);
25    }
26
27    @Override
28    public String toString() {
29        return "(" + left.toString() + " OR " + right.toString() + ")";
30    }
31
32}

代表逻辑“非”操作的Not类，代表由一个布尔表达式通过逻辑“非”操作给出一个新的布尔表达式的操作

 1public class Not extends Expression {
 2
 3    private Expression exp;
 4
 5    public Not(Expression exp){
 6        this.exp = exp;
 7    }
 8    @Override
 9    public boolean equals(Object obj) {
10        if(obj != null && obj instanceof Not)
11        {
12            return exp.equals(
13                    ((Not)obj).exp);
14        }
15        return false;
16    }
17
18    @Override
19    public int hashCode() {
20        return this.toString().hashCode();
21    }
22
23    @Override
24    public boolean interpret(Context ctx) {
25        return !exp.interpret(ctx);
26    }
27
28    @Override
29    public String toString() {
30        return "(Not " + exp.toString() + ")";
31    }
32
33}

环境(Context)类定义出从变量到布尔值的一个映射

 1public class Context {
 2
 3    private Map<Variable,Boolean> map = new HashMap<Variable,Boolean>();
 4
 5    public void assign(Variable var , boolean value){
 6        map.put(var, new Boolean(value));
 7    }
 8
 9    public boolean lookup(Variable var) throws IllegalArgumentException{
10        Boolean value = map.get(var);
11        if(value == null){
12            throw new IllegalArgumentException();
13        }
14        return value.booleanValue();
15    }
16}

客户端类

 1public class Client {
 2
 3    public static void main(String[] args) {
 4        Context ctx = new Context();
 5        Variable x = new Variable("x");
 6        Variable y = new Variable("y");
 7        Constant c = new Constant(true);
 8        ctx.assign(x, false);
 9        ctx.assign(y, true);
10
11        Expression exp = new Or(new And(c,x) , new And(y,new Not(x)));
12        System.out.println("x=" + x.interpret(ctx));
13        System.out.println("y=" + y.interpret(ctx));
14        System.out.println(exp.toString() + "=" + exp.interpret(ctx));
15    }
16
17}

运行结果如下：