解释器模式

1、四则运算问题

通过解释器模式来实现四则运算，如计算a + b - c的值，具体要求

1）先输入表达式的形式，比如a + b + c - d + e，要求表达式的字母不能重复
2）在分别输入a, b, c, d, e的值
3）最后求出结果：如图

传统方案解决四则运算问题分析

1）编写一个方法，接收表达式的形式，然后根据用户输入的数值进行解析，得到结果
2）问题分析：如果加入新的运算符，比如* / (等等，不利于扩展，另外让一个方法来解析会造成程序结构混乱，不够清晰
3）解决方案：可以考虑使用解释器模式，即：表达式 => 解释器（可以有多种） => 结果

2、解释器模式的基本介绍

1）在编译原理中，一个算术表达式通过词法分析器形成词法单元，而后这些词法单元再通过语法分析器构建语法分析树，最终形成一颗抽象的语法分析树。这里的词法分析器和语法分析器都可以看做是解释器
2）解释器模式（Interpreter Pattern）：是指给定一个语言（表达式），定义它的文法的一种表示，并定义一个解释器，使用该解释器来解释语言中的句子（表达式）
3）应用场景
- 应用可以将一个需要解释执行的语言中的句子表示为一个抽象语法树
- 一些重复出现的问题可以用一种简单的语言来表达
- 一个简单语法需要解释的场景
4）这样的例子还有，比如编译器、运算表达式计算、正则表达式、机器人等

原理类图

解释器模式的角色及职责

Context环境角色：含有解释器之外的全局信息
AbstractExpression抽象表达式：声明一个抽象的解释操作，该方法为抽象语法树中所有节点共享
TerminalExpression终结符表达式：实现与文法中终结符相关的解释操作
NonTerminalExpression非终结符表达式：实现与文法中非终结符相关的解释操作

3、解释器模式解决四则运算问题

UML 类图

/**
 * 抽象表达式类
 */
public abstract class Expression {
    /**
     * a + b - c
     * 解释公式和数值，key就是公式（表达式）参数[a, b, c]，value就是具体值
     * HashMap{a=10, b=20}
     *
     * @param var
     * @return
     */
    public abstract int interpret(Map<String,Integer> var);
}

/**
 * 抽象运算符号解释器
 * 这里每个运算符号，都只和自己左右两个数字有关系，
 * 但左右两个数字有可能也是一个解析的结果，无论何种类型，都是Expression类的实现类
 */
public class SymbolExpression extends Expression{

    protected Expression left;
    protected Expression right;

    public SymbolExpression(Expression left, Expression right) {
        this.left = left;
        this.right = right;
    }

    /**
     * 因为SymbolExpression 是让其子类来实现，因此interpreter是一个默认实现
     *
     * @param var
     * @return
     */
    @Override
    public int interpret(Map<String, Integer> var) {
        return 0;
    }
}

/**
 * 加法解释器
 */
public class AddExpression extends SymbolExpression{
    public AddExpression(Expression left, Expression right) {
        super(left, right);
    }

    @Override
    public int interpret(Map<String, Integer> var) {
        return super.left.interpret(var)+super.right.interpret(var);
    }
}

/**
 * 减法解释器
 */
public class SubExpression extends SymbolExpression{
    public SubExpression(Expression left, Expression right) {
        super(left, right);
    }

    /**
     * 处理相减
     *
     * @param var
     * @return
     */
    @Override
    public int interpret(Map<String, Integer> var) {
        return super.left.interpret(var) - super.right.interpret(var);
    }
}

public class VarExpression extends Expression{

    private String key;

    public VarExpression(String key) {
        this.key = key;
    }

    @Override
    public int interpret(Map<String, Integer> var) {
        return var.get(this.key);
    }
}

public class Calculator {
    private Expression expression;

    public Calculator(String expStr){
        //栈对象存放变量表达式及运算得到的表达式
        Stack<Expression> stack = new Stack<>();
        //将表达式拆分成字符数组
        char[] charArr = expStr.toCharArray();
        Expression left;
        Expression right;
        // 遍历字符数组 [a,+,b]
        for (int i = 0; i < charArr.length; i++) {
            switch (charArr[i]){
                case '+':
                    // 取出 a
                    left = stack.pop();
                    // 取出下一位变量，并创建`VarExpression`
                    right = new VarExpression(String.valueOf(charArr[++i]));
                    // 将left和right值作为参数，push到`Stack`中
                    stack.push(new AddExpression(left,right));
                    break;
                case '-':
                    left = stack.pop();
                    right = new VarExpression(String.valueOf(charArr[++i]));
                    stack.push(new SubExpression(left,right));
                    break;
                default:
                    // 如果不是加减等运算符，就创建`VarExpression`，并push到`Stack`中
                    stack.push(new VarExpression(String.valueOf(charArr[i])));
                    break;
            }
        }
        this.expression = stack.pop();
    }

    public int run(Map<String,Integer> var){
        return this.expression.interpret(var);
    }
}

测试

public class Client {
    public static void main(String[] args) throws IOException {
        System.out.println("请输入表达式：");
        String expStr = getExpStr();
        Map<String, Integer> value = getValue(expStr);
        Calculator calculator = new Calculator(expStr);
        System.out.println("运算结果"+expStr+"="+calculator.run(value));

    }
    public static String getExpStr() throws IOException {
        return new BufferedReader(new InputStreamReader(System.in)).readLine();
    }

    public static Map<String,Integer> getValue(String expVar) throws IOException{
        HashMap<String, Integer> map = new HashMap<>();
        String s;
        for (char ch : expVar.toCharArray()) {
            s = String.valueOf(ch);
            if (ch == '+'  ch == '-'  map.containsKey(s)) {
                continue;
            }
            System.out.print("请输入" + s + "的值：");
            map.put(s, Integer.valueOf(getExpStr()));
        }
        return map;
    }
}

4、解释器模式在 Spring 框架中的源码分析

Spring框架中SpelExpressionParser就使用到解释器模式

SpelExpressionParser spelExpressionParser = new SpelExpressionParser();
Expression expression = spelExpressionParser.parseExpression("10*(2+1)*1+66");
int result = (Integer) expression.getValue();
System.out.println(result);

UML 类图

public Expression parseExpression(String expressionString, ParserContext context) throws ParseException {
    if (context == null) {
        context = NON_TEMPLATE_PARSER_CONTEXT;
    }

    if (context.isTemplate()) {
        return parseTemplate(expressionString, context);
    }
    else {
        return doParseExpression(expressionString, context);
    }
}