zoukankan      html  css  js  c++  java

  • 行为型-命令模式（Command）

    装修新房的最后几道工序之一是安装插座和开关，通过开关可以控制一些电器的打开和关闭，例如电灯或者排气扇。在购买开关时，我们并不知道它将来到底用于控制什么电器，也就是说，开关与电灯、排气扇并无直接关系，一个开关在安装之后可能用来控制电灯，也可能用来控制排气扇或者其他电器设备。开关与电器之间通过电线建立连接，如果开关打开，则电线通电，电器工作；反之，开关关闭，电线断电，电器停止工作。相同的开关可以通过不同的电线来控制不同的电器，如图1所示：

    图1 开关与电灯、排气扇示意图

           在图1中，我们可以将开关理解成一个请求的发送者，用户通过它来发送一个“开灯”请求，而电灯是“开灯”请求的最终接收者和处理者，在图中，开关和电灯之间并不存在直接耦合关系，它们通过电线连接在一起，使用不同的电线可以连接不同的请求接收者，只需更换一根电线，相同的发送者（开关）即可对应不同的接收者（电器）。

           在软件开发中也存在很多与开关和电器类似的请求发送者和接收者对象，例如一个按钮，它可能是一个“关闭窗口”请求的发送者，而按钮点击事件处理类则是该请求的接收者。为了降低系统的耦合度，将请求的发送者和接收者解耦，我们可以使用一种被称之为命令模式的设计模式来设计系统，在命令模式中，发送者与接收者之间引入了新的命令对象（类似图1中的电线），将发送者的请求封装在命令对象中，再通过命令对象来调用接收者的方法。本章我们将学习用于将请求发送者和接收者解耦的命令模式。

    1 自定义功能键

           Sunny软件公司开发人员为公司内部OA系统开发了一个桌面版应用程序，该应用程序为用户提供了一系列自定义功能键，用户可以通过这些功能键来实现一些快捷操作。Sunny软件公司开发人员通过分析，发现不同的用户可能会有不同的使用习惯，在设置功能键的时候每个人都有自己的喜好，例如有的人喜欢将第一个功能键设置为“打开帮助文档”，有的人则喜欢将该功能键设置为“最小化至托盘”，为了让用户能够灵活地进行功能键的设置，开发人员提供了一个“功能键设置”窗口，该窗口界面如图2所示：

    图2  “功能键设置”界面效果图

           通过如图2所示界面，用户可以将功能键和相应功能绑定在一起，还可以根据需要来修改功能键的设置，而且系统在未来可能还会增加一些新的功能或功能键。

           Sunny软件公司某开发人员欲使用如下代码来实现功能键与功能处理类之间的调用关系：

    [java] view plain copy
     
    1. //FunctionButton：功能键类，请求发送者    
    2. class FunctionButton {    
    3.     private HelpHandler help; //HelpHandler：帮助文档处理类，请求接收者    
    4.         
    5.     //在FunctionButton的onClick()方法中调用HelpHandler的display()方法    
    6. public void onClick() {    
    7.         help = new HelpHandler();    
    8.         help.display(); //显示帮助文档    
    9.     }    
    10. }    

           在上述代码中，功能键类FunctionButton充当请求的发送者，帮助文档处理类HelpHandler充当请求的接收者，在发送者FunctionButton的onClick()方法中将调用接收者HelpHandler的display()方法。显然，如果使用上述代码，将给系统带来如下几个问题：

           (1) 由于请求发送者和请求接收者之间存在方法的直接调用，耦合度很高，更换请求接收者必须修改发送者的源代码，如果需要将请求接收者HelpHandler改为WindowHanlder（窗口处理类），则需要修改FunctionButton的源代码，违背了“开闭原则”。

           (2) FunctionButton类在设计和实现时功能已被固定，如果增加一个新的请求接收者，如果不修改原有的FunctionButton类，则必须增加一个新的与FunctionButton功能类似的类，这将导致系统中类的个数急剧增加。由于请求接收者HelpHandler、WindowHanlder等类之间可能不存在任何关系，它们没有共同的抽象层，因此也很难依据“依赖倒转原则”来设计FunctionButton。

           (3) 用户无法按照自己的需要来设置某个功能键的功能，一个功能键类的功能一旦固定，在不修改源代码的情况下无法更换其功能，系统缺乏灵活性。

           不难得知，所有这些问题的产生都是因为请求发送者FunctionButton类和请求接收者HelpHandler、WindowHanlder等类之间存在直接耦合关系，如何降低请求发送者和接收者之间的耦合度，让相同的发送者可以对应不同的接收者？这是Sunny软件公司开发人员在设计“功能键设置”模块时不得不考虑的问题。命令模式正为解决这类问题而诞生，此时，如果我们使用命令模式，可以在一定程度上解决上述问题（注：命令模式无法解决类的个数增加的问题），下面就让我们正式进入命令模式的学习，看看命令模式到底如何实现请求发送者和接收者解耦。

    2 命令模式概述

           在软件开发中，我们经常需要向某些对象发送请求（调用其中的某个或某些方法），但是并不知道请求的接收者是谁，也不知道被请求的操作是哪个，此时，我们特别希望能够以一种松耦合的方式来设计软件，使得请求发送者与请求接收者能够消除彼此之间的耦合，让对象之间的调用关系更加灵活，可以灵活地指定请求接收者以及被请求的操作。命令模式为此类问题提供了一个较为完美的解决方案。

           命令模式可以将请求发送者和接收者完全解耦，发送者与接收者之间没有直接引用关系，发送请求的对象只需要知道如何发送请求，而不必知道如何完成请求。

           命令模式定义如下：

    命令模式(Command Pattern)：将一个请求封装为一个对象，从而让我们可用不同的请求对客户进行参数化；对请求排队或者记录请求日志，以及支持可撤销的操作。命令模式是一种对象行为型模式，其别名为动作(Action)模式或事务(Transaction)模式。

           命令模式的定义比较复杂，提到了很多术语，例如“用不同的请求对客户进行参数化”、“对请求排队”，“记录请求日志”、“支持可撤销操作”等，在后面我们将对这些术语进行一一讲解。

           命令模式的核心在于引入了命令类，通过命令类来降低发送者和接收者的耦合度，请求发送者只需指定一个命令对象，再通过命令对象来调用请求接收者的处理方法，其结构如图3所示：

    图3 命令模式结构图

           在命令模式结构图中包含如下几个角色：

           ● Command（抽象命令类）：抽象命令类一般是一个抽象类或接口，在其中声明了用于执行请求的execute()等方法，通过这些方法可以调用请求接收者的相关操作。

           ● ConcreteCommand（具体命令类）：具体命令类是抽象命令类的子类，实现了在抽象命令类中声明的方法，它对应具体的接收者对象，将接收者对象的动作绑定其中。在实现execute()方法时，将调用接收者对象的相关操作(Action)。

           ● Invoker（调用者）：调用者即请求发送者，它通过命令对象来执行请求。一个调用者并不需要在设计时确定其接收者，因此它只与抽象命令类之间存在关联关系。在程序运行时可以将一个具体命令对象注入其中，再调用具体命令对象的execute()方法，从而实现间接调用请求接收者的相关操作。

           ● Receiver（接收者）：接收者执行与请求相关的操作，它具体实现对请求的业务处理。

           命令模式的本质是对请求进行封装，一个请求对应于一个命令，将发出命令的责任和执行命令的责任分割开。每一个命令都是一个操作：请求的一方发出请求要求执行一个操作；接收的一方收到请求，并执行相应的操作。命令模式允许请求的一方和接收的一方独立开来，使得请求的一方不必知道接收请求的一方的接口，更不必知道请求如何被接收、操作是否被执行、何时被执行，以及是怎么被执行的。

           命令模式的关键在于引入了抽象命令类，请求发送者针对抽象命令类编程，只有实现了抽象命令类的具体命令才与请求接收者相关联。在最简单的抽象命令类中只包含了一个抽象的execute()方法，每个具体命令类将一个Receiver类型的对象作为一个实例变量进行存储，从而具体指定一个请求的接收者，不同的具体命令类提供了execute()方法的不同实现，并调用不同接收者的请求处理方法。

            典型的抽象命令类代码如下所示：

    [java] view plain copy
     
    1. abstract class Command {    
    2.     public abstract void execute();    
    3. }    

           对于请求发送者即调用者而言，将针对抽象命令类进行编程，可以通过构造注入或者设值注入的方式在运行时传入具体命令类对象，并在业务方法中调用命令对象的execute()方法，其典型代码如下所示：

    [java] view plain copy
     
    1. class Invoker {    
    2.     private Command command;    
    3.         
    4.     //构造注入    
    5.     public Invoker(Command command) {    
    6.         this.command = command;    
    7.     }    
    8.         
    9.     //设值注入    
    10.     public void setCommand(Command command) {    
    11.         this.command = command;    
    12.     }    
    13.         
    14.     //业务方法，用于调用命令类的execute()方法    
    15.     public void call() {    
    16.         command.execute();    
    17.     }    
    18. }  

           具体命令类继承了抽象命令类，它与请求接收者相关联，实现了在抽象命令类中声明的execute()方法，并在实现时调用接收者的请求响应方法action()，其典型代码如下所示：

    [java] view plain copy
     
    1. class ConcreteCommand extends Command {    
    2.     private Receiver receiver; //维持一个对请求接收者对象的引用    
    3.     
    4.     public void execute() {    
    5.         receiver.action(); //调用请求接收者的业务处理方法action()    
    6.     }    
    7. }    

           请求接收者Receiver类具体实现对请求的业务处理，它提供了action()方法，用于执行与请求相关的操作，其典型代码如下所示：

    [java] view plain copy
     
    1. class Receiver {    
    2.     public void action() {    
    3.         //具体操作    
    4.     }    
    5. }    

     

    疑问

    思考

    一个请求发送者能否对应多个请求接收者？如何实现？
     

    3 完整解决方案

           为了降低功能键与功能处理类之间的耦合度，让用户可以自定义每一个功能键的功能，Sunny软件公司开发人员使用命令模式来设计“自定义功能键”模块，其核心结构如图4所示：

     

    图4 自定义功能键核心结构图

           在图4中，FBSettingWindow是“功能键设置”界面类，FunctionButton充当请求调用者，Command充当抽象命令类，MinimizeCommand和HelpCommand充当具体命令类，WindowHanlder和HelpHandler充当请求接收者。完整代码如下所示：

    [java] view plain copy
     
    1. import java.util.*;    
    2.     
    3. //功能键设置窗口类    
    4. class FBSettingWindow {    
    5.     private String title; //窗口标题    
    6.     //定义一个ArrayList来存储所有功能键    
    7.     private ArrayList<FunctionButton> functionButtons = new ArrayList<FunctionButton>();    
    8.         
    9.     public FBSettingWindow(String title) {    
    10.         this.title = title;    
    11.     }    
    12.         
    13.     public void setTitle(String title) {    
    14.         this.title = title;    
    15.     }    
    16.         
    17.     public String getTitle() {    
    18.         return this.title;    
    19.     }    
    20.         
    21.     public void addFunctionButton(FunctionButton fb) {    
    22.         functionButtons.add(fb);    
    23.     }    
    24.         
    25.     public void removeFunctionButton(FunctionButton fb) {    
    26.         functionButtons.remove(fb);    
    27.     }    
    28.         
    29.     //显示窗口及功能键    
    30.     public void display() {    
    31.         System.out.println("显示窗口：" + this.title);    
    32.         System.out.println("显示功能键：");    
    33.         for (Object obj : functionButtons) {    
    34.             System.out.println(((FunctionButton)obj).getName());    
    35.         }    
    36.         System.out.println("------------------------------");    
    37.     }       
    38. }    
    39.     
    40. //功能键类：请求发送者    
    41. class FunctionButton {    
    42.     private String name; //功能键名称    
    43.     private Command command; //维持一个抽象命令对象的引用    
    44.         
    45.     public FunctionButton(String name) {    
    46.         this.name = name;    
    47.     }    
    48.         
    49.     public String getName() {    
    50.         return this.name;    
    51.     }    
    52.         
    53.     //为功能键注入命令    
    54.     public void setCommand(Command command) {    
    55.         this.command = command;    
    56.     }    
    57.         
    58.     //发送请求的方法    
    59.     public void onClick() {    
    60.         System.out.print("点击功能键：");    
    61.         command.execute();    
    62.     }    
    63. }    
    64.     
    65. //抽象命令类    
    66. abstract class Command {    
    67.     public abstract void execute();    
    68. }    
    69.     
    70. //帮助命令类：具体命令类    
    71. class HelpCommand extends Command {    
    72.     private HelpHandler hhObj; //维持对请求接收者的引用    
    73.         
    74.     public HelpCommand() {    
    75.         hhObj = new HelpHandler();    
    76.     }    
    77.         
    78.     //命令执行方法，将调用请求接收者的业务方法    
    79.     public void execute() {    
    80.         hhObj.display();    
    81.     }    
    82. }    
    83.     
    84. //最小化命令类：具体命令类    
    85. class MinimizeCommand extends Command {    
    86.     private WindowHanlder whObj; //维持对请求接收者的引用    
    87.         
    88.     public MinimizeCommand() {    
    89.         whObj = new WindowHanlder();    
    90.     }    
    91.         
    92. //命令执行方法，将调用请求接收者的业务方法    
    93.     public void execute() {    
    94.         whObj.minimize();    
    95.     }    
    96. }    
    97.     
    98. //窗口处理类：请求接收者    
    99. class WindowHanlder {    
    100.     public void minimize() {    
    101.         System.out.println("将窗口最小化至托盘！");    
    102.     }    
    103. }    
    104.     
    105. //帮助文档处理类：请求接收者    
    106. class HelpHandler {    
    107.     public void display() {    
    108.         System.out.println("显示帮助文档！");    
    109.     }    
    110. }    

           为了提高系统的灵活性和可扩展性，我们将具体命令类的类名存储在配置文件中，并通过工具类XMLUtil来读取配置文件并反射生成对象，XMLUtil类的代码如下所示：

    [java] view plain copy
     
    1. public class XMLUtil {    
    2.     //该方法用于从XML配置文件中提取具体类类名，并返回一个实例对象      
    3.     public static Object getBean(String args) throws Exception {    
    4.         SAXReader reader = new SAXReader();    
    5.         String path = XMLUtil.class.getClassLoader().    
    6.                 getResource("com/somnus/designPatterns/command/config.xml").getPath();    
    7.         Document document = reader.read(new File(path));    
    8.         String cName = null;    
    9.         if(args.equals("firstCommand")) {      
    10.             cName = document.selectSingleNode("/config/firstCommand").getText();    
    11.                   
    12.         }else if(args.equals("secondCommand")) {      
    13.             //获取第二个包含类名的节点，即具体实现类      
    14.             cName = document.selectSingleNode("/config/secondCommand").getText();    
    15.         }     
    16.         //通过类名生成实例对象并将其返回      
    17.         Class<?> c = Class.forName(cName);      
    18.         Object obj = c.newInstance();      
    19.         return obj;      
    20.     }      
    21. }  

           配置文件config.xml中存储了具体建造者类的类名，代码如下所示：

    [java] view plain copy
     
    1. <?xml version="1.0" encoding="UTF-8"?>    
    2. <config>      
    3.     <firstCommand>com.somnus.designPatterns.command.HelpCommand</firstCommand>    
    4.     <secondCommand>com.somnus.designPatterns.command.MinimizeCommand</secondCommand>     
    5. </config>    

           编写如下客户端测试代码：

    [java] view plain copy
     
    1. public class Client {    
    2.     public static void main(String[] args) throws Exception {    
    3.         FBSettingWindow fbsw = new FBSettingWindow("功能键设置");      
    4.             
    5.         FunctionButton fb1,fb2;      
    6.         fb1 = new FunctionButton("功能键1");      
    7.         fb2 = new FunctionButton("功能键1");      
    8.               
    9.         Command command1,command2;      
    10.         //通过读取配置文件和反射生成具体命令对象      
    11.         command1 = (Command)XMLUtil.getBean("firstCommand");      
    12.         command2 = (Command)XMLUtil.getBean("secondCommand");      
    13.               
    14.         //将命令对象注入功能键      
    15.         fb1.setCommand(command1);      
    16.         fb2.setCommand(command2);      
    17.               
    18.         fbsw.addFunctionButton(fb1);      
    19.         fbsw.addFunctionButton(fb2);      
    20.         fbsw.display();      
    21.               
    22.         //调用功能键的业务方法      
    23.         fb1.onClick();      
    24.         fb2.onClick();      
    25.     }    
    26. }    

           编译并运行程序，输出结果如下：

    显示窗口：功能键设置

    显示功能键：

    功能键1

    功能键1

    ------------------------------

    点击功能键：显示帮助文档！

    点击功能键：将窗口最小化至托盘！

           如果需要修改功能键的功能，例如某个功能键可以实现“自动截屏”，只需要对应增加一个新的具体命令类，在该命令类与屏幕处理者(ScreenHandler)之间创建一个关联关系，然后将该具体命令类的对象通过配置文件注入到某个功能键即可，原有代码无须修改，符合“开闭原则”。在此过程中，每一个具体命令类对应一个请求的处理者（接收者），通过向请求发送者注入不同的具体命令对象可以使得相同的发送者对应不同的接收者，从而实现“将一个请求封装为一个对象，用不同的请求对客户进行参数化”，客户端只需要将具体命令对象作为参数注入请求发送者，无须直接操作请求的接收者。

    4 命令队列的实现

           有时候我们需要将多个请求排队，当一个请求发送者发送一个请求时，将不止一个请求接收者产生响应，这些请求接收者将逐个执行业务方法，完成对请求的处理。此时，我们可以通过命令队列来实现。

           命令队列的实现方法有多种形式，其中最常用、灵活性最好的一种方式是增加一个CommandQueue类，由该类来负责存储多个命令对象，而不同的命令对象可以对应不同的请求接收者，CommandQueue类的典型代码如下所示：

    [java] view plain copy
     
    1. import java.util.*;    
    2.     
    3. public class CommandQueue {    
    4.     //定义一个ArrayList来存储命令队列    
    5.     private ArrayList<Command> commands = new ArrayList<Command>();    
    6.         
    7.     public void addCommand(Command command) {    
    8.         commands.add(command);    
    9.     }    
    10.         
    11.     public void removeCommand(Command command) {    
    12.         commands.remove(command);    
    13.     }    
    14.         
    15.     //循环调用每一个命令对象的execute()方法    
    16.     public void execute() {    
    17.         for (Object command : commands) {    
    18.             ((Command)command).execute();    
    19.         }    
    20.     }    
    21. }    

           在增加了命令队列类CommandQueue以后，请求发送者类Invoker将针对CommandQueue编程，代码修改如下：

    [java] view plain copy
     
    1. public class Invoker {    
    2.     private CommandQueue commandQueue; //维持一个CommandQueue对象的引用    
    3.         
    4.     //构造注入    
    5.     public Invoker(CommandQueue commandQueue) {    
    6.         this. commandQueue = commandQueue;    
    7.     }    
    8.         
    9.     //设值注入    
    10.     public void setCommandQueue(CommandQueue commandQueue) {    
    11.         this.commandQueue = commandQueue;    
    12.     }    
    13.         
    14.     //调用CommandQueue类的execute()方法    
    15.     public void call() {    
    16.         commandQueue.execute();    
    17.     }    
    18. }    

           命令队列与我们常说的“批处理”有点类似。批处理，顾名思义，可以对一组对象（命令）进行批量处理，当一个发送者发送请求后，将有一系列接收者对请求作出响应，命令队列可以用于设计批处理应用程序，如果请求接收者的接收次序没有严格的先后次序，我们还可以使用多线程技术来并发调用命令对象的execute()方法，从而提高程序的执行效率。

    5 撤销操作的实现

           在命令模式中，我们可以通过调用一个命令对象的execute()方法来实现对请求的处理，如果需要撤销(Undo)请求，可通过在命令类中增加一个逆向操作来实现。

    微笑

    扩展

    除了通过一个逆向操作来实现撤销(Undo)外，还可以通过保存对象的历史状态来实现撤销，后者可使用备忘录模式(Memento Pattern)来实现。

           下面通过一个简单的实例来学习如何使用命令模式实现撤销操作：

           Sunny软件公司欲开发一个简易计算器，该计算器可以实现简单的数学运算，还可以对运算实施撤销操作。

           Sunny软件公司开发人员使用命令模式设计了如图5所示结构图，其中计算器界面类CalculatorForm充当请求发送者，实现了数据求和功能的加法类Adder充当请求接收者，界面类可间接调用加法类中的add()方法实现加法运算，并且提供了可撤销加法运算的undo()方法。

    图5  简易计算器结构图

           本实例完整代码如下所示：

    [java] view plain copy
     
    1. //加法类：请求接收者    
    2. public class Adder {    
    3.     private int num=0; //定义初始值为0    
    4.         
    5.     //加法操作，每次将传入的值与num作加法运算，再将结果返回    
    6.     public int add(int value) {    
    7.         num += value;    
    8.         return num;    
    9.     }    
    10. }    
    11.     
    12. //抽象命令类    
    13. public abstract class AbstractCommand {    
    14.     public abstract int execute(int value); //声明命令执行方法execute()    
    15.     public abstract int undo(); //声明撤销方法undo()    
    16. }    
    17.     
    18. //具体命令类    
    19. class ConcreteCommand extends AbstractCommand {    
    20.     private Adder adder = new Adder();    
    21.     private int value;    
    22.             
    23.     //实现抽象命令类中声明的execute()方法，调用加法类的加法操作    
    24. public int execute(int value) {    
    25.         this.value=value;    
    26.         return adder.add(value);    
    27.     }    
    28.         
    29.     //实现抽象命令类中声明的undo()方法，通过加一个相反数来实现加法的逆向操作    
    30.     public int undo() {    
    31.         return adder.add(-value);    
    32.     }    
    33. }    
    34.     
    35. //计算器界面类：请求发送者    
    36. public class CalculatorForm {    
    37.     private AbstractCommand command;    
    38.         
    39.     public void setCommand(AbstractCommand command) {    
    40.         this.command = command;    
    41.     }    
    42.         
    43.     //调用命令对象的execute()方法执行运算    
    44.     public void compute(int value) {    
    45.         int i = command.execute(value);    
    46.         System.out.println("执行运算，运算结果为：" + i);    
    47.     }    
    48.         
    49.     //调用命令对象的undo()方法执行撤销    
    50.     public void undo() {    
    51.         int i = command.undo();    
    52.         System.out.println("执行撤销，运算结果为：" + i);    
    53.     }    
    54. }  

           编写如下客户端测试代码：

    [java] view plain copy
     
    1. public class Client {    
    2.     public static void main(String args[]) {    
    3.         CalculatorForm form = new CalculatorForm();    
    4.         AbstractCommand command;    
    5.         command = new ConcreteCommand();    
    6.         form.setCommand(command); //向发送者注入命令对象    
    7.             
    8.         form.compute(10);    
    9.         form.compute(5);    
    10.         form.compute(10);    
    11.         form.undo();    
    12.     }    
    13. }    

            编译并运行程序，输出结果如下：

    执行运算，运算结果为：10

    执行运算，运算结果为：15

    执行运算，运算结果为：25

    执行撤销，运算结果为：15

    疑问

    思考

    如果连续调用“form.undo()”两次，预测客户端代码的输出结果。

           需要注意的是在本实例中只能实现一步撤销操作，因为没有保存命令对象的历史状态，可以通过引入一个命令集合或其他方式来存储每一次操作时命令的状态，从而实现多次撤销操作。除了Undo操作外，还可以采用类似的方式实现恢复(Redo)操作，即恢复所撤销的操作（或称为二次撤销）。

    微笑

    练习

    修改简易计算器源代码，使之能够实现多次撤销(Undo)和恢复(Redo)。

     

    6 请求日志

           请求日志就是将请求的历史记录保存下来，通常以日志文件(Log File)的形式永久存储在计算机中。很多系统都提供了日志文件，例如Windows日志文件、Oracle日志文件等，日志文件可以记录用户对系统的一些操作（例如对数据的更改）。请求日志文件可以实现很多功能，常用功能如下：

           (1) “天有不测风云”，一旦系统发生故障，日志文件可以为系统提供一种恢复机制，在请求日志文件中可以记录用户对系统的每一步操作，从而让系统能够顺利恢复到某一个特定的状态；

           (2) 请求日志也可以用于实现批处理，在一个请求日志文件中可以存储一系列命令对象，例如一个命令队列；

           (3) 可以将命令队列中的所有命令对象都存储在一个日志文件中，每执行一个命令则从日志文件中删除一个对应的命令对象，防止因为断电或者系统重启等原因造成请求丢失，而且可以避免重新发送全部请求时造成某些命令的重复执行，只需读取请求日志文件，再继续执行文件中剩余的命令即可。

           在实现请求日志时，我们可以将命令对象通过序列化写到日志文件中，此时命令类必须实现Java.io.Serializable接口。下面我们通过一个简单实例来说明日志文件的用途以及如何实现请求日志：

           Sunny软件公司开发了一个网站配置文件管理工具，可以通过一个可视化界面对网站配置文件进行增删改等操作，该工具使用命令模式进行设计，结构如图6所示：

    图6  网站配置文件管理工具结构图

           现在Sunny软件公司开发人员希望将对配置文件的操作请求记录在日志文件中，如果网站重新部署，只需要执行保存在日志文件中的命令对象即可修改配置文件。

           本实例完整代码如下所示：

    [java] view plain copy
     
    1. import java.io.*;    
    2. import java.util.*;    
    3.     
    4. //抽象命令类，由于需要将命令对象写入文件，因此它实现了Serializable接口    
    5. public abstract class Command implements Serializable {    
    6.     protected String name; //命令名称    
    7.     protected String args; //命令参数    
    8.     protected ConfigOperator configOperator; //维持对接收者对象的引用    
    9.         
    10.     public Command(String name) {    
    11.         this.name = name;    
    12.     }    
    13.         
    14.     public String getName() {    
    15.         return this.name;    
    16.     }    
    17.         
    18.     public void setName(String name) {    
    19.         this.name = name;    
    20.     }    
    21.         
    22.     public void setConfigOperator(ConfigOperator configOperator) {    
    23.         this.configOperator = configOperator;    
    24.     }    
    25.         
    26.     //声明两个抽象的执行方法execute()    
    27.     public abstract void execute(String args);    
    28.     public abstract void execute();    
    29. }    
    30.     
    31. //增加命令类：具体命令    
    32. public class InsertCommand extends Command {    
    33.     public InsertCommand(String name) {    
    34.         super(name);    
    35.     }    
    36.         
    37.     public void execute(String args) {    
    38.         this.args = args;    
    39.         configOperator.insert(args);    
    40.     }    
    41.         
    42.     public void execute() {    
    43.         configOperator.insert(this.args);    
    44.     }    
    45. }    
    46.     
    47. //修改命令类：具体命令    
    48. public class ModifyCommand extends Command {    
    49.     public ModifyCommand(String name) {    
    50.         super(name);    
    51.     }    
    52.         
    53.     public void execute(String args) {    
    54.         this.args = args;    
    55.         configOperator.modify(args);    
    56.     }    
    57.         
    58.     public void execute() {    
    59.         configOperator.modify(this.args);    
    60.     }    
    61. }    
    62.     
    63. //省略了删除命令类DeleteCommand    
    64.     
    65. //配置文件操作类：请求接收者。由于ConfigOperator类的对象是Command的成员对象，它也将随Command对象一起写入文件，因此ConfigOperator也需要实现Serializable接口    
    66. public class ConfigOperator implements Serializable {    
    67.     public void insert(String args) {    
    68.         System.out.println("增加新节点：" + args);    
    69.     }    
    70.         
    71.     public void modify(String args) {    
    72.         System.out.println("修改节点：" + args);    
    73.     }    
    74.         
    75.     public void delete(String args) {    
    76.         System.out.println("删除节点：" + args);    
    77.     }    
    78. }    
    79.     
    80. //配置文件设置窗口类：请求发送者    
    81. public class ConfigSettingWindow {    
    82.     //定义一个集合来存储每一次操作时的命令对象    
    83.     private ArrayList<Command> commands = new ArrayList<Command>();    
    84.     private Command command;     
    85.     
    86.     //注入具体命令对象    
    87.     public void setCommand(Command command) {    
    88.         this.command = command;    
    89.     }    
    90.         
    91.     //执行配置文件修改命令，同时将命令对象添加到命令集合中    
    92.     public void call(String args) {    
    93.         command.execute(args);    
    94.         commands.add(command);    
    95.     }    
    96.         
    97.     //记录请求日志，生成日志文件，将命令集合写入日志文件    
    98.     public void save() {    
    99.         FileUtil.writeCommands(commands);    
    100.     }    
    101.         
    102.     //从日志文件中提取命令集合，并循环调用每一个命令对象的execute()方法来实现配置文件的重新设置    
    103.     public void recover() {    
    104.         ArrayList list;    
    105.         list = FileUtil.readCommands();    
    106.             
    107.         for (Object obj : list) {    
    108.             ((Command)obj).execute();    
    109.         }    
    110.     }    
    111. }    
    112.     
    113. //工具类：文件操作类    
    114. public class FileUtil {    
    115.     //将命令集合写入日志文件    
    116.     public static void writeCommands(ArrayList commands) {    
    117.         try {    
    118.             FileOutputStream file = new FileOutputStream("config.log");    
    119.             //创建对象输出流用于将对象写入到文件中    
    120.             ObjectOutputStream objout = new ObjectOutputStream(new BufferedOutputStream(file));    
    121.             //将对象写入文件    
    122.             objout.writeObject(commands);    
    123.             objout.close();    
    124.             }    
    125.         catch(Exception e) {    
    126.                 System.out.println("命令保存失败！");      
    127.                 e.printStackTrace();    
    128.             }    
    129.     }    
    130.         
    131.     //从日志文件中提取命令集合    
    132.     public static ArrayList readCommands() {    
    133.         try {    
    134.             FileInputStream file = new FileInputStream("config.log");    
    135.             //创建对象输入流用于从文件中读取对象    
    136.             ObjectInputStream objin = new ObjectInputStream(new BufferedInputStream(file));    
    137.                 
    138.             //将文件中的对象读出并转换为ArrayList类型    
    139.             ArrayList commands = (ArrayList)objin.readObject();    
    140.             objin.close();    
    141.             return commands;    
    142.             }    
    143.         catch(Exception e) {    
    144.                 System.out.println("命令读取失败！");    
    145.                 e.printStackTrace();    
    146.                 return null;        
    147.             }           
    148.     }    
    149. }  



           编写如下客户端测试代码：

    [java] view plain copy
     
    1. public class Client {    
    2.     public static void main(String args[]) {    
    3.         ConfigSettingWindow csw = new ConfigSettingWindow(); //定义请求发送者    
    4.         Command command; //定义命令对象    
    5.         ConfigOperator co = new ConfigOperator(); //定义请求接收者    
    6.             
    7.         //四次对配置文件的更改    
    8.         command = new InsertCommand("增加");    
    9.         command.setConfigOperator(co);    
    10.         csw.setCommand(command);    
    11.         csw.call("网站首页");    
    12.             
    13.         command = new InsertCommand("增加");    
    14.         command.setConfigOperator(co);    
    15.         csw.setCommand(command);    
    16.         csw.call("端口号");    
    17.             
    18.         command = new ModifyCommand("修改");    
    19.         command.setConfigOperator(co);    
    20.         csw.setCommand(command);    
    21.         csw.call("网站首页");    
    22.             
    23.         command = new ModifyCommand("修改");    
    24.         command.setConfigOperator(co);    
    25.         csw.setCommand(command);            
    26.         csw.call("端口号");    
    27.             
    28.         System.out.println("----------------------------");    
    29.         System.out.println("保存配置");    
    30.         csw.save();    
    31.                 
    32.         System.out.println("----------------------------");     
    33.         System.out.println("恢复配置");    
    34.         System.out.println("----------------------------");     
    35.         csw.recover();      
    36.     }    
    37. }    

           编译并运行程序，输出结果如下：

    增加新节点：网站首页

    增加新节点：端口号

    修改节点：网站首页

    修改节点：端口号

    ----------------------------

    保存配置

    ----------------------------

    恢复配置

    ----------------------------

    增加新节点：网站首页

    增加新节点：端口号

    修改节点：网站首页

    修改节点：端口号
  • 相关阅读:
    为什么单个TCP连接很难占满带宽
    上传NUnit的单元测试结果和OpenCover的单元测试覆盖率到SonarQube服务中
    使用Visual Studio Code Coverage和nunit上传单元测试覆盖率和单元测试结果到SonarQube上
    java安装1.8的经验和Error: Registry key 'SoftwareJavaSoftJava Runtime Environment'CurrentVers问题处理
    NSubstitute.Analyzers检测NSubstitute用法冲突
    在TeamCity中执行gtest单元测试
    iOS OpenGL ES入门
    iOS 基础知识
    【内推】字节跳动-头条小说&番茄小说
    iOS开发小记（十四）
  • 原文地址：https://www.cnblogs.com/maohuidong/p/8099022.html
Copyright © 2011-2022 走看看