Шаблоны команд в Spring Framework

«Инкапсулируйте запрос как объект, что позволит вам параметрировать клиентов с различными запросами, запросами очереди или журнала и поддерживать отмену операций».

Шаблоны проектирования: элементы многоразового объектно-ориентированного программного обеспечения

Командный шаблон является одним из 11 шаблонов дизайна семейства паттернов «  Банды четырех»  . Мы уже узнали о   паттерне цепочки ответственности , и, аналогично этому и другим паттернам семейства, паттерн команд описывает обязанности объектов в приложении и то, как они взаимодействуют между ними.

Шаблон команды: Введение

Связь между объектами в корпоративных приложениях начинается с объекта, отправляющего запрос другому объекту. Объект, принимающий запрос, может либо обработать запрос и отправить обратно ответ, либо перенаправить запрос другому объекту для обработки. Обычно запросы отправляются вызывающим (объект, отправляющий запрос) через вызовы методов объекта, который обрабатывает запрос, который мы будем называть получателем. В результате, вызывающая сторона и получатель тесно связаны. Это нарушает   принципы разработки SOLID, которые защищают слабосвязанные компоненты, чтобы гарантировать, что изменения, внесенные в один компонент, не влияют на другие компоненты приложения.

Командный шаблон — это проверенное решение, которое решает такие постоянно возникающие проблемы в приложениях, которые тесно связаны между собой. Этот шаблон утверждает, что запросы должны быть инкапсулированы как объекты, которые, как и любые другие объекты, могут быть сохранены и переданы приложению. Запросы, заключенные в объекты, называются командами.

В шаблоне команд вызывающий передает команды, ничего не зная о получателе. Фактически, вызывающий, выдающий команду, даже не знает, какая операция будет выполнена при выдаче команды. Давайте посмотрим на это с точки зрения программирования.

Командный объект в основном имеет   метод execute () и необязательный   метод undo () . Метод  execute ()  выполняет некоторую операцию с получателем, а метод  undo ()  отменяет текущую операцию. Выполнение операции осуществляется получателем. Вызывающий только устанавливает себя с объектом команды и вызывает команду, вызывая метод  execute ()  . Вызывающий не знает, что  будет делать метод execute () .

Представьте, что invoker является переключателем. Когда invoker вызывает команду, вызывая метод  execute ()  объекта команды, он может включить свет или даже запустить генератор. По сути, это означает, что один и тот же invoker (switch) может использоваться для вызова команд для выполнения действий на разных приемниках (устройствах). Нам нужно только создать соответствующий объект команды и установить его на вызывающем. Как видно, применяя шаблон команд, мы можем перенести возможность многократного использования на другой уровень, и это стало возможным благодаря слабой связи между вызывающим и получателем и объектом команды, который действует как интерфейс между ними.

Участники Командной Выкройки

Прежде чем углубляться в участников Командного шаблона и их роли, давайте начнем с аналогии с игрушками с дистанционным управлением.

Представьте себе компанию по производству игрушек, которая недавно решила производить игрушки с дистанционным управлением. Они начали с машины с дистанционным управлением. Пульт дистанционного управления имеет три кнопки: Вкл., Выкл. И Отмена. Пульт дистанционного управления запрограммирован таким образом, что кнопка «Вкл» перемещает автомобиль, кнопка «Выкл.» Останавливает его, а кнопка «Отмена» изменяет текущее действие автомобиля. Автомобиль с дистанционным управлением имел успех, и затем руководство приняло решение изготовить вращающийся верх с дистанционным управлением. Снова, вместе с верхом, был изготовлен новый пульт дистанционного управления, запрограммированный для запуска и остановки вращения и реверсирования текущего действия верха. Руководствуясь успехом игрушек с дистанционным управлением, руководство решило изготовить 200 разновидностей игрушек с дистанционным управлением, каждая из которых была запрограммирована по-разному для управления соответствующей игрушкой.Представьте себя в команде программистов. Вам необходимо создать 200 различных программ для пультов дистанционного управления, каждая из которых предназначена для работы с определенной игрушкой. Видимо плохое дизайнерское решение из-за невозможности повторного использования кода. Причина также очевидна. Каждый пульт дистанционного управления тесно связан с игрушкой, на которой он работает. Нам нужен пульт дистанционного управления, который запрограммирован для работы со всеми игрушками, и вот тут на помощь приходит модель командования.и вот где командный паттерн приходит на помощь.и вот где командный паттерн приходит на помощь.

