设计模式-解析器模式

定义

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

适用性

最典型的应用就是正则表达式

重复发生的问题可以使用解释器模式：比如根据用户输入的公式进行加减乘除四则运算，但是他们输入的公式每次都不同，有时是a+b-c*d，有时是a*b+c-d，等等等等个，公式千变万化，但是都是由加减乘除四个非终结符来连接的，这时我们就可以使用解释器模式。

当有一个语言需要解释执行，并且你可以把该语言中的句子表示为一个抽象的语法树时，可使用解释器模式．而当存在以下情况时，该模式的效果最好：

1、该文法简单，对于复杂的文法，文法的类层次变得庞大而无法管理．此时，语法分析程序生成器这样得工具时更好得选择。它们无需构建抽象语法树即可解释表达式，这样可以节省空间而且还可以节省时间；

2、效率不是一个关键的问题，最高效的解释器通常不是通过直接解释语法分析树实现的，而是首先把他们转换成另外一种形式．例如：正则表达式通常被转换成状态机。但即使在这种情况下，转换器仍可用解释器模式实现，该模式仍是有用的．

模式中的角色

1.AbstractExpression(抽象表达式) 声明一个抽象的解释操作，这个接口为抽象语法树中所有的节点所共享。

2.TerminalExpression(终结符表达式) 实现与文法中的终结符相关联的解释操作。 一个句子中的每个终结符需要该类的一个实例。

3.NonterminalExpression(非终结符表达式) 为文法中的非终结符实现解释(Interpret)操作。

4.Context（上下文） 包含解释器之外的一些全局信息。

5.Client（客户） 构建(或被给定)表示该文法定义的语言中一个特定的句子的抽象语法树。 该抽象语法树由NonterminalExpression和TerminalExpression的实例装配而成。 调用解释操作。

角色关系UML

---

以加减运算为例子

UML图如下:

java代码:

抽象表达式:

package demo;

import java.util.Map;

/**
 * 
 * @ClassName: Expression
 * @Description:抽象表达式
 * @author cheng
 * @date 2017-8-30 下午03:03:53
 */
public interface Expression {
    /**
     * 解析公式和数值，其中var中的key是公式的参数，value值是具体的数字
     * 负责对传递进来的参数和值进行解析和匹配，其中key是表达式a+b+c中的a、b、c，value是运算时取得的值
     * 
     * 如果是终结符表达式，那么此方法将获取参数的值 
     * 如果是非终结符表达式，那么此方法将进行运算，比如加减
     **/
    int interpreter(Map<String, Integer> var);
}

终结符表达式

package demo;

import java.util.Map;

/**
 * 
 * @ClassName: VarExpression
 * @Description:变量解析器/终结符表达式
 * @author cheng
 * @date 2017-8-30 下午03:08:08
 */
public class VarExpression implements Expression {

    // 需要获取值的变量名
    private String key;

    /**
     * 构造函数
     * 
     * @param key
     */
    public VarExpression(String key) {
        this.key = key;
    }

    /**
     * 从map中取值
     */
    @Override
    public int interpreter(Map<String, Integer> var) {
        return var.get(key);
    }

}

非终结符表达式

package demo;

import java.util.Map;

/**
 * 
 * @ClassName: AddExpression
 * @Description: 加法解析器/interpreter方法处理加法运算 
 * @author cheng
 * @date 2017-8-30 下午03:13:52
 */
public class AddExpression implements Expression {

    // 每个运算符都有左右两个参数进行运算
    private Expression left;
    private Expression right;

    /**
     * 构造函数
     * 
     * @param left
     * @param right
     */
    public AddExpression(Expression left, Expression right) {
        this.left = left;
        this.right = right;
    }

    /**
     * 进行加法运算
     */
    @Override
    public int interpreter(Map<String, Integer> var) {
        return left.interpreter(var) + right.interpreter(var);
    }

}

package demo;

import java.util.Map;

/**
 * 
 * @ClassName: SubExpression
 * @Description:减法解析器/interpreter方法处理减法运算
 * @author cheng
 * @date 2017-8-30 下午03:17:32
 */
public class SubExpression implements Expression {

    // 每个运算符都有左右两个参数进行运算
    private Expression left;
    private Expression right;

    /**
     * 构造函数
     * 
     * @param left
     * @param right
     */
    public SubExpression(Expression left, Expression right) {
        this.left = left;
        this.right = right;
    }

