設(shè)計(jì)模式系列—解釋器模式
本篇和大家一起來(lái)學(xué)習(xí)解釋器模式相關(guān)內(nèi)容。
模式定義
給分析對(duì)象定義一個(gè)語(yǔ)言，并定義該語(yǔ)言的文法表示，再設(shè)計(jì)一個(gè)解析器來(lái)解釋語(yǔ)言中的句子。也就是說(shuō)，用編譯語(yǔ)言的方式來(lái)分析應(yīng)用中的實(shí)例。這種模式實(shí)現(xiàn)了文法表達(dá)式處理的接口，該接口解釋一個(gè)特定的上下文。
這里提到的文法和句子的概念同編譯原理中的描述相同，“文法”指語(yǔ)言的語(yǔ)法規(guī)則，而“句子”是語(yǔ)言集中的元素。例如，漢語(yǔ)中的句子有很多，“我是中國(guó)人”是其中的一個(gè)句子，可以用一棵語(yǔ)法樹(shù)來(lái)直觀地描述語(yǔ)言中的句子。
模式的結(jié)構(gòu)和實(shí)現(xiàn)
解釋器模式常用于對(duì)簡(jiǎn)單語(yǔ)言的編譯或分析實(shí)例中，為了掌握好它的結(jié)構(gòu)與實(shí)現(xiàn)，必須先了解編譯原理中的“文法、句子、語(yǔ)法樹(shù)”等相關(guān)概念。
文法
文法是用于描述語(yǔ)言的語(yǔ)法結(jié)構(gòu)的形式規(guī)則。沒(méi)有規(guī)矩不成方圓，例如，有些人認(rèn)為完美愛(ài)情的準(zhǔn)則是“相互吸引、感情專一、任何一方都沒(méi)有戀愛(ài)經(jīng)歷”，雖然最后一條準(zhǔn)則較苛刻，但任何事情都要有規(guī)則，語(yǔ)言也一樣，不管它是機(jī)器語(yǔ)言還是自然語(yǔ)言，都有它自己的文法規(guī)則。例如，中文中的“句子”的文法如下。
- 〈句子〉::=〈主語(yǔ)〉〈謂語(yǔ)〉〈賓語(yǔ)〉
- 〈主語(yǔ)〉::=〈代詞〉|〈名詞〉
- 〈謂語(yǔ)〉::=〈動(dòng)詞〉
- 〈賓語(yǔ)〉::=〈代詞〉|〈名詞〉
- 〈代詞〉你|我|他
- 〈名詞〉7大學(xué)生I筱霞I英語(yǔ)
- 〈動(dòng)詞〉::=是|學(xué)習(xí)
注：這里的符號(hào)“::=”表示“定義為”的意思，用“〈”和“〉”括住的是非終結(jié)符，沒(méi)有括住的是終結(jié)符。
句子
句子是語(yǔ)言的基本單位，是語(yǔ)言集中的一個(gè)元素，它由終結(jié)符構(gòu)成，能由“文法”推導(dǎo)出。例如，上述文法可以推出“我是大學(xué)生”，所以它是句子。
語(yǔ)法樹(shù)
語(yǔ)法樹(shù)是句子結(jié)構(gòu)的一種樹(shù)型表示，它代表了句子的推導(dǎo)結(jié)果，它有利于理解句子語(yǔ)法結(jié)構(gòu)的層次。下圖所示是“我是大學(xué)生”的語(yǔ)法樹(shù)。
解釋器模式的結(jié)構(gòu)與組合模式相似，不過(guò)其包含的組成元素比組合模式多，而且組合模式是對(duì)象結(jié)構(gòu)型模式，而解釋器模式是類行為型模式。
模式的實(shí)現(xiàn)
解釋器模式實(shí)現(xiàn)的關(guān)鍵是定義文法規(guī)則、設(shè)計(jì)終結(jié)符類與非終結(jié)符類、畫(huà)出結(jié)構(gòu)圖，必要時(shí)構(gòu)建語(yǔ)法樹(shù)，其代碼結(jié)構(gòu)如下：
- package com.niuh.designpattern.interpreter.v1;
- /**
- * <p>
- * 解釋器模式
- * </p>
- */
- public class InterpreterPattern {
- }
- //抽象表達(dá)式類
- interface AbstractExpression {
- public Object interpret(String info); //解釋方法
- }
- //終結(jié)符表達(dá)式類
- class TerminalExpression implements AbstractExpression {
- public Object interpret(String info) {
- //對(duì)終結(jié)符表達(dá)式的處理
- return null;
- }
- }
- //非終結(jié)符表達(dá)式類
- class NonterminalExpression implements AbstractExpression {
- private AbstractExpression exp1;
- private AbstractExpression exp2;
- public Object interpret(String info) {
- //非對(duì)終結(jié)符表達(dá)式的處理
- return null;
- }
- }
- //環(huán)境類
- class Context {
- private AbstractExpression exp;
- public Context() {
- //數(shù)據(jù)初始化
- }
- public void operation(String info) {
- //調(diào)用相關(guān)表達(dá)式類的解釋方法
- }
- }
解決的問(wèn)題
對(duì)于一些固定文法構(gòu)建一個(gè)解釋句子的解釋器。
模式組成
實(shí)例說(shuō)明
實(shí)例概況
用解釋器模式設(shè)計(jì)一個(gè)北京公交車卡的讀卡器程序。
說(shuō)明：假如北京公交車讀卡器可以判斷乘客的身份，如果是“海淀區(qū)”或者“朝陽(yáng)區(qū)”的“老人” “婦女”“兒童”就可以免費(fèi)乘車，其他人員乘車一次扣 2 元。
分析：本實(shí)例用“解釋器模式”設(shè)計(jì)比較適合，首先設(shè)計(jì)其文法規(guī)則如下。
- <expression> ::= <city>的<person>
- <city> ::= 海淀區(qū)|朝陽(yáng)區(qū)
- <person> ::= 老人|婦女|兒童
然后，根據(jù)文法規(guī)則按以下步驟設(shè)計(jì)公交車卡的讀卡器程序的類圖。
使用步驟
步驟1：定義一個(gè)抽象表達(dá)式(Expression)接口，它包含了解釋方法 interpret(String info)。
- //抽象表達(dá)式類
- interface Expression {
- public boolean interpret(String info);
- }
步驟2：定義一個(gè)終結(jié)符表達(dá)式(Terminal Expression)類，它用集合(Set)類來(lái)保存滿足條件的城市或人，并實(shí)現(xiàn)抽象表達(dá)式接口中的解釋方法 interpret(Stringinfo)，用來(lái)判斷被分析的字符串是否是集合中的終結(jié)符。
- class TerminalExpression implements Expression {
- private Set<String> set = new HashSet<String>();
- public TerminalExpression(String[] data) {
- for (int i = 0; i < data.length; i++) {
- set.add(data[i]);
- }
- }
- public boolean interpret(String info) {
- if (set.contains(info)) {
- return true;
- }
- return false;
- }
- }
步驟3：定義一個(gè)非終結(jié)符表達(dá)式(AndExpressicm)類，它也是抽象表達(dá)式的子類，它包含滿足條件的城市的終結(jié)符表達(dá)式對(duì)象和滿足條件的人員的終結(jié)符表達(dá)式對(duì)象，并實(shí)現(xiàn) interpret(String info) 方法，用來(lái)判斷被分析的字符串是否是滿足條件的城市中的滿足條件的人員。
- class AndExpression implements Expression {
- private Expression city = null;
- private Expression person = null;
- public AndExpression(Expression city, Expression person) {
- this.city = city;
- this.person = person;
- }
- public boolean interpret(String info) {
- String s[] = info.split("的");
- return city.interpret(s[0]) && person.interpret(s[1]);
- }
- }
步驟4：定義一個(gè)環(huán)境(Context)類，它包含解釋器需要的數(shù)據(jù)，完成對(duì)終結(jié)符表達(dá)式的初始化，并定義一個(gè)方法 freeRide(String info) 調(diào)用表達(dá)式對(duì)象的解釋方法來(lái)對(duì)被分析的字符串進(jìn)行解釋。
- class Context {
- private String[] citys = {"海淀區(qū)", "朝陽(yáng)區(qū)"};
- private String[] persons = {"老人", "婦女", "兒童"};
- private Expression cityPerson;
- public Context() {
- Expression city = new TerminalExpression(citys);
- Expression person = new TerminalExpression(persons);
- cityPerson = new AndExpression(city, person);
- }
- public void freeRide(String info) {
- boolean ok = cityPerson.interpret(info);
- if (ok) {
- System.out.println("您是" + info + "，您本次乘車免費(fèi)！");
- } else {
- System.out.println(info + "，您不是免費(fèi)人員，本次乘車扣費(fèi)2元！");
- }
- }
- }
步驟5：客戶端測(cè)試
- public class InterpreterPattern {
- public static void main(String[] args) {
- Context bus = new Context();
- bus.freeRide("海淀區(qū)的老人");
- bus.freeRide("海淀區(qū)的年輕人");
- bus.freeRide("朝陽(yáng)區(qū)的婦女");
- bus.freeRide("朝陽(yáng)區(qū)的兒童");
- bus.freeRide("南京的年輕人");
- }
- }
輸出結(jié)果
- 您是海淀區(qū)的老人，您本次乘車免費(fèi)!
- 海淀區(qū)的年輕人，您不是免費(fèi)人員，本次乘車扣費(fèi)2元!
- 您是朝陽(yáng)區(qū)的婦女，您本次乘車免費(fèi)!
- 您是朝陽(yáng)區(qū)的兒童，您本次乘車免費(fèi)!
- 南京的年輕人，您不是免費(fèi)人員，本次乘車扣費(fèi)2元!
優(yōu)點(diǎn)
解釋器模式是一種類行為型模式，其主要優(yōu)點(diǎn)如下。
- 擴(kuò)展性好。由于在解釋器模式中使用類來(lái)表示語(yǔ)言的文法規(guī)則，因此可以通過(guò)繼承等機(jī)制來(lái)改變或擴(kuò)展文法。
- 容易實(shí)現(xiàn)。在語(yǔ)法樹(shù)中的每個(gè)表達(dá)式節(jié)點(diǎn)類都是相似的，所以實(shí)現(xiàn)其文法較為容易。
缺點(diǎn)
- 執(zhí)行效率較低。解釋器模式中通常使用大量的循環(huán)和遞歸調(diào)用，當(dāng)要解釋的句子較復(fù)雜時(shí)，其運(yùn)行速度很慢，且代碼的調(diào)試過(guò)程也比較麻煩。
- 會(huì)引起類膨脹。解釋器模式中的每條規(guī)則至少需要定義一個(gè)類，當(dāng)包含的文法規(guī)則很多時(shí)，類的個(gè)數(shù)將急劇增加，導(dǎo)致系統(tǒng)難以管理與維護(hù)。
- 可應(yīng)用的場(chǎng)景比較少。在軟件開(kāi)發(fā)中，需要定義語(yǔ)言文法的應(yīng)用實(shí)例非常少，所以這種模式很少被使用到。
應(yīng)用場(chǎng)景
- 當(dāng)語(yǔ)言的文法較為簡(jiǎn)單，且執(zhí)行效率不是關(guān)鍵問(wèn)題時(shí)。
- 當(dāng)問(wèn)題重復(fù)出現(xiàn)，且可以用一種簡(jiǎn)單的語(yǔ)言來(lái)進(jìn)行表達(dá)時(shí)。
- 當(dāng)一個(gè)語(yǔ)言需要解釋執(zhí)行，并且語(yǔ)言中的句子可以表示為一個(gè)抽象語(yǔ)法樹(shù)的時(shí)候，如 XML 文檔解釋。
模式的擴(kuò)展
在項(xiàng)目開(kāi)發(fā)中，如果要對(duì)數(shù)據(jù)表達(dá)式進(jìn)行分析與計(jì)算，無(wú)須再用解釋器模式進(jìn)行設(shè)計(jì)了，Java 提供了以下強(qiáng)大的數(shù)學(xué)公式解析器：Expression4J、MESP(Math Expression String Parser) 和 Jep 等，它們可以解釋一些復(fù)雜的文法，功能強(qiáng)大，使用簡(jiǎn)單。
現(xiàn)在以 Jep 為例來(lái)介紹該工具包的使用方法。Jep 是 Java expression parser 的簡(jiǎn)稱，即 Java 表達(dá)式分析器，它是一個(gè)用來(lái)轉(zhuǎn)換和計(jì)算數(shù)學(xué)表達(dá)式的 Java 庫(kù)。通過(guò)這個(gè)程序庫(kù)，用戶可以以字符串的形式輸入一個(gè)任意的公式，然后快速地計(jì)算出其結(jié)果。而且 Jep 支持用戶自定義變量、常量和函數(shù)，它包括許多常用的數(shù)學(xué)函數(shù)和常量。
使用前先配置依賴包：
- <!-- https://mvnrepository.com/artifact/jep/jep -->
- <dependency>
- <groupId>jep</groupId>
- <artifactId>jep</artifactId>
- <version>2.24</version>
- </dependency>
下面來(lái)看一個(gè)案例：
- package com.niuh.designpattern.interpreter.v3;
- import org.nfunk.jep.JEP;
- /**
- * <p>
- * JepDemo
- * </p>
- */
- public class JepDemo {
- public static void main(String[] args) {
- JEP jep = new JEP(); //一個(gè)數(shù)學(xué)表達(dá)式
- String exp = "((a+b)*(c+b))/(c+a)/b"; //給變量賦值
- jep.addVariable("a", 10);
- jep.addVariable("b", 10);
- jep.addVariable("c", 10);
- try { //執(zhí)行
- jep.parseExpression(exp);
- Object result = jep.getValueAsObject();
- System.out.println("計(jì)算結(jié)果： " + result);
- } catch (Throwable e) {
- System.out.println("An error occured: " + e.getMessage());
- }
- }
- }
程序運(yùn)行結(jié)果如下：
- 計(jì)算結(jié)果： 2.0
源碼中的應(yīng)用
SpelExpressionParser中解釋器模式應(yīng)用分析
類圖分析
在下面的類圖中，Expression是一個(gè)接口，相當(dāng)于我們解釋器模式中的非終結(jié)符表達(dá)式，而ExpressionParser相當(dāng)于終結(jié)符表達(dá)式。根據(jù)不同的Parser對(duì)象，返回不同的Expression對(duì)象。
部分源碼分析
Expression接口
- //抽象的非終結(jié)符表達(dá)式
- public interface Expression {
- Object getValue() throws EvaluationException;
- Object getValue(Object rootObject) throws EvaluationException;
- }
SpelExpression類
- //具體的非終結(jié)符表達(dá)式
- public class SpelExpression implements Expression {
- @Override
- public Object getValue() throws EvaluationException {
- Object result;
- if (this.compiledAst != null) {
- try {
- TypedValue contextRoot = evaluationContext == null ? null : evaluationContext.getRootObject();
- return this.compiledAst.getValue(contextRoot == null ? null : contextRoot.getValue(), evaluationContext);
- }
- catch (Throwable ex) {
- // If running in mixed mode, revert to interpreted
- if (this.configuration.getCompilerMode() == SpelCompilerMode.MIXED) {
- this.interpretedCount = 0;
- this.compiledAst = null;
- }
- else {
- // Running in SpelCompilerMode.immediate mode - propagate exception to caller
- throw new SpelEvaluationException(ex, SpelMessage.EXCEPTION_RUNNING_COMPILED_EXPRESSION);
- }
- }
- }
- ExpressionState expressionState = new ExpressionState(getEvaluationContext(), this.configuration);
- result = this.ast.getValue(expressionState);
- checkCompile(expressionState);
- return result;
- }
- }
CompositeStringExpression
- //具體的非終結(jié)符表達(dá)式
- public class CompositeStringExpression implements Expression {
- @Override
- public String getValue() throws EvaluationException {
- StringBuilder sb&nbsp;= new StringBuilder();
- for (Expression expression : this.expressions) {
- String value = expression.getValue(String.class);
- if (value != null) {
- sb.append(value);
- }
- }
- return sb.toString();
- }
- }
ExpressionParser接口
- public interface ExpressionParser {
- //解析表達(dá)式
- Expression parseExpression(String expressionString) throws ParseException;
- Expression parseExpression(String expressionString, ParserContext context) throws ParseException;
- }
TemplateAwareExpressionParser類
- public abstract class TemplateAwareExpressionParser implements ExpressionParser {
- @Override
- public Expression parseExpression(String expressionString) throws ParseException {
- return parseExpression(expressionString, NON_TEMPLATE_PARSER_CONTEXT);
- }
- //根據(jù)不同的parser返回不同的Expression對(duì)象
- @Override
- public Expression parseExpression(String expressionString, ParserContext context)
- throws ParseException {
- if (context == null) {
- context = NON_TEMPLATE_PARSER_CONTEXT;
- }
- if (context.isTemplate()) {
- return parseTemplate(expressionString, context);
- }
- else {
- return doParseExpression(expressionString, context);
- }
- }
- private Expression parseTemplate(String expressionString, ParserContext context)
- throws ParseException {
- if (expressionString.length() == 0) {
- return new LiteralExpression("");
- }
- Expression[] expressions = parseExpressions(expressionString, context);
- if (expressions.length == 1) {
- return expressions[0];
- }
- else {
- return new CompositeStringExpression(expressionString, expressions);
- }
- }
- //抽象的，由子類去實(shí)現(xiàn)
- protected abstract Expression doParseExpression(String expressionString,
- ParserContext context) throws ParseException;
- }
SpelExpressionParser類
- public class SpelExpressionParser extends TemplateAwareExpressionParser {
- @Override
- protected SpelExpression doParseExpression(String expressionString, ParserContext context) throws ParseException {
- //這里返回了一個(gè)InternalSpelExpressionParser，
- return new InternalSpelExpressionParser(this.configuration).doParseExpression(expressionString, context);
- }
- }
InternalSpelExpressionParser類
- class InternalSpelExpressionParser extends TemplateAwareExpressionParser {
- @Override
- protected SpelExpression doParseExpression(String expressionString, ParserContext context) throws ParseException {
- try {
- this.expressionString = expressionString;
- Tokenizer tokenizer = new Tokenizer(expressionString);
- tokenizer.process();
- this.tokenStream = tokenizer.getTokens();
- this.tokenStreamLength = this.tokenStream.size();
- this.tokenStreamPointer = 0;
- this.constructedNodes.clear();
- SpelNodeImpl ast = eatExpression();
- if (moreTokens()) {
- throw new SpelParseException(peekToken().startPos, SpelMessage.MORE_INPUT, toString(nextToken()));
- }
- Assert.isTrue(this.constructedNodes.isEmpty());
- return new SpelExpression(expressionString, ast, this.configuration);
- }
- catch (InternalParseException ex) {
- throw ex.getCause();
- }
- }
- }
PS：以上代碼提交在 Github ：
https://github.com/Niuh-Study/niuh-designpatterns.git
