上一节课,我们学习了命令模式。命令模式将请求封装成对象,方便作为函数参数传递和赋值给变量。它主要的应用场景是给命令的执行附加功能,换句话说,就是控制命令的执行,比如,排队、异步、延迟执行命令、给命令执行记录日志、撤销重做命令等等。总体上来讲,命令模式的应用范围并不广。
今天,我们来学习解释器模式,它用来描述如何构建一个简单的“语言”解释器。比起命令模式,解释器模式更加小众,只在一些特定的领域会被用到,比如编译器、规则引擎、正则表达式。所以,解释器模式也不是我们学习的重点,你稍微了解一下就可以了。
话不多说,让我们正式开始今天的学习吧!

解释器模式的原理和实现

解释器模式的英文翻译是 Interpreter Design Pattern。在 GoF 的《设计模式》一书中,它是这样定义的:
Interpreter pattern is used to defines a grammatical representation for a language and provides an interpreter to deal with this grammar.
翻译成中文就是:解释器模式为某个语言定义它的语法(或者叫文法)表示,并定义一个解释器用来处理这个语法。
看了定义,你估计会一头雾水,因为这里面有很多我们平时开发中很少接触的概念,比如“语言”“语法”“解释器”。实际上,这里的“语言”不仅仅指我们平时说的中、英、日、法等各种语言。从广义上来讲,只要是能承载信息的载体,我们都可以称之为“语言”,比如,古代的结绳记事、盲文、哑语、摩斯密码等。
要想了解“语言”表达的信息,我们就必须定义相应的语法规则。这样,书写者就可以根据语法规则来书写“句子”(专业点的叫法应该是“表达式”),阅读者根据语法规则来阅读“句子”,这样才能做到信息的正确传递。而我们要讲的解释器模式,其实就是用来实现根据语法规则解读“句子”的解释器。
为了让你更好地理解定义,我举一个比较贴近生活的例子来解释一下。
实际上,理解这个概念,我们可以类比中英文翻译。我们知道,把英文翻译成中文是有一定规则的。这个规则就是定义中的“语法”。我们开发一个类似 Google Translate 这样的翻译器,这个翻译器能够根据语法规则,将输入的中文翻译成英文。这里的翻译器就是解释器模式定义中的“解释器”。
刚刚翻译器这个例子比较贴近生活,现在,我们再举个更加贴近编程的例子。
假设我们定义了一个新的加减乘除计算“语言”,语法规则如下:

  • 运算符只包含加、减、乘、除,并且没有优先级的概念;
  • 表达式(也就是前面提到的“句子”)中,先书写数字,后书写运算符,空格隔开;
  • 按照先后顺序,取出两个数字和一个运算符计算结果,结果重新放入数字的最头部位置,循环上述过程,直到只剩下一个数字,这个数字就是表达式最终的计算结果。

我们举个例子来解释一下上面的语法规则。
比如“ 8 3 2 4 - + ”这样一个表达式,我们按照上面的语法规则来处理,取出数字“8 3”和“-”运算符,计算得到 5,于是表达式就变成了“ 5 2 4 + ”。然后,我们再取出“ 5 2 ”和“ + ”运算符,计算得到 7,表达式就变成了“ 7 4 ”。最后,我们取出“ 7 4”和“ ”运算符,最终得到的结果就是 28。
看懂了上面的语法规则,我们将它用代码实现出来,如下所示。代码非常简单,用户按照上面的规则书写表达式,传递给 interpret() 函数,就可以得到最终的计算结果。

  1. public class ExpressionInterpreter {
  2. private Deque<Long> numbers = new LinkedList<>();
  3. public long interpret(String expression) {
  4. String[] elements = expression.split(" ");
  5. int length = elements.length;
  6. for (int i = 0; i < (length + 1) / 2; ++i) {
  7. numbers.addLast(Long.parseLong(elements[i]));
  8. }
  9. for (int i = (length + 1) / 2; i < length; ++i) {
  10. String operator = elements[i];
  11. boolean isValid = "+".equals(operator) || "-".equals(operator) || "*".equals(operator) || "/".equals(operator);
  12. if (!isValid) {
  13. throw new RuntimeException("Expression is invalid: " + expression);
  14. }
  15. long number1 = numbers.pollFirst();
  16. long number2 = numbers.pollFirst();
  17. long result = 0;
  18. if (operator.equals("+")) {
  19. result = number1 + number2;
  20. } else if (operator.equals("-")) {
  21. result = number1 - number2;
  22. } else if (operator.equals("*")) {
  23. result = number1 * number2;
  24. } else if (operator.equals("/")) {
  25. result = number1 / number2;
  26. }
  27. numbers.addFirst(result);
  28. }
  29. if (numbers.size() != 1) {
  30. throw new RuntimeException("Expression is invalid: " + expression);
  31. }
  32. return numbers.pop();
  33. }
  34. }