Давайте посмотрим, как мы можем применить шаблон в качестве решения. Игрушки являются приемниками и выполняют действия. Давайте смоделируем два приемника как  Car  и  RotatingTop . Эти классы имеют поведения в виде методов для выполнения действий. Например, у  автомобильного  приемника будут методы перемещения и остановки, а у  RotatingTop  будут методы запуска и остановки вращения.

Далее мы смоделируем команды, которые будут запускать действия на приемниках. Мы начнем с  интерфейса CommandBase  с двумя методами  execute ()  и  undo () . Каждый конкретный подкласс  CommandBase  представляет команду для запуска действия на получателе, и для этого он поддерживает ссылку на получателя, действие которого он инициирует. Для   приемников Car  и  RotatingTop давайте смоделируем конкретные классы команд как CarMoveCommand ,  CarStopCommand ,  TopRotateCommand и  TopStopRotateCommand . Наконец, мы смоделируем invoker как  RemoteControl учебный класс. Этот класс не знает ни о каком конкретном командном классе. Всякий раз, когда нажимается одна из ее кнопок, метод, обрабатывающий событие нажатия, вводится с помощью соответствующего объекта команды во время выполнения, и вызывающий вызывает для него метод  execute ()  .

В контексте примера игрушек с дистанционным управлением давайте подведем итоги участникам шаблона командования.

• Command  ( CommandBase ): интерфейс для выполнения действия.
• ConcreteCommand  ( CarMoveCommand ,  CarStopCommand ,  TopRotateCommand и TopStopRotateCommand ): являются конкретными классами, которые реализуют  Command  и определяют   методы execute ()  и undo () для взаимодействия с получателями для выполнения действия и его отмены соответственно.
• Invoker ( RemoteControl ): просит  командование  выполнить действие.
• Receiver  ( Car  and  RotatingTop ): выполняет действие в зависимости от получаемой команды.
• Клиент : Создает   объект ConcreteCommand и устанавливает его получателя.

На следующем рисунке показаны отношения между участниками.

Применение шаблона команды

Давайте реализуем пример игрушек с дистанционным управлением в коде Java. Начнем с приемников.

Car.java

package guru.springframework.gof.command.receiver;
 
 
public class Car {
    public void move()
    {
        System.out.println("Car is moving");
    }
    public void stop()
    {
        System.out.println("Car has stopped");
    }
}

package guru.springframework.gof.command.receiver;
 
 
public class RotatingTop {
    public void startRotating(){
        System.out.println("Top has start rotating");
    }
    public void stopRotating(){
        System.out.println("Top has stopped rotating");
    }
}

package guru.springframework.gof.command.commandobjects;
 
 
public interface CommandBase {
    void execute();
    void undo();
}

package guru.springframework.gof.command.commandobjects;
 
import guru.springframework.gof.command.receiver.Car;
 
public class CarMoveCommand implements CommandBase {
    private Car car;
    public CarMoveCommand(Car car){
        this.car=car;
    }
    @Override
    public void execute(){
       System.out.println("CarMoveCommand.execute(): Invoking move() on Car");
        car.move();
    }
    @Override
    public void undo(){
      System.out.println("CarMoveCommand.undo():  Undoing previous action->Invoking stop() on Car");
      car.stop();
 
    }
}

package guru.springframework.gof.command.commandobjects;
 
 
import guru.springframework.gof.command.receiver.Car;
 
public class CarStopCommand implements CommandBase{
    private Car car;
    public CarStopCommand(Car car){
        this.car=car;
    }
    @Override
    public void execute(){
        System.out.println("CarStopCommand.execute(): Invoking stop() on Car");
        car.stop();
    }
    @Override
    public void undo()
    {
        System.out.println("CarStopCommand.undo(): Undoing previous action-> Invoking move() on Car");
        car.move();
    }
}

package guru.springframework.gof.command.commandobjects;
 
 
import guru.springframework.gof.command.receiver.RotatingTop;
 
public class TopRotateCommand implements CommandBase{
    RotatingTop rotatingTop;
    public  TopRotateCommand(RotatingTop rotatingTop){
        this.rotatingTop=rotatingTop;
    }
    @Override
    public void execute(){
     System.out.println("TopRotateCommand.execute(): Invoking startRotating() on RotatingTop");
      rotatingTop.startRotating();
    }
    @Override
    public void undo(){
        System.out.println("TopRotateCommand.undo(): Undoing previous action->Invoking stopRotating() on RotatingTop");
        rotatingTop.stopRotating();
    }
}

