解释器模式

解释器模式

案例引入

四则运算问题

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

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

传统方法实现四则运算问题及分析

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

基本介绍

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

解释器模式UML类图

类图说明

• 1.Context是环境角色，含有解释器之外的全局信息。
• 2.AbstractExpression 抽象表达式，声明一个抽象的解释操作，这个方法为抽象语法树中所有的节点所共享。
• 3.TerminalExpression为终结符表达式，实现与文法中的终结符相关的解释操作。
• 4.NonTerminalExpression为非终结符表达式，为文法中的非终结符实现解释操作。
• 5.说明输入 Context 和 TerminalExpression 信息通过Client输入即可。

解释器模式实现案例

案例类图

代码实现

此处代码，不是我自己写的，是复制的韩顺平老师提供的代码，这个课程也是韩顺平老师在尚硅谷时主讲的设计模式的课程

/**
 * 抽象类表达式，通过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);
}
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);
	}
}
/**
 * 加法解释器
 * @author Administrator
 *
 */
public class AddExpression extends SymbolExpression  {

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

	//处理相加
	//var 仍然是 {a=10,b=20}..
	//一会我们debug 源码,就ok
	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);
	}
}
/**
 * 抽象运算符号解析器 这里，每个运算符号，都只和自己左右两个数字有关系，
 * 但左右两个数字有可能也是一个解析的结果，无论何种类型，都是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;
	}
}
/**
 * 变量的解释器
 * @author Administrator
 *
 */
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);
	}
}
public class Calculator {

	// 定义表达式
	private Expression expression;

	// 构造函数传参，并解析
	public Calculator(String expStr) { // expStr = a+b
		// 安排运算先后顺序
		Stack<Expression> stack = new Stack<>();
		expStr = expStr.replace(" ", "");//移除表达式中的空格符
		// 表达式拆分成字符数组 
		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);
	}
}
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 != '-' && 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;
	}
}

解释器模式在Spring框架应用的源码分析

1.Spring框架中，SpingExpressionParser就使用到了解释器模式。
2.代码分析

import org.springframework.expression.Expression;
import org.springframework.expression.spel.standard.SpelExpressionParser;

/**
 * @author 长名06
 * @version 1.0
 */
public class AnalysisInterpreterSpelExpressionParser {
    public static void main(String[] args) {
        SpelExpressionParser parser = new SpelExpressionParser();
        Expression expression = parser.parseExpression("100 * (8 + 2) + 6");//会返回一个(运行类型)SpelExpression对象
        int result = (int) expression.getValue();//getValue()计算表达式的值
        System.out.println(result);//1006
    }
}

//parser.parseExpression("100 * (8 + 2) + 6");方法最后执行的地方，这两个方法是在其父类TemplateAwareExpressionParser中定义的
//TemplateAwareExpressionParser类下的方法
@Override
public Expression parseExpression(String expressionString) throws ParseException {
	return parseExpression(expressionString, null);
}

@Override
public Expression parseExpression(String expressionString, @Nullable ParserContext context) throws ParseException {
    if (context != null && context.isTemplate()) {
        return parseTemplate(expressionString, context);
    }
    else {
        return doParseExpression(expressionString, context);//context == null，会走到这里
    }
}
//TemplateAwareExpressionParser中doParseExpression(...)的为抽象方法，会在SpelExpressionParser里找
protected abstract Expression doParseExpression(String expressionString, @Nullable ParserContext context)
        throws ParseException;

//SpelExpressionParser类中的doParseExpression(...)方法，走到这里 不在继续往下追了，只是看看解释器模式在Spring框架中的应用
@Override
protected SpelExpression doParseExpression(String expressionString, @Nullable ParserContext context) throws ParseException {
    return new InternalSpelExpressionParser(this.configuration).doParseExpression(expressionString, context);
}

3.说明

• 3.1 Expression接口，表达式接口
• 3.2 有不同的实现类，如SpelExpression，或者CompositeStringExpression。
• 3.3 使用的时候，根据不同的paser对象，可以返回不同的Expression对象。
• 3.4 getValue()方法，解释执行表达式，返回结果。

注意事项和细节

1.当有一个语言需要解释执行，可将该语言中的句子表示为一个抽象的语法树，就可以考虑使用解释器模式，让程序具有良好的扩展性。
2.应用场景：编译器，运算表达式计算，正则表达式，机器人等。
3.使用解释器可能带来的问题，解释器模式会引起类膨胀，解释器模式采用递归的调用方法，将会导致调试非常复杂，效率可能会降低。
只是为了记录自己的学习历程，且本人水平有限，不对之处，请指正。