在上面的代码实现中,语法规则的解析逻辑(第 23、25、27、29 行)都集中在一个函数中,对于简单的语法规则的解析,这样的设计就足够了。但是,对于复杂的语法规则的解析,逻辑复杂,代码量多,所有的解析逻辑都耦合在一个函数中,这样显然是不合适的。这个时候,我们就要考虑拆分代码,将解析逻辑拆分到独立的小类中。
该怎么拆分呢?我们可以借助解释器模式。
解释器模式的代码实现比较灵活,没有固定的模板。我们前面也说过,应用设计模式主要是应对代码的复杂性,实际上,解释器模式也不例外。它的代码实现的核心思想,就是将语法解析的工作拆分到各个小类中,以此来避免大而全的解析类。一般的做法是,将语法规则拆分成一些小的独立的单元,然后对每个单元进行解析,最终合并为对整个语法规则的解析。
前面定义的语法规则有两类表达式,一类是数字,一类是运算符,运算符又包括加减乘除。利用解释器模式,我们把解析的工作拆分到 NumberExpression、AdditionExpression、SubstractionExpression、MultiplicationExpression、DivisionExpression 这样五个解析类中。
按照这个思路,我们对代码进行重构,重构之后的代码如下所示。当然,因为加减乘除表达式的解析比较简单,利用解释器模式的设计思路,看起来有点过度设计。不过呢,这里我主要是为了解释原理,你明白意思就好,不用过度细究这个例子。

  1. public interface Expression {
  2. long interpret();
  3. }
  4. public class NumberExpression implements Expression {
  5. private long number;
  6. public NumberExpression(long number) {
  7. this.number = number;
  8. }
  9. public NumberExpression(String number) {
  10. this.number = Long.parseLong(number);
  11. }
  12. @Override
  13. public long interpret() {
  14. return this.number;
  15. }
  16. }
  17. public class AdditionExpression implements Expression {
  18. private Expression exp1;
  19. private Expression exp2;
  20. public AdditionExpression(Expression exp1, Expression exp2) {
  21. this.exp1 = exp1;
  22. this.exp2 = exp2;
  23. }
  24. @Override
  25. public long interpret() {
  26. return exp1.interpret() + exp2.interpret();
  27. }
  28. }
  29. // SubstractionExpression/MultiplicationExpression/DivisionExpression与AdditionExpression代码结构类似,这里就省略了
  30. public class ExpressionInterpreter {
  31. private Deque<Expression> numbers = new LinkedList<>();
  32. public long interpret(String expression) {
  33. String[] elements = expression.split(" ");
  34. int length = elements.length;
  35. for (int i = 0; i < (length + 1) / 2; ++i) {
  36. numbers.addLast(new NumberExpression(elements[i]));
  37. }
  38. for (int i = (length + 1) / 2; i < length; ++i) {
  39. String operator = elements[i];
  40. boolean isValid = "+".equals(operator) || "-".equals(operator) || "*".equals(operator) || "/".equals(operator);
  41. if (!isValid) {
  42. throw new RuntimeException("Expression is invalid: " + expression);
  43. }
  44. Expression exp1 = numbers.pollFirst();
  45. Expression exp2 = numbers.pollFirst();
  46. Expression combinedExp = null;
  47. if (operator.equals("+")) {
  48. combinedExp = new AdditionExpression(exp1, exp2);
  49. } else if (operator.equals("-")) {
  50. combinedExp = new AdditionExpression(exp1, exp2);
  51. } else if (operator.equals("*")) {
  52. combinedExp = new AdditionExpression(exp1, exp2);
  53. } else if (operator.equals("/")) {
  54. combinedExp = new AdditionExpression(exp1, exp2);
  55. }
  56. long result = combinedExp.interpret();
  57. numbers.addFirst(new NumberExpression(result));
  58. }
  59. if (numbers.size() != 1) {
  60. throw new RuntimeException("Expression is invalid: " + expression);
  61. }
  62. return numbers.pop().interpret();
  63. }
  64. }

