设计模式——解释器模式

设计模式——解释器模式

概述

基本介绍

• 在编译原理中，一个算术表达式通过词法分析器形成词法单元，而后这些词法单元再通过语法分析器构建语法分析树，最终形成一颗抽象的语法分析树。这里的词法分析器和语法分析器都可以看做是解释器；
• 解释器模式（Interpreter Pattern）：是指给定一个语言(表达式)，定义它的文法的一种表示，并定义一个解释器， 使用该解释器来解释语言中的句子(表达式)
• 可以应用在将一个需要解释执行的语言中的句子表示为一个抽象语法树，一些重复出现的问题可以用一种简单的语言来表达；一个简单语法需要解释的场景；

细节和注意事项

• 当有一个语言需要解释执行，可将该语言中的句子表示为一个抽象语法树，就可以考虑使用解释器模式，让程序具有良好的扩展性；
• 应用场景：编译器、运算表达式计算、正则表达式、机器人等；
• 使用解释器可能带来的问题：解释器模式会引起类膨胀、解释器模式采用递归调用方法，将会导致调试非常复杂，效率可能降低；

UML

问题引入

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

• 先输入表达式的形式，比如 a+b+c-d+e；
• 再分别输入 a ,b, c, d, e 的值，然后得到计算结果；

编码实现

UML

首先，先构建出UML分析图，如下所示：

编码

首先构建一个表达式Expression的抽象类，作为变量表达式(非终结符)和运算符表达式(终结符)的基类

package edu.hebeu.expression;

import java.util.HashMap;

/**
 * 抽象类表达式，通过HashMap键值对，可以获取到变量的值
 * @author 13651
 *
 */
public abstract class Expression {

	/**
	 * 参数var：表示表达式的非终结符名和值
	 * 	如：a + b - c
	 * 	HashMap的key就是[a、b、c]，value就是对应的具体值
	 * @param var
	 * @return
	 */
	public abstract int interpreter(HashMap<String, Integer> var);
}

构建变量表达式VarExpression

package edu.hebeu.expression.nonterminal;

import java.util.HashMap;

import edu.hebeu.expression.Expression;

/**
 * 变量的解释器
 * @author 13651
 *
 */
public class VarExpression extends Expression{

	private String key; // key相当于表达式的a、b、c、...等
	
	public VarExpression(String key) {
		this.key = key;
	}
	
	/**
	 * 通过变量的名称(key)返回对应的值(value)
	 */
	@Override
	public int interpreter(HashMap<String, Integer> var) {
		return var.get(key);
	}

}

构建符号表达式，首先先构造所有符号表达式的基类SymbolExpression，然后再让具体的符号表达式继承基类SymbolExpression，具体的符号表达式包括：SubSymExpression减号表达式、AddSymExpression加号表达，如下：

package edu.hebeu.expression.terminal;

import java.util.HashMap;

import edu.hebeu.expression.Expression;

/**
 * 运算符号解析器的基类，每个运算符号斗都只和自己左右两个数字有关，但是左右
 * 两个数字有可能也是一个解析的结果，但是无论何种类型，都是Expression类的实
 * 现类；
 * @author 13651
 *
 */
public class SymbolExpression extends Expression{
	
	protected Expression left; // 本符号的左表达式
	protected Expression right; // 本符号的右表达式
	
	public SymbolExpression(Expression left, Expression right) {
		this.left = left;
		this.right = right;
	}

	/**
	 * 需要注意这个方法是所有的符号解析器的基类，因此该方法是默
	 * 认实现(空实现)的，具体实现细节交给子类去重写该方法
	 */
	@Override
	public int interpreter(HashMap<String, Integer> var) {
		return 0;
	}
	
}

package edu.hebeu.expression.terminal;

import java.util.HashMap;

import edu.hebeu.expression.Expression;

public class SubSymExpression extends SymbolExpression {

	public SubSymExpression(Expression left, Expression right) {
		super(left, right);
	}

	/**
	 * 重写父类的方法，处理相减
	 */
	@Override
	public int interpreter(HashMap<String, Integer> var) {
		
		/*
		 * super.left.interpreter(var)：返回left表达式对应的值，如：a = 20
		 * super.right.interpreter(var)：返回right表达式对应的值，如：b = 1
		 */
		return super.left.interpreter(var) - super.right.interpreter(var); // 将左右表达式的值相减并返回
	}
	
}

package edu.hebeu.expression.terminal;

import java.util.HashMap;

import edu.hebeu.expression.Expression;

/**
 * 加号(+)的解析器
 * @author 13651
 *
 */
public class AddSymExpression extends SymbolExpression{

	public AddSymExpression(Expression left, Expression right) {
		super(left, right);
	}

	/**
	 * 重写父类的方法，处理相加
	 */
	@Override
	public int interpreter(HashMap<String, Integer> var) {
		
		/*
		 * super.left.interpreter(var)：返回left表达式对应的值，如：a = 10
		 * super.right.interpreter(var)：返回right表达式对应的值，如：b = 21
		 */
		return super.left.interpreter(var) + super.right.interpreter(var); // 将左右表达式的值相加并返回
	}

}

此时解释器模式实现的系统就已经搭建完毕了，为了能够更好的使用，我们创建一个类Computer来合理的调用，给客户端屏蔽掉复杂的操作，如下：

package edu.hebeu;

import java.util.HashMap;
import java.util.Stack;

import edu.hebeu.expression.Expression;
import edu.hebeu.expression.nonterminal.VarExpression;
import edu.hebeu.expression.terminal.AddSymExpression;
import edu.hebeu.expression.terminal.SubSymExpression;

public class Computer {
	// 定义表达式
	private Expression expression;

	// 构造函数传参，并解析
	public Computer(String expStr) { // expStr = a+b
		// 安排运算先后顺序
		Stack<Expression> stack = new Stack<>();
		// 表达式拆分成字符数组
		char[] charArray = expStr.toCharArray();// 如：[a, +, b]

		Expression left = null;
		Expression right = null;
		// 遍历我们的字符数组， 即遍历 [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 AddSymExpression(left, right));// 然后根据得到left 和 right 构建 AddExpresson加入stack
				break;
			case '-': //
				left = stack.pop();
				right = new VarExpression(String.valueOf(charArray[++i]));
				stack.push(new SubSymExpression(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);
	}
}

测试类的编写

package edu.hebeu;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.HashMap;

public class ClientTest {

	public static void main(String[] args) throws IOException {
		while (true) {
			String expStr = getExpStr(); // a+b
			HashMap<String, Integer> var = getValue(expStr);// var {a=10, b=20}
			Computer computer = new Computer(expStr);
			System.out.println("运算结果：" + expStr + "=" + computer.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("请输入" + String.valueOf(ch) + "的值：");
					String in = (new BufferedReader(new InputStreamReader(System.in))).readLine();
					map.put(String.valueOf(ch), Integer.valueOf(in));
				}
			}
		}

		return map;
	}
}

测试