    /**
     * 进行减法运算
     */
    @Override
    public int interpreter(Map<String, Integer> var) {
        return left.interpreter(var) - right.interpreter(var);
    }

}

上下文

package demo;

import java.util.Map;
import java.util.Stack;

/**
 * 
 * @ClassName: Context
 * @Description:对输入的表达式进行解析，并计算
 * @author cheng
 * @date 2017-8-30 下午03:20:02
 */
public class Context {
    /**
     * 定义表达式，最后拿到是一个运算解析器，比如X+Y格式的，其中X可能又是由A+B的运算解析器组成
     * 只有最底层的解析器才是变量解析器，也就是终结符表达式 此参数最终得到的肯定是非终结表达式
     * */
    private Expression expression;

    /**
     * 分析用户输入的表达式
     */
    public void analyse(String expStr) {
        // 定义一个栈，安排运算的先后顺序
        Stack<Expression> stack = new Stack<Expression>();
        char[] charArray = expStr.toCharArray();
        Expression left = null;
        Expression right = null;
        for (int i = 0; i < charArray.length; i++) {
            switch (charArray[i]) {
            case '+':
                // 将加法运算加入到栈中
                left = stack.pop();
                right = new VarExpression(String.valueOf(charArray[++i]));
                stack.push(new AddExpression(left, right));
                break;
            case '-':
                // 将减法运算加入到栈中
                left = stack.pop();
                right = new VarExpression(String.valueOf(charArray[++i]));
                stack.push(new SubExpression(left, right));
                break;
            default:
                // 如果不是运算符，那么就是终结表达式
                stack.push(new VarExpression(String.valueOf(charArray[i])));
            }
        }
        // 把最终栈的顶层抛出，它即是最后封装的非终结表达式
        this.expression = stack.pop();
    }

    /**
     * 
     * @Title: run
     * @Description: 将键值对输入给表达式运算
     * @param var
     * @return
     */
    public int run(Map<String, Integer> var) {
        return expression.interpreter(var);
    }
}

测试

package demo;

import java.util.HashMap;
import java.util.Map;

/**
 * 
 * @ClassName: ClientTest
 * @Description:测试
 * @author cheng
 * @date 2017-8-30 下午03:24:11
 */
public class ClientTest {

    public static void main(String[] args) {
        String expStr = "a+b-c+d+e";
        Map<String, Integer> var = new HashMap<String, Integer>();
        var.put("a", 1);
        var.put("b", 2);
        var.put("c", 2);
        var.put("d", 4);
        var.put("e", 3);

        Context context = new Context();
        // 先解析运算表达式
        context.analyse(expStr);
        // 进行运算
        System.out.println(context.run(var));
    }
}

运行结果

8

优点

解释器是一个简单的语法分析工具，它最显著的优点就是扩展性，修改语法规则只需要修改相应的非终结符就可以了，若扩展语法，只需要增加非终结符类就可以了。

缺点

解释器模式会引起类的膨胀：每个语法都需要产生一个非终结符表达式，语法规则比较复杂时，就可能产生大量的类文件，为维护带来非常多的麻烦。
解释器模式采用递归调用方法：每个非终结符表达式只关心与自己相关的表达式，每个表达式需要知道最终的结果，必须通过一层一层的剥茧，无论是面向对象的语言还是面向过程的语言，递归都是一个不推荐的方式（只在必要条件下使用），它将导致调试非常复杂。想想看，如果要排查一个错误，我们是不是要一个个断点调试下去，直至最小的语法单元。
解释器模式使用了大量的循环和递归：效率是一个不容忽视的问题。特别是用于解释一个解析复杂、冗长的语法时，效率是难以忍受的。

注意事项

尽量不要在重要模块中使用解释器模式，否则维护会是一个很大的问题。在项目中可以使用shell、JRuby、Groovy等脚本语言来代替解释器模式、弥补Java编译型语言的不足。我们在一个银行的分析型项目中就采用了JRuby进行运算处理，避免使用解释器模式的四则运算，效率和性能各方面表现良好。

解释器模式在实际的系统开发中使用的非常少，因为它会引起效率、性能以及维护等问题，一般在大中型的框架型项目中能找到它的身影，如一些数据分析工具、报表设计工具、科学计算工具等，如果你确实遇到“一种特定类型的问题发生的频率足够高”的情况，准备使用解释器模式时，可以考虑一下Expression4J、MESP、Jep 等开源的解析工具包，功能都非常强大，而且非常容易使用，效率也不错，实现大多数的数学运算完全没有问题，自己没有必要重头开始编写解释器。