简介

在编译原理中，一个算术表达式通过词法分析器形成词法单元，而后这些词法单元再通过语法分析器构建语法分析树，最终形成一颗抽象的语法分析树。这里的词法分析器和语法分析器都可以看做是解释器。

解释器模式（Interpreter Pattern）：是指给定一个语言（表达式），定义它的文法的一种表示，并定义一个解释器，使用该解释器来解释语言中的句子（表达式）。

应用场景

• 应用可以将一个需要解释执行的语言中的句子表示为一个抽象语法树。
• 一些重复出现的问题可以用一种简单的语言来表达。
• 一个简单语法需要解释的场景，比如编译器、运算表达式计算、正则表达式、机器人等。

Context：是环境角色，含有解释器之外的全局信息。

Expression：抽象表达式，声明一个抽象的解释操作，这个方法为抽象语法树中所有的节点所共享。

TerminalExpression：为终结符表达式，实现与文法中的终结符相关的解释操作。

NonTermialExpression：为非终结符表达式，为文法中的非终结符实现解释操作。

代码示例

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

先输入表达式的形式，比如 a+b+c-d+e，要求表达式的字母不能重复，在分别输入 a ,b, c, d, e 的值。

最后求出结果

/**
 * 表达式
 */
public interface Expression {
    // a + b - c
    // 解释公式和数值, key 就是公式(表达式) 参数[a,b,c], value就是就是具体值
    // HashMap {a=10, b=20}
    int interpreter(HashMap<String, Integer> var);
}

/**
 * 变量的解释器
 */
@AllArgsConstructor
public class VarExpression implements Expression {
    private  String key; //key =a,key=b,key=c
    @Override
    public int interpreter(HashMap<String, Integer> var) {
        return var.get(this.key);
    }
}

/**
 * 抽象运算符解释器，每个符号都只和自己左右两个数字有关系
 */
@AllArgsConstructor
public class SymbolExpression implements Expression {

    protected Expression left;
    protected Expression right;

    //空实现，让其子类来实现
    @Override
    public int interpreter(HashMap<String, Integer> var) {
        // 默认实现
        throw new RuntimeException();
    }
}

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

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

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

    @Override
    public int interpreter(HashMap<String, Integer> var) {
        return super.left.interpreter(var) - super.right.interpreter(var);
    }
}

/**
 * 计算类
 */
public class Calculator {
    // 定义表达式
    private final Expression expression;

    public Calculator(String expStr) {
        // 安排运算先后顺序
        Stack<Expression> stack = new Stack<>();
        // 表达式拆分成字符数组
        char[] charArray = expStr.toCharArray();// [a, +, b]

        Expression left;
        Expression right ;
        //遍历我们的字符数组， 即遍历  [a, +, b]
        //针对不同的情况，做处理
        for (int i = 0; i < charArray.length; i++) {
            switch (charArray[i]) {
                case '+': //
                    left = stack.pop();// 从stack取出left => "a"
                    right = new VarExpression(String.valueOf(charArray[++i]));// 取出右表达式 "b"
                    stack.push(new AddExpression(left, right));// 然后根据得到left 和 right 构建 AddExpresson加入stack
                    break;
                case '-': //
                    left = stack.pop();
                    right = new VarExpression(String.valueOf(charArray[++i]));
                    stack.push(new SubExpression(left, right));
                    break;
                default:
                    //如果是一个 Var 就创建要给 VarExpression 对象，并push到 stack
                    stack.push(new VarExpression(String.valueOf(charArray[i])));
                    break;
            }
        }
        //当遍历完整个 charArray 数组后，stack 就得到最后Expression
        this.expression = stack.pop();
    }

    public int run(HashMap<String, Integer> var) {
        //最后将表达式a+b和 var = {a=10,b=20}
        //然后传递给expression的interpreter进行解释执行
        return this.expression.interpreter(var);
    }
}

public class Client {

    public static void main(String[] args) throws IOException {
        String expStr = getExpStr(); // a+b
        HashMap<String, Integer> var = getValue(expStr);// var {a=10, b=20}
        Calculator calculator = new Calculator(expStr);
        System.out.println("运算结果：" + expStr + "=" + calculator.run(var));
    }

    // 获得表达式
    public static String getExpStr() throws IOException {
        System.out.print("请输入表达式：");
        return (new BufferedReader(new InputStreamReader(System.in))).readLine();
    }

    // 获得值映射
    public static HashMap<String, Integer> getValue(String expStr) throws IOException {
        HashMap<String, Integer> map = new HashMap<>();

        for (char ch : expStr.toCharArray()) {
            if (ch != '+' && ch != '-') {
                if (!map.containsKey(String.valueOf(ch))) {
                    System.out.print("请输入" + ch + "的值：");
                    String in = (new BufferedReader(new InputStreamReader(System.in))).readLine();
                    map.put(String.valueOf(ch), Integer.valueOf(in));
                }
            }
        }

        return map;
    }
}

说明

• 当有一个语言需要解释执行，可将该语言中的句子表示为一个抽象语法树，就可以考虑使用解释器模式，让程序具有良好的扩展性

• 应用场景：编译器、运算表达式计算、正则表达式、机器人等。

• 使用解释器可能带来的问题：解释器模式会引起类膨胀、解释器模式采用递归调用方法，将会导致调试非常复杂、效率可能降低。

在 Spring 中的使用

/**
 * Spring 中的解释器模式使用方式
 */
public class Client {
    public static void main(String[] args) {
        SpelExpressionParser parser = new SpelExpressionParser();
        Expression expression = parser.parseExpression("100 * (2 + 400) *   1 + 66");
        int result = (Integer) expression.getValue();
        System.out.println(result);
        System.exit(0);
    }
}

上面代码可以直接结算出来结果，在 SpelExpressionParser 父类 TemplateAwareExpressionParser 中，会根据参数的不同调用不同的 Expression

@Override
public Expression parseExpression(String expressionString, @Nullable ParserContext context) throws ParseException {
    if (context != null && context.isTemplate()) {
        Assert.notNull(expressionString, "'expressionString' must not be null");
        return parseTemplate(expressionString, context);
    }
    else {
        Assert.hasText(expressionString, "'expressionString' must not be null or blank");
        return doParseExpression(expressionString, context);
    }
}

在 parseTemplate 和 doParseExpression 方法中也会根据不同的条件调用不同的解析类，就好比上面手写的解释器模式中 a+b ，会根据是字符还是运算符来调用不同的 Expression。

@Override
protected SpelExpression doParseExpression(String expressionString, @Nullable ParserContext context)
        throws ParseException {

    checkExpressionLength(expressionString);

    try {
        this.expressionString = expressionString;
        // 这里会根据每个字符做不通的处理，就和上面 Calculator 中的 switch 块一样。
        Tokenizer tokenizer = new Tokenizer(expressionString);
        this.tokenStream = tokenizer.process();
        this.tokenStreamLength = this.tokenStream.size();
        this.tokenStreamPointer = 0;
        this.constructedNodes.clear();
        SpelNodeImpl ast = eatExpression();
        //.................................
    }
}