设计模式（二十二）Command模式

　　一个类在进行工作时会调用自己或者是其他类的方法，虽然调用结果会反映在对象的状态中，但并不会留下工作的历史记录。

 　　这时，如果我们有一个类，用来表示“请进行这项工作”的“命令”就会方便很多。每一项想做的工作就不再是“方法的调用”这种动态处理了，而是一个表示命令的类的实例，即可以用“物”表示。要想管理工作的历史记录，只需管理这些实例的集合即可，而且还可以随时再次执行过去的命令，或是将多个过去的命令整合为一个新命令并执行。

　　Command有时也被称为时间。当发生点击鼠标、按下键盘按键等事件时，我们可以先将这些事件作成实例，然后按照发生顺序放入队列中。接着，再依次去处理它们。

　　

　　示例程序要实现的功能是，用户拖动鼠标时程序会绘制出红色圆点，点击clear按钮后会清除所有的圆点。用户每拖动一次鼠标，应用程序都会为“在这个位置画一个点”这条命令生成一个DrawCommand类的实例。只要保存了这条命令，以后有需要时就可以重新绘制。

package bigjunoba.bjtu.command;

public interface Command {
    public abstract void execute();
}

　　Command接口是表示“命令”的接口。作用就是“执行”什么东西。

package bigjunoba.bjtu.command;

import java.util.Stack;
import java.util.Iterator;

public class MacroCommand implements Command {
    // 命令的集合
    private Stack<Command> commands = new Stack<Command>();
    // 执行
    public void execute() {
        Iterator<Command> it = commands.iterator();
        while (it.hasNext()) {
            ((Command)it.next()).execute();
        }
    }
    // 添加命令，同时防止不小心将自己（this）添加进去。
    public void append(Command cmd) {
        if (cmd != this) {
            commands.push(cmd);
        }
    }
    // 删除push方法添加的最后一条命令
    public void undo() {
        if (!commands.empty()) {
            commands.pop();
        }
    }
    // 删除所有命令
    public void clear() {
        commands.clear();
    }
}

　　MacroCommand类表示“由多条命令整合成的命令”。该类实现了Command接口。commands字段是Stack类型的，它是保存了多个Command(即实现了Command接口的实例)的集合。

package bigjunoba.bjtu.drawer;

import bigjunoba.bjtu.command.*;
import java.awt.Point;

public class DrawCommand implements Command {
    // 绘制对象
    protected Drawable drawable;
    // 绘制位置
    private Point position;
    // 构造函数
    public DrawCommand(Drawable drawable, Point position) {
        this.drawable = drawable;
        this.position = position;
    }
    // 执行
    public void execute() {
        drawable.draw(position.x, position.y);
    }
}

　　DrawCommand类实现了Command接口，表示“绘制一个点的命令”。构造函数的作用是生成“在这个位置绘制点”的命令。execute方法的作用是执行命令。

package bigjunoba.bjtu.drawer;

public interface Drawable {
    public abstract void draw(int x, int y);
}

　　Drawable接口是表示“绘制对象”的接口。draw方法是用于绘制的方法。

package bigjunoba.bjtu.drawer;

import bigjunoba.bjtu.command.*;
import java.util.*;
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;

public class DrawCanvas extends Canvas implements Drawable {
    // 颜色
    private Color color = Color.red;
    // 要绘制的圆点的半径
    private int radius = 6;
    // 命令的历史记录
    private MacroCommand history;
    // 构造函数
    public DrawCanvas(int width, int height, MacroCommand history) {
        setSize(width, height);
        setBackground(Color.white);
        this.history = history;
    }
    // 重新全部绘制
    public void paint(Graphics g) {
        history.execute();
    }
    // 绘制
    public void draw(int x, int y) {
        Graphics g = getGraphics();
        g.setColor(color);
        g.fillOval(x - radius, y - radius, radius * 2, radius * 2);     //画圆点
    }
}

　　history字段中保存的是DrawCanvas类自己应当执行的绘制命令的集合。该字段是Command.MacroCommand类型的。当需要重新绘制DrawCanvas是，java处理会调用paint方法。它所做的事情仅仅是调用了history.excute方法。这样，记录在history中的所有历史命令都会被重新执行一遍。

package bigjunoba.bjtu.test;

import bigjunoba.bjtu.command.*;
import bigjunoba.bjtu.drawer.*;

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;

public class Main extends JFrame implements ActionListener, MouseMotionListener, WindowListener {
    // 绘制的历史记录
    private MacroCommand history = new MacroCommand();
    // 绘制区域
    private DrawCanvas canvas = new DrawCanvas(400, 400, history);
    // 删除按钮
    private JButton clearButton  = new JButton("clear");

    // 构造函数
    public Main(String title) {
        super(title);

        this.addWindowListener(this);
        canvas.addMouseMotionListener(this);
        clearButton.addActionListener(this);

        Box buttonBox = new Box(BoxLayout.X_AXIS);
        buttonBox.add(clearButton);
        Box mainBox = new Box(BoxLayout.Y_AXIS);
        mainBox.add(buttonBox);
        mainBox.add(canvas);
        getContentPane().add(mainBox);

        pack();
        show();
    }

    // ActionListener接口中的方法
    public void actionPerformed(ActionEvent e) {
        if (e.getSource() == clearButton) {
            history.clear();
            canvas.repaint();
        }
    }

    // MouseMotionListener接口中的方法
    public void mouseMoved(MouseEvent e) {
    }
    public void mouseDragged(MouseEvent e) {
        Command cmd = new DrawCommand(canvas, e.getPoint());
        history.append(cmd);
        cmd.execute();
    }

    // WindowListener接口中的方法
    public void windowClosing(WindowEvent e) {
        System.exit(0);
    }
    public void windowActivated(WindowEvent e) {}
    public void windowClosed(WindowEvent e) {}
    public void windowDeactivated(WindowEvent e) {}
    public void windowDeiconified(WindowEvent e) {}
    public void windowIconified(WindowEvent e) {}
    public void windowOpened(WindowEvent e) {}

    public static void main(String[] args) {
        new Main("Command Pattern Sample");
    }
}

　　Main类实现了mouseDragged方法，当鼠标被拖动时，会生成一条“在这个位置画点”的命令，Command cmd = new DrawCommand(canvas, e.getPoint());该命令会先被添加至绘制历史记录中，history.append(cmd);然后立即执行，cmd.execute();。

　　测试结果如上图所示。

　　示例程序的时序图。

　　Command模式的类图。