解释器模式

概述

 

如上图，设计一个软件用来进行加减计算。我们第一想法就是使用工具类，提供对应的加法和减法的工具方法。

//用于两个整数相加
public static int add(int a,int b){
    return a + b;
}

//用于两个整数相加
public static int add(int a,int b,int c){
    return a + b + c;
}

//用于n个整数相加
public static int add(Integer ... arr) {
    int sum = 0;
    for (Integer i : arr) {
        sum += i;
    }
    return sum;
}

上面的形式比较单一、有限，如果形式变化非常多，这就不符合要求，因为加法和减法运算，两个运算符与数值可以有无限种组合方式。比如 1+2+3+4+5、1+2+3-4等等。   

显然，现在需要一种翻译识别机器，能够解析由数字以及 + - 符号构成的合法的运算序列。如果把运算符和数字都看作节点的话，能够逐个节点的进行读取解析运算，这就是解释器模式的思维。

定义：

给定一个语言，定义它的文法表示，并定义一个解释器，这个解释器使用该标识来解释语言中的句子。

在解释器模式中，我们需要将待解决的问题，提取出规则，抽象为一种“语言”。比如加减法运算，规则为：由数值和+-符号组成的合法序列，“1+3-2” 就是这种语言的句子。

解释器就是要解析出来语句的含义。但是如何描述规则呢？

文法（语法）规则：

文法是用于描述语言的语法结构的形式规则。

expression ::= value | plus | minus
plus ::= expression ‘+’ expression   
minus ::= expression ‘-’ expression  
value ::= integer

注意： 这里的符号“::=”表示“定义为”的意思，竖线 | 表示或，左右的其中一个，引号内为字符本身，引号外为语法。

上面规则描述为 ：

表达式可以是一个值，也可以是plus或者minus运算，而plus和minus又是由表达式结合运算符构成，值的类型为整型数。

**抽象语法树：**

在计算机科学中，抽象语法树（AbstractSyntaxTree，AST），或简称语法树（Syntax tree），是源代码语法结构的一种抽象表示。它以树状的形式表现编程语言的语法结构，树上的每个节点都表示源代码中的一种结构。

用树形来表示符合文法规则的句子。

结构

解释器模式包含以下主要角色。

* 抽象表达式（Abstract Expression）角色：定义解释器的接口，约定解释器的解释操作，主要包含解释方法 interpret()。

* 终结符表达式（Terminal  Expression）角色：是抽象表达式的子类，用来实现文法中与终结符相关的操作，文法中的每一个终结符都有一个具体终结表达式与之相对应。
* 非终结符表达式（Nonterminal Expression）角色：也是抽象表达式的子类，用来实现文法中与非终结符相关的操作，文法中的每条规则都对应于一个非终结符表达式。
* 环境（Context）角色：通常包含各个解释器需要的数据或是公共的功能，一般用来传递被所有解释器共享的数据，后面的解释器可以从这里获取这些值。
* 客户端（Client）：主要任务是将需要分析的句子或表达式转换成使用解释器对象描述的抽象语法树，然后调用解释器的解释方法，当然也可以通过环境角色间接访问解释器的解释方法。

案例实现

【例】设计实现加减法的软件

代码如下：

/**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 抽象表达式类
 **/
public abstract class AbstractExpression {
    /**
     * 抽象解释方法
     * @return
     */
    protected abstract int interpreter(Context context);
}

/**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 非终结符表达式，减法表达式
 **/
public class Minus extends AbstractExpression{
    /**
     * 变量表达式
     */
    private AbstractExpression left;
    /**
     * 变量表达式
     */
    private AbstractExpression right;

    public Minus(AbstractExpression left, AbstractExpression right) {
        this.left = left;
        this.right = right;
    }

    /**
     * 执行减法操作
     * @param context
     * @return 执行减号运算符后的值
     */
    @Override
    protected int interpreter(Context context) {
        return left.interpreter(context) - right.interpreter(context);
    }

    @Override
    public String toString() {
        return "(" + left.toString() + "-" + right.toString() + ")" ;
    }
}

/**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 非终结符表达式，加法表达式
 **/
public class Plus extends AbstractExpression{
    /**
     * 变量表达式
     */
    private AbstractExpression left;
    /**
     * 变量表达式
     */
    private AbstractExpression right;

