【设计模式】解释器模式

一、定义

　　解释器（Interpreter）模式的定义：给分析对象定义一个语言，并定义该语言的文法表示，再设计一个解析器来解释语言中的句子。也就是说，用编译语言的方式来分析应用中的实例。这种模式实现了文法表达式处理的接口，该接口解释一个特定的上下文。

二、结构

解释器模式的结构

解释器模式包含以下主要角色。
　　1）抽象表达式（Abstract Expression）角色：定义解释器的接口，约定解释器的解释操作，主要包含解释方法 interpret()。

　　2）终结符表达式（Terminal Expression）角色：是抽象表达式的子类，用来实现文法中与终结符相关的操作，文法中的每一个终结符都有一个具体终结表达式与之相对应。

　　3）非终结符表达式（Nonterminal Expression）角色：也是抽象表达式的子类，用来实现文法中与非终结符相关的操作，文法中的每条规则都对应于一个非终结符表达式。

　　4）环境（Context）角色：通常包含各个解释器需要的数据或是公共的功能，一般用来传递被所有解释器共享的数据，后面的解释器可以从这里获取这些值。 

　　5）客户端（Client）：主要任务是将需要分析的句子或表达式转换成使用解释器对象描述的抽象语法树，然后调用解释器的解释方法，当然也可以通过环境角色间接访问解释器的解释方法。

结构图

　　

三、代码实现

• 框架代码

public class Client {
    public static void main(String[] args) {

    }
}

// 抽象表达式
interface AbstractExpression {
    // 解释方法
    Object interpret(String info);
}

// 终结表达式
class TerminalExpression implements AbstractExpression {

    @Override
    public Object interpret(String info) {
        // 对终结符表达式的处理
        return null;
    }
}

// 非终结表达式
class NonTerminalExpression implements  AbstractExpression {

    private AbstractExpression exp1;
    private AbstractExpression exp2;

    @Override
    public Object interpret(String info) {
        // 非对终结符表达式的处理
        return null;
    }
}

// 环境类
class Context {
    private AbstractExpression exp;

    public void parse(String info){
        // 解析信息
    }

    public Object getValue() {
        // 调用相关表达式类的解释方法
        return null;
    }
}

• 具体解析器：加法表达式解析器，如将字母表达式"abc+cba"，解析成算数表达"123+321"的值，代码如下：

public class Client {
    public static void main(String[] args) {
        Context context = new Context();
        context.parse("abc+cba");
        System.out.println(context.getValue());
    }
}


// 抽象表达式
interface AbstractExpression {
    // 解释方法
    Object interpret(String info);
}

// 终结表达式
class TerminalExpression implements AbstractExpression {

    @Override
    public Object interpret(String info) {
        // 对终结符表达式的处理
        // abc ==> 123，将abc解析成123
        char[] chars = info.toCharArray();
        StringBuffer sb = new StringBuffer();
        for (char c : chars) {
            sb.append(c - 'a' + 1);
        }
        return Integer.parseInt(sb.toString());
    }
}

// 非终结表达式
class NonTerminalExpression implements  AbstractExpression {

    private AbstractExpression exp1;
    private AbstractExpression exp2;

    @Override
    public Object interpret(String info) {
        // 非对终结符表达式的处理
        String[] strings = info.split("[+]");
        exp1 = new TerminalExpression();
        exp2 = new TerminalExpression();
        int value = (Integer) exp1.interpret(strings[0]) + (Integer)exp2.interpret(strings[1]);
        return value;
    }
}

// 环境类
class Context {
    private AbstractExpression exp;
    private String info;

    public void parse(String info){
        // 解析信息
        if (info.indexOf('+') > -1) {
            exp = new NonTerminalExpression();
        }else {
            exp = new TerminalExpression();
        }
        this.info = info;
    }

    public Object getValue() {
        // 调用相关表达式类的解释方法
        return exp.interpret(info);
    }
}

四、源码应用

1、JEP中的应用

　　JEP是Java expression parser的简称，即java表达式分析器，Jep是一个用来转换和计算数学表达式的java库。通过这个程序包，用户可以以字符串的形式输入一个、任意的公式，然后快速地计算出结果。Jep支持用户自定义变量、常量和函数。包括许多常用的数学函数和常。

　　简单的来说，就是可以用算术运算符代替之前的java的公式，显示和逻辑编写更加清晰简单

• 引入JEP依赖

  <!-- Jep 是 Java expression parser 的简称 -->
  <dependency>
      <groupId>jep</groupId>
      <artifactId>jep</artifactId>
      <version>2.24</version>
  </dependency>

• 代码示例

  public class JepClient {
      public static void main(String[] args) {
          JEP jep = new JEP();
          // 定义要计算的数据表达式
          String 存款利息 = "本金*利率*时间";
          // 给相关变量赋值
          jep.addVariable("本金", 10000);
          jep.addVariable("利率", 0.038);
          jep.addVariable("时间", 2);
          // 解析表达式
          jep.parseExpression(存款利息);
          // 计算
          Double accrual = jep.getValue();
          System.out.println("存款利息：" + accrual);
      }
  }

2、Spring源码应用

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

2. 代码分析+Debug源码

　　

　　

　　测试demo　　

public static void main(String[] args) {
        SpelExpressionParser parser = new SpelExpressionParser();
        Expression expression =  parser.parseExpression("100 * (2 + 400) * 1 + 66");
        Integer value = (Integer) expression.getValue();
        System.out.println(value);
    }