解释器模式实战举例

接下来,我们再来看一个更加接近实战的例子,也就是咱们今天标题中的问题:如何实现一个自定义接口告警规则功能?
在我们平时的项目开发中,监控系统非常重要,它可以时刻监控业务系统的运行情况,及时将异常报告给开发者。比如,如果每分钟接口出错数超过 100,监控系统就通过短信、微信、邮件等方式发送告警给开发者。
一般来讲,监控系统支持开发者自定义告警规则,比如我们可以用下面这样一个表达式,来表示一个告警规则,它表达的意思是:每分钟 API 总出错数超过 100 或者每分钟 API 总调用数超过 10000 就触发告警。

  1. api_error_per_minute > 100 || api_count_per_minute > 10000

在监控系统中,告警模块只负责根据统计数据和告警规则,判断是否触发告警。至于每分钟 API 接口出错数、每分钟接口调用数等统计数据的计算,是由其他模块来负责的。其他模块将统计数据放到一个 Map 中(数据的格式如下所示),发送给告警模块。接下来,我们只关注告警模块。

  1. Map<String, Long> apiStat = new HashMap<>();
  2. apiStat.put("api_error_per_minute", 103);
  3. apiStat.put("api_count_per_minute", 987);

为了简化讲解和代码实现,我们假设自定义的告警规则只包含“||、&&、>、<、==”这五个运算符,其中,“>、<、==”运算符的优先级高于“||、&&”运算符,“&&”运算符优先级高于“||”。在表达式中,任意元素之间需要通过空格来分隔。除此之外,用户可以自定义要监控的 key,比如前面的 api_error_per_minute、api_count_per_minute。
那如何实现上面的需求呢?我写了一个骨架代码,如下所示,其中的核心的实现我没有给出,你可以当作面试题,自己试着去补全一下,然后再看我的讲解。

  1. public class AlertRuleInterpreter {
  2. // key1 > 100 && key2 < 1000 || key3 == 200
  3. public AlertRuleInterpreter(String ruleExpression) {
  4. //TODO:由你来完善
  5. }
  6. //<String, Long> apiStat = new HashMap<>();
  7. //apiStat.put("key1", 103);
  8. //apiStat.put("key2", 987);
  9. public boolean interpret(Map<String, Long> stats) {
  10. //TODO:由你来完善
  11. }
  12. }
  13. public class DemoTest {
  14. public static void main(String[] args) {
  15. String rule = "key1 > 100 && key2 < 30 || key3 < 100 || key4 == 88";
  16. AlertRuleInterpreter interpreter = new AlertRuleInterpreter(rule);
  17. Map<String, Long> stats = new HashMap<>();
  18. stats.put("key1", 101l);
  19. stats.put("key3", 121l);
  20. stats.put("key4", 88l);
  21. boolean alert = interpreter.interpret(stats);
  22. System.out.println(alert);
  23. }
  24. }