package guru.springframework.gof.command.commandobjects;
 
 
import guru.springframework.gof.command.receiver.RotatingTop;
 
public class TopStopRotateCommand implements CommandBase{
    RotatingTop rotatingTop;
    public TopStopRotateCommand(RotatingTop rotatingTop){
        this.rotatingTop=rotatingTop;
    }
    @Override
    public void execute(){
        System.out.println("TopStopRotateCommand.execute(): Invoking stopRotating() on RotatingTop");
        rotatingTop.stopRotating();
    }
    @Override
    public void undo(){
        System.out.println("TopStopRotateCommand.undo(): Undoing previous action->Invoking startRotating() on RotatingTop");
        rotatingTop.startRotating();
    }
}

package guru.springframework.gof.command.invoker;
 
 
import guru.springframework.gof.command.commandobjects.CommandBase;
 
public class RemoteControl {
    CommandBase onCommand, offCommand, undoCommand;
 
    public void onButtonPressed(CommandBase onCommand){
       this.onCommand=onCommand;
       onCommand.execute();
       undoCommand=onCommand;
    }
 
    public void offButtonPressed(CommandBase offCommand){
        this.offCommand=offCommand;
        offCommand.execute();
        undoCommand=offCommand;
    }
    public void undoButtonPressed(){
         undoCommand.undo();
    }
 
}

package guru.springframework.gof.command.invoker;
 
import guru.springframework.gof.command.commandobjects.*;
import guru.springframework.gof.command.receiver.Car;
import guru.springframework.gof.command.receiver.RotatingTop;
import org.junit.Test;
 
import static org.junit.Assert.*;
 
public class RemoteControlTest {
    @Test
    public void testRemoteControlButtonPressed() throws Exception {
        RemoteControl remoteControl=new RemoteControl();
        System.out.println("-----Testing onButtonPressed on RemoteControl for Car-----");
        Car car=new Car();
        CommandBase carMoveCommand=new CarMoveCommand(car);
        remoteControl.onButtonPressed(carMoveCommand);
        System.out.println("-----Testing offButtonPressed on RemoteControl for Car-----");
        CommandBase carStopCommand=new CarStopCommand(car);
        remoteControl.offButtonPressed(carStopCommand);
        System.out.println("-----Testing undoButtonPressed() on RemoteControl for Car-----");
        remoteControl.undoButtonPressed();
 
        System.out.println("-----Testing onButtonPressed on RemoteControl for RotatingTop-----");
        RotatingTop top=new RotatingTop();
        CommandBase topRotateCommand=new TopRotateCommand(top);
        remoteControl.onButtonPressed(topRotateCommand);
 
        System.out.println("-----Testing offButtonPressed on RemoteControl for RotatingTop-----");
        CommandBase topStopRotateCommand=new TopStopRotateCommand(top);
        remoteControl.offButtonPressed(topStopRotateCommand);
 
       System.out.println("-----Testing undoButtonPressed on RemoteControl for RotatingTop-----");
 
        remoteControl.undoButtonPressed();
 
 
    }
 
 
}

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running guru.springframework.gof.command.invoker.RemoteControlTest
-----Testing onButtonPressed on RemoteControl for Car-----
CarMoveCommand.execute(): Invoking move() on Car
Car is moving
-----Testing offButtonPressed on RemoteControl for Car-----
CarStopCommand.execute(): Invoking stop() on Car
Car has stopped
-----Testing undoButtonPressed() on RemoteControl for Car-----
CarStopCommand.undo(): Undoing previous action-> Invoking move() on Car
Car is moving
-----Testing onButtonPressed on RemoteControl for RotatingTop-----
TopRotateCommand.execute(): Invoking startRotating() on RotatingTop
Top has start rotating
-----Testing offButtonPressed on RemoteControl for RotatingTop-----
TopStopRotateCommand.execute(): Invoking stopRotating() on RotatingTop
Top has stopped rotating
-----Testing undoButtonPressed on RemoteControl for RotatingTop-----
TopStopRotateCommand.undo(): Undoing previous action->Invoking startRotating() on RotatingTop
Top has start rotating
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.003 sec - in guru.springframework.gof.command.invoker.RemoteControlTest