设计模式(JAVA)——Interpreter模式

1. Interpreter模式

解释器模式，语法规则也是类。程序要解决的问题会被用非常简单的"迷你语言"表述出来，用"迷你语言"编写的"迷你程序"把具体问题表述出来。迷你程序需要配合一个"翻译（Interpreter）"的程序来进行解释。

1.1 Interpreter模式的类图

登场的角色

• AbstractExpression（抽象表达式）
  定义了语法树的共同接口

• TerminalExpression（终结符表达式）
  对应了BNF中的终结符表达式

• NonterminalExpress（非终结表达式）
  对应了BNF中的非终结表达式

• Context（上下文）
  为解释器进行语法解析分析提供了必要的信息。

• Client（请求者）
  调用解释器解释Context的内容

1.2 示例程序

类一览表

名字	说明
Node	表示语法树"节点"的类
ProgramNode	对应的类
CommandListNode	对应的类
CommandNode	对应的类
RepeatCommandNode	对应的类
PrimitiveCommandNode	对应的类
Context	表示语法解析上下文的类
Main	测试程序行为的类

uml类图（只含继承关系）

uml类图

目录和program.txt

Node类

package xin.ajay.interpreter;

import java.text.ParseException;

/*
<program> ::= program <command list>
<command list> ::= <command>* end
<command> ::= <repeat command> | <primitive command>
<repeat command> ::= repeat <number> <command list>
<primitive command> ::= go | right | left
 */
public abstract class Node {
    public abstract void parse(Context context) throws ParseException;
}

Context类

package xin.ajay.interpreter;

import java.text.ParseException;
import java.util.StringTokenizer;

public class Context {
    private StringTokenizer tokenizer;
    private String currentToken;

    public Context(String text) {
       tokenizer = new StringTokenizer(text);
       nextToken();
    }

    public void skipToken(String token) throws ParseException{
        if(!token.equals(currentToken)){
            throw new ParseException("Warning: "+ token + " is expected,but " + currentToken + " is found",0);
        }
        nextToken();
    }

    public String currentToken() {
        return currentToken;
    }

    public int currentNumber() {
        int number = 0;
        number = Integer.parseInt(currentToken);
        return number;
    }

    public String nextToken() {
        if(tokenizer.hasMoreTokens()){
            currentToken = tokenizer.nextToken();
        }else {
            currentToken = null;
        }
        return currentToken;
    }
}

ProgramNode类

package xin.ajay.interpreter;

import java.text.ParseException;

public class ProgramNode extends Node {
    private Node commandListNode;

    @Override
    public void parse(Context context) throws ParseException {
        context.skipToken("program");

        commandListNode = new CommandListNode();
        commandListNode.parse(context);

    }

    @Override
    public String toString() {
        return "[program " + commandListNode + "]";
    }
}

CommandListNode类

package xin.ajay.interpreter;

import java.text.ParseException;
import java.util.ArrayList;
import java.util.List;

public class CommandListNode extends Node{
    private List<Node> list= new ArrayList<>();

    @Override
    public void parse(Context context) throws ParseException {
        while (true){
            if(context.currentToken() ==null){
                throw new ParseException("Missing 'end'",0);
            }else if(context.currentToken().equals("end")){
                context.skipToken("end");
                break;
            }else {
                Node commandNode = new CommandNode();
                commandNode.parse(context);
                list.add(commandNode);
            }
        }
    }

    public String toString(){
        return list.toString();
    }
}

CommandNode类

package xin.ajay.interpreter;

import java.text.ParseException;

public class CommandNode extends Node{
    private Node node;

    @Override
    public void parse(Context context) throws ParseException {
        if(context.currentToken().equals("repeat")){
            node = new RepeatCommandNode();
            node.parse(context);
        }else {
           node = new PrimitiveCommandNode();
           node.parse(context);
        }
    }

    public String toString(){
        return node.toString();
    }
}

RepeatCommandNode类

package xin.ajay.interpreter;

import java.text.ParseException;

public class ProgramNode extends Node {
    private Node commandListNode;

    @Override
    public void parse(Context context) throws ParseException {
        context.skipToken("program");

        commandListNode = new CommandListNode();
        commandListNode.parse(context);

    }

    @Override
    public String toString() {
        return "[program " + commandListNode + "]";
    }
}

PrimitiveCommandNode类

package xin.ajay.interpreter;

import java.text.ParseException;

public class PrimitiveCommandNode extends Node {
    private String name;
    @Override
    public void parse(Context context) throws ParseException {
        name = context.currentToken();
        context.skipToken(name);
        if(!name.equals("go") && !name.equals("right") && !name.equals("left")){
            throw new ParseException(name + " is undefined",0);
        }
    }

    public String toString(){
        return name;
    }

}

Main类

package xin.ajay.interpreter;

import java.io.*;
import java.text.ParseException;

public class Main {
    public static void main(String[] args) {
        try {
            BufferedReader reader = new BufferedReader(new InputStreamReader(Main.class.getClassLoader().getResourceAsStream("program.txt")));

            String text;
            while ((text = reader.readLine())!=null){
                System.out.println("text = \""+text +"\"");
                Node node = new ProgramNode();
                node.parse(new Context(text));
                System.out.println("node = " +node);
            }
            reader.close();

        } catch (IOException | ParseException e) {
            e.printStackTrace();
        }


    }


}

结果

text = "program end"
node = [program []]
text = "program go end"
node = [program [go]]
text = "program go right go right go right go right end"
node = [program [go, right, go, right, go, right, go, right]]
text = "program repeat 4 go right end end"
node = [program [[repeat 4 [go, right]]]]
text = "program repeat 4 repeat 3 go right go left end right end end"
node = [program [[repeat 4 [[repeat 3 [go, right, go, left]], right]]]]

鸣谢

GoF《设计模式》和结城浩的《图解设计模式》