解释器模式（由浅到深学习设计模式）

解释器模式

---

1. 概述

是指给定一个语言(表达式)，定义它的文法的一种表示，并定义一个解释器， 使用该解释器来解释语言中的句子(表达式)

2. 应用场景（何时使用）

1、当有一个语言需要解释执行，可将该语言中的句子表示为一个抽象语法树，就可以考虑使用解释器模式，让程序具有良好的扩展性
2、编译器、运算表达式计算、正则表达式、机器人

3. 实例讲解

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

步骤如下：
1)	定义Expression类，定义抽象类表达式
2)  定义SymbolExpression类，抽象运算符号解析器，让其“加”“减”子类继承
3)  定义VarExpression类，变量的解释器
4)  定义Calculator类，解释运算
5)  客户端调用

Expression类

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */
 
/**
 * 抽象类表达式，通过HashMap 键值对, 可以获取到变量的值
 *
 * @author Administrator
 *
 */
public abstract class Expression {
	// a + b - c
	// 解释公式和数值, key 就是公式(表达式) 参数[a,b,c], value就是就是具体值
	// HashMap {a=10, b=20}
	public abstract int interpreter(HashMap<String, Integer> var);
}

SymbolExpression类

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */

/**
 * 抽象运算符号解析器 这里，每个运算符号，都只和自己左右两个数字有关系，
 * 但左右两个数字有可能也是一个解析的结果，无论何种类型，都是Expression类的实现类
 *
 * @author Administrator
 *
 */
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 是一个默认实现
	@Override
	public int interpreter(HashMap<String, Integer> var) {
		// TODO Auto-generated method stub
		return 0;
	}
}

AddExpression类

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */
public class AddExpression extends SymbolExpression  {

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

	//处理相加
	//var 仍然是 {a=10,b=20}..

	public int interpreter(HashMap<String, Integer> var) {
		//super.left.interpreter(var) 返回 left 表达式对应的值 a = 10
		//super.right.interpreter(var): 返回right 表达式对应的值 b = 20
		return super.left.interpreter(var) + super.right.interpreter(var);
	}
}

SubExpression类

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */
public class SubExpression extends SymbolExpression {

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

	//求出left 和 right 表达式相减后的结果
	public int interpreter(HashMap<String, Integer> var) {
		return super.left.interpreter(var) - super.right.interpreter(var);
	}
}

VarExpression类

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */
public class VarExpression extends Expression {

	private String key; // key=a,key=b,key=c

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

	// var 就是{a=10, b=20}
	// interpreter 根据 变量名称，返回对应值
	@Override
	public int interpreter(HashMap<String, Integer> var) {
		return var.get(this.key);
	}
}

Calculator类

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */
public class Calculator {

	// 定义表达式
	private Expression expression;

	// 构造函数传参 并解析
	public Calculator(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 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);
	}
}

客户端调用

/**
 * @author 漆剑
 * @date 2021-03-27
 * @description
 */
public class ClientTest {

	public static void main(String[] args) throws IOException {
		// TODO Auto-generated method stub
		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("请输入" + String.valueOf(ch) + "的值：");
					String in = (new BufferedReader(new InputStreamReader(System.in))).readLine();
					map.put(String.valueOf(ch), Integer.valueOf(in));
				}
			}
		}

		return map;
	}
}

4. 总结

1. 当有一个语言需要解释执行，可将该语言中的句子表示为一个抽象语法树，就可以考虑使用解释器模式，让程序具有良好的扩展性
2. 使用解释器可能带来的问题：解释器模式会引起类膨胀、解释器模式采用递归调用方法，将会导致调试非常复杂、效率可能降低.

由于水平有限，本博客难免有不足，恳请各位大佬不吝赐教！