    public Plus(AbstractExpression left, AbstractExpression right) {
        this.left = left;
        this.right = right;
    }

    /**
     * 执行加法操作
     * @param context
     * @return 执行加号运算符后的值
     */
    @Override
    protected int interpreter(Context context) {
        return left.interpreter(context) + right.interpreter(context);
    }

    @Override
    public String toString() {
        return "(" + left.toString() + "+" + right.toString() + ")";
    }
}

**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 终结符角色类 存储值
 **/
public class Value extends AbstractExpression {
    /**
     * 存储数值
     */
    private int value;

    public Value(int value) {
        this.value = value;
    }
    /**
     * 获取当前int值
     */
    @Override
    protected int interpreter(Context context) {
        return this.value;
    }
}

/**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 终结符表达式，变量表达式
 **/
public class Variable extends AbstractExpression {
    /**
     * 变量名称
     */
    private String name;

    public Variable(String name) {
        this.name = name;
    }

    /**
     * 取出变量对应的数值
     * @param context
     * @return int
     */
    @Override
    protected int interpreter(Context context) {
        return context.getValue(this);
    }

    @Override
    public String toString() {
        return name;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Variable variable = (Variable) o;

        return name != null ? name.equals(variable.name) : variable.name == null;
    }

    @Override
    public int hashCode() {
        return name != null ? name.hashCode() : 0;
    }
}

/**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 环境类
 **/
public class Context {
    /**
     * 声明一个map用来存储变量表达式及其对应的值
     */
    private final Map<Variable,Value> map = new HashMap<>();

    /**
     * 存储变量表达式和对应的Value
     * @param var
     * @param value
     */
    public void assign(Variable var,Value value){
        map.put(var,value);
    }

    /**
     * 根据变量表达式取出对应的数值
     * @param var
     * @return int
     */
    public int getValue(Variable var){
        Value value = map.get(var);
        return value.interpreter(this);
    }
}

/**
 * @author: xuzhilei6656
 * @create: 2022-02-17
 * @description: 测试
 **/
public class Client {
    public static void main(String[] args) {
        //创建环境对象
        Context context = new Context();
        //创建变量表达式
        Variable one = new Variable("one");
        Variable two = new Variable("two");
        Variable three = new Variable("three");
        Variable four = new Variable("four");
        Variable five = new Variable("five");
        //存储变量表达式及其对应的值
        context.assign(one,new Value(1));
        context.assign(two,new Value(2));
        context.assign(three,new Value(3));
        context.assign(four,new Value(4));
        context.assign(five,new Value(5));
        //创建运算符对象并执行其解释方法
        int interpreter = new Minus(two, one).interpreter(context);
        System.out.println(interpreter);

        AbstractExpression expression = new Minus(new Plus(new Plus(new Plus(one, two), three), four), five);
        System.out.println("expression"+ ":" + expression.toString() +"="+ expression.interpreter(context));
        
    }
}

测试结果：

优缺点

**1，优点：**

* 易于改变和扩展文法。

  由于在解释器模式中使用类来表示语言的文法规则，因此可以通过继承等机制来改变或扩展文法。每一条文法规则都可以表示为一个类，因此可以方便地实现一个简单的语言。

* 实现文法较为容易。

  在抽象语法树中每一个表达式节点类的实现方式都是相似的，这些类的代码编写都不会特别复杂。

* 增加新的解释表达式较为方便。

  如果用户需要增加新的解释表达式只需要对应增加一个新的终结符表达式或非终结符表达式类，原有表达式类代码无须修改，符合 "开闭原则"。

**2，缺点：**

- 对于复杂文法难以维护。

  在解释器模式中，每一条规则至少需要定义一个类，因此如果一个语言包含太多文法规则，类的个数将会急剧增加，导致系统难以管理和维护。

* 执行效率较低。

  由于在解释器模式中使用了大量的循环和递归调用，因此在解释较为复杂的句子时其速度很慢，而且代码的调试过程也比较麻烦。

使用场景

* 当语言的文法较为简单，且执行效率不是关键问题时。

* 当问题重复出现，且可以用一种简单的语言来进行表达时。

* 当一个语言需要解释执行，并且语言中的句子可以表示为一个抽象语法树的时候。