实际上,我们可以把自定义的告警规则,看作一种特殊“语言”的语法规则。我们实现一个解释器,能够根据规则,针对用户输入的数据,判断是否触发告警。利用解释器模式,我们把解析表达式的逻辑拆分到各个小类中,避免大而复杂的大类的出现。按照这个实现思路,我把刚刚的代码补全,如下所示,你可以拿你写的代码跟我写的对比一下。

  1. public interface Expression {
  2. boolean interpret(Map<String, Long> stats);
  3. }
  4. public class GreaterExpression implements Expression {
  5. private String key;
  6. private long value;
  7. public GreaterExpression(String strExpression) {
  8. String[] elements = strExpression.trim().split("\\s+");
  9. if (elements.length != 3 || !elements[1].trim().equals(">")) {
  10. throw new RuntimeException("Expression is invalid: " + strExpression);
  11. }
  12. this.key = elements[0].trim();
  13. this.value = Long.parseLong(elements[2].trim());
  14. }
  15. public GreaterExpression(String key, long value) {
  16. this.key = key;
  17. this.value = value;
  18. }
  19. @Override
  20. public boolean interpret(Map<String, Long> stats) {
  21. if (!stats.containsKey(key)) {
  22. return false;
  23. }
  24. long statValue = stats.get(key);
  25. return statValue > value;
  26. }
  27. }
  28. // LessExpression/EqualExpression跟GreaterExpression代码类似,这里就省略了
  29. public class AndExpression implements Expression {
  30. private List<Expression> expressions = new ArrayList<>();
  31. public AndExpression(String strAndExpression) {
  32. String[] strExpressions = strAndExpression.split("&&");
  33. for (String strExpr : strExpressions) {
  34. if (strExpr.contains(">")) {
  35. expressions.add(new GreaterExpression(strExpr));
  36. } else if (strExpr.contains("<")) {
  37. expressions.add(new LessExpression(strExpr));
  38. } else if (strExpr.contains("==")) {
  39. expressions.add(new EqualExpression(strExpr));
  40. } else {
  41. throw new RuntimeException("Expression is invalid: " + strAndExpression);
  42. }
  43. }
  44. }
  45. public AndExpression(List<Expression> expressions) {
  46. this.expressions.addAll(expressions);
  47. }
  48. @Override
  49. public boolean interpret(Map<String, Long> stats) {
  50. for (Expression expr : expressions) {
  51. if (!expr.interpret(stats)) {
  52. return false;
  53. }
  54. }
  55. return true;
  56. }
  57. }
  58. public class OrExpression implements Expression {
  59. private List<Expression> expressions = new ArrayList<>();
  60. public OrExpression(String strOrExpression) {
  61. String[] andExpressions = strOrExpression.split("\\|\\|");
  62. for (String andExpr : andExpressions) {
  63. expressions.add(new AndExpression(andExpr));
  64. }
  65. }
  66. public OrExpression(List<Expression> expressions) {
  67. this.expressions.addAll(expressions);
  68. }
  69. @Override
  70. public boolean interpret(Map<String, Long> stats) {
  71. for (Expression expr : expressions) {
  72. if (expr.interpret(stats)) {
  73. return true;
  74. }
  75. }
  76. return false;
  77. }
  78. }
  79. public class AlertRuleInterpreter {
  80. private Expression expression;
  81. public AlertRuleInterpreter(String ruleExpression) {
  82. this.expression = new OrExpression(ruleExpression);
  83. }
  84. public boolean interpret(Map<String, Long> stats) {
  85. return expression.interpret(stats);
  86. }
  87. }

重点回顾

好了,今天的内容到此就讲完了。我们一块来总结回顾一下,你需要重点掌握的内容。
解释器模式为某个语言定义它的语法(或者叫文法)表示,并定义一个解释器用来处理这个语法。实际上,这里的“语言”不仅仅指我们平时说的中、英、日、法等各种语言。从广义上来讲,只要是能承载信息的载体,我们都可以称之为“语言”,比如,古代的结绳记事、盲文、哑语、摩斯密码等。
要想了解“语言”要表达的信息,我们就必须定义相应的语法规则。这样,书写者就可以根据语法规则来书写“句子”(专业点的叫法应该是“表达式”),阅读者根据语法规则来阅读“句子”,这样才能做到信息的正确传递。而我们要讲的解释器模式,其实就是用来实现根据语法规则解读“句子”的解释器。
解释器模式的代码实现比较灵活,没有固定的模板。我们前面说过,应用设计模式主要是应对代码的复杂性,解释器模式也不例外。它的代码实现的核心思想,就是将语法解析的工作拆分到各个小类中,以此来避免大而全的解析类。一般的做法是,将语法规则拆分一些小的独立的单元,然后对每个单元进行解析,最终合并为对整个语法规则的解析。

课堂讨论

  1. 在你过往的项目经历或阅读源码的时候,有没有用到或者见过解释器模式呢?

  1. 在告警规则解析的例子中,如果我们要在表达式中支持括号“()”,那如何对代码进行重构呢?你可以把它当作练习,试着编写一下代码。