当项目中有QGraphicsView视图直接修改图元的功能时,常会有Ctri+Z和Ctrl+Y这种执行与撤销图元修改的功能,以便于在修改图元后能够进行一个还原/执行操作,此时就适合使用命令模式设计来实现这个功能。
以下示例在WINDOWS系统,Qt Creator 5.13.1,MSCV2017 X64 Release环境实现,以及涉及QStack类的使用。
目录导读
- 一、命令模式详解
- 二、命令模式的应用场景
- 二、QStack类详解
- 三、QGraphicsView视图-修改还原-命令模式案例实现
- 命令角色(Command) 接口实现
- 请求者(Invoker)功能实现
- 具体命令(ConcreteCommand)实现
- 1. 窗体拖拽的上下左右平移命令对象
- 2. 对场景类的缩放和放大命令
- 3. 新增图元命令对象
- 4. 删除图元命令对象
- 接收者(Receiver)实现
- 命令模式 缺点
一、命令模式详解
在诸多设计模式中,命令模式适用范围非常广泛,比如工业设计,CAD二开,流程图设计等,都经常能看到命令模式的设计模块和功能实现。
有时候在工作中为了尽快完成功能,基本都是面向过程开发,不会过多的使用一些设计模式,但是在面试中,只要工作年限有个两三年的,面试官都基本会问一句了解那些设计模式,谈谈具体的使用,无一例外!
所以日常中可以不用设计模式开发,但是不能不了解,特别是单例模式,提到的概率特别高!
命令模式是一种设计模式,它将请求或操作封装在对象中,并将这些对象传递给调用对象。该模式的意图是将请求发送者与实际执行操作的接收者解耦,使得发送者和接收者可以独立变化。
在命令模式中,
主要有三个角色:
- 命令(Command):定义了执行操作的接口,通常包含一个execute方法,用于调用具体的操作。
- 具体命令(Concrete_Command):实现了命令接口,负责执行具体的操作。它通常包含了对接收者的引用,通过调用接收者的方法来完成请求的处理。
- 接收者(Receiver):知道如何执行与请求相关的操作,实际执行命令的对象。
其他角色:
- 调用者/请求者(Invoker):
发送命令的对象,它包含了一个或多个命令对象并能触发命令的执行。调用者并不直接处理请求,而是通过将请求传递给命令对象来实现。 - 客户端(Client):
创建具体命令对象并设置其接收者,将命令对象交给调用者执行。
命令模式结构示意图(命令模式 | 菜鸟教程):
命令模式的核心思想是将请求以命令的形式封装在对象中,并传给调用对象。调用对象寻找可以处理该命令的合适的对象,并把该命令传给相应的对象,该对象执行命令。这种设计使得请求的一方不必知道接收请求的一方的接口,更不必知道请求是怎么被接收,以及操作是否被执行、何时被执行,以及是怎么被执行的。
命令模式的主要优点是降低了系统耦合度,使得请求的一方和接收的一方独立开来,可以独立变化。新的命令可以很容易添加到系统中去。但是,使用命令模式可能会导致某些系统有过多的具体命令类。
总之,命令模式是一种将请求或操作封装在对象中,并将这些对象传递给调用对象的设计模式,它使得请求的一方和接收的一方解耦,可以独立变化。
文章参考:
- 命令模式 | 菜鸟教程
- 设计模式(行为型模式)之:命令模式(Command Pattern)
- 【设计模式】命令模式 ( 简介 | 适用场景 | 优缺点 | 代码示例 )
- 技术分享 | 什么是命令模式
二、命令模式的应用场景
命令模式的应用场景主要有以下几个方面:
- 多级撤销/重做: 如果系统需要实现多级撤销或重做操作,可以将命令对象存储在历史栈中,通过调用命令对象的undo和redo方法来实现撤销和重做。
- 事务处理: 借助命令模式,可以简单地实现一个具有原子事务的行为。
- 进度条: 如果系统需要按顺序执行一系列的命令操作,可以通过调用每个命令对象的getEstimatedDuration方法来评估执行状态并显示出合适的进度条。
- 网络通信: 通过网络发送命令到其他机器上运行。
- 日志系统: 可以将请求以命令的形式记录在日志中,方便日后审计和重放。
- 游戏开发: 在游戏开发中,命令模式常被用于实现游戏逻辑,如移动、攻击等。
- GUI开发: 在GUI开发中,命令模式可以用于实现撤销、重做等功能。
- 自动化测试: 将测试用例封装为命令对象,方便测试的执行和管理。
- 批处理: 将一系列操作封装成命令对象,然后按照顺序或并行执行这些命令对象,以完成批量处理任务。
- 游戏AI: 在游戏AI中,可以使用命令模式来封装玩家的操作,然后由AI实体来解析和执行这些命令。
总之,命令模式的应用场景非常广泛,只要是需要将请求或操作封装在对象中,并传递给调用对象的情况,都可以考虑使用命令模式。
应用场景说明来自于文言一心,
如果工作中遇到以上应用场景示例,建议直接使用命令模式开发,别管会不会,多报错几次、多掉点头发就会了!
二、QStack类详解
在涉及到QGraphicsView视图修改图元操作,也就是 多级撤销/重做 这种应用场景,这种情况下需要一个堆栈来保存命令的多个对象,并且这个堆栈必须符合 后进先出 的特点,这样才能保证最后一次修改的功能最先被还原的。
QStack(Qt Stack)是一个来自于Qt框架的容器类,类似于C++标准库中的std::stack。QStack容器是一种后进先出(LIFO)的数据结构,即最后一个进入堆栈的元素将最先被移除。QStack继承了QVector,所以它拥有QVector的所有功能,同时提供了堆栈的特定操作。
具体关于QStack 内容建议参考:
Qt QStack 详解:从底层原理到高级用法
描述的相当详细,老厉害了!
三、QGraphicsView视图-修改还原-命令模式案例实现
在QGraphicsView视图对图元进行一个增加、删除、改变大小、移动图元等一系列操作时,使用命令模式来执行/撤销修改动作命令,也就是常说的修改还原功能。
命令角色(Command) 接口实现
在操作图元时,增加、删除、改变大小、移动图元等就是一个个命令,而这些命令只有两个相同的动作,撤销命令和执行命令:
所以声明一个通用的 Command 接口类,
#include <QObject>
/// <summary>
/// 定义一个命令角色。一般是一个接口,为所有的命令对象声明一个接口,规范将要进行的命令操作。Command
/// 命令角色(Command): 定义命令的接口,声明执行的方法。这是一个抽象类。
/// </summary>
class Command : public QObject
{
Q_OBJECT
public:
explicit Command(QObject *parent = nullptr);
virtual ~Command(){delete this;}
///
/// \brief 执行命令
///
virtual void execute() const=0; //MSCV写法 如果加上const 就必须赋值
///
/// \brief 撤销命令
///
virtual void undo() const=0;
///
/// \brief 是否更新数据
///是否需要刷新数据
///用于一些操作需要更新数据源的实现
/// 当前用处不大 如果涉及到数据的交互此时就需要,此处只是给个示范
/// \return
virtual bool isrefresh_data() const{
return false;
}
};
需要注意的是:
在MSCV编译器中,无论是否添加const ,纯虚函数一定要加 =0,否则编译不通过。
如:virtual void undo() const=0;
或者virtual void undo() =0;
而在Mingw编译器中不加。
请求者(Invoker)功能实现
请求者角色(Invoker):要求命令对象执行请求,通常会持有命令对象,可以持有很多的命令对象。 这个是客户端真正触发命令并要求命令执行相应操作的地方,也就是说相当于使用命令对象的入口。
这个类一般包含在QGraphicsView类的属性中,用于存储增加、删除、改变大小、移动图元等一系列命令对象。
Invoker_Command.h 头文件
#include <QObject>
#include <QWidget>
#include <QStack>
#include <QObject>
#include <QWidget>
#include <QMessageBox>
#include "command.h"
/// <summary>
/// 请求者角色(Invoker):要求命令对象执行请求,通常会持有命令对象,可以持有很多的命令对象。
/// 这个是客户端真正触发命令并要求命令执行相应操作的地方,也就是说相当于使用命令对象的入口。
///
/// 持有一个命令对象,有一个行动方法,在某个时间点调用命令对象的 execute() 方法,将请求付诸实行。
/// </summary>
class Invoker_Command:public QObject
{
Q_OBJECT
public:
Invoker_Command(QObject *parent = nullptr);
///撤销队列 先进后出
QStack<Command*>* undoStack = new QStack<Command*>();
///执行队列 先进后出
QStack<Command*>* redoStack = new QStack<Command*>();
///插入命令角色
void SetCommad(Command* _com);
///
/// \brief 撤销动作
///
void UndoStack();
///
/// \brief 执行动作
///
void RedoStack();
///
/// \brief 清除所有队列
///
void clearall();
signals:
///发送撤销和还原的缓存数量 用于界面上使用,
///甚至可以扩展为选定某一端前还原,部分CAD软件软件就有这种功能
void stack_count(int undocount,int redocount);
///数据刷新,修改界面一些属性
void data_update();
};
Invoker_Command.cpp 头文件
#include "invoker_command.h"
#include <QDebug>
Invoker_Command::Invoker_Command(QObject *parent)
:QObject(parent)
{
}
void Invoker_Command::SetCommad(Command* _com)
{
redoStack->clear();
undoStack->push(_com);
if(_com->isrefresh_data())
emit data_update();
emit stack_count(undoStack->count(),redoStack->count());
}
void Invoker_Command::UndoStack()
{
if (undoStack->count() == 0)
{
QMessageBox::information((QWidget *)this->parent(),tr("提示"),tr("无可撤销项!"));
return;
}
Command* com = undoStack->pop();
com->undo();
if(com->isrefresh_data())
emit data_update();
redoStack->push(com);
emit stack_count(undoStack->count(),redoStack->count());
}
void Invoker_Command::RedoStack()
{
if (redoStack->count() == 0)
{
QMessageBox::information((QWidget *)this->parent(),tr("提示"),tr("无可执行项!"));
return;
}
Command* com = redoStack->pop();
com->execute();
if(com->isrefresh_data())
emit data_update();
undoStack->push(com);
emit stack_count(undoStack->count(),redoStack->count());
}
void Invoker_Command::clearall()
{
redoStack->clear();
undoStack->clear();
emit stack_count(undoStack->count(),redoStack->count());
}
注意: 在添加一个命令对象时,需要清空可执行队列,否则会造成数据混乱。
具体命令(ConcreteCommand)实现
1. 窗体拖拽的上下左右平移命令对象
视窗显示内容的切换,实际就是两个的点之间的视窗移动,所以这里只需要记录前后两个基准点就行;
Order_View_Move.h
/窗体拖拽的上下左右平移 命令对象
/ 实际上是两个的点之间的视窗移动
class Order_View_Move:public Command
{
Q_OBJECT
public:
explicit Order_View_Move(QPointF _oldpos,QPointF _newpos,QObject *parent = nullptr);
~Order_View_Move() Q_DECL_OVERRIDE {}
///
/// 执行命令
///
void execute() const Q_DECL_OVERRIDE ;
///
/// 撤销命令
///
void undo() const Q_DECL_OVERRIDE ;
public:
bool isrefresh_data() const Q_DECL_OVERRIDE{return false;}
private:
QPointF Oldpos;
QPointF Newpos;
};
Order_View_Move.cpp
Order_View_Move::Order_View_Move(QPointF _oldpos,QPointF _newpos,QObject *parent )
:Command(parent),Oldpos(_oldpos),Newpos(_newpos)
{
}
void Order_View_Move::execute() const
{
if(this->parent()!=nullptr)
{
//QGraphicsViewRefactor 继承的 QGraphicsView ,重构类
QGraphicsViewRefactor* view=qobject_cast<QGraphicsViewRefactor*>(this->parent());
if(view!=nullptr )
{
QPointF disPointF =Newpos - Oldpos ;
//调整位置
view->scene()->setSceneRect( view->scene()->sceneRect().x()-disPointF.x(),
view->scene()->sceneRect().y()-disPointF.y(),
view->scene()->sceneRect().width(),
view->scene()->sceneRect().height());
view->scene()->update();
}
}
}
void Order_View_Move::undo() const
{
if(this->parent()!=nullptr)
{
QGraphicsViewRefactor* view=qobject_cast<QGraphicsViewRefactor*>(this->parent());
if(view!=nullptr )
{
QPointF disPointF =Oldpos - Newpos ;
//调整位置
view->scene()->setSceneRect( view->scene()->sceneRect().x()-disPointF.x(),
view->scene()->sceneRect().y()-disPointF.y(),
view->scene()->sceneRect().width(),
view->scene()->sceneRect().height());
view->scene()->update();
}
}
}
2. 对场景类的缩放和放大命令
对QGraphicsScene 场景类放大缩小需要保存三个参数;
int Delta;
判断放大还是缩小
double mom;
放大缩小倍数
QPointF Pos;
放大缩小的基准点
Order_View_Scale.h
/ <summary>
/ 命令对象
/ 对场景类的 缩放 和 放大
/ <summary>
class Order_View_Scale:public Command
{
Q_OBJECT
public:
explicit Order_View_Scale(int _delta,double _mom,QPointF _Pos,QObject *parent = nullptr);
~Order_View_Scale() Q_DECL_OVERRIDE {}
///
/// 执行命令
///
void execute() const Q_DECL_OVERRIDE;
///
/// 撤销命令
///
void undo() const Q_DECL_OVERRIDE;
private:
int Delta;
double mom;
QPointF Pos;
public:
bool isrefresh_data() const Q_DECL_OVERRIDE{return false;}
};
Order_View_Scale.cpp
Order_View_Scale::Order_View_Scale(int _delta,double _mom,QPointF _Pos,QObject *parent)
:Command(parent),Delta(_delta),mom(_mom),Pos(_Pos)
{
}
void Order_View_Scale::execute() const
{
if(this->parent()!=nullptr)
{
QGraphicsViewRefactor* ride=qobject_cast<QGraphicsViewRefactor*>(this->parent());
if(Delta>0)
{
ride->scale_Sum=ride->scale_Sum*mom;
ride->Setwheelscale(mom,mom,Pos);
emit ride->Scale_Sum_Change(ride->scale_Sum);
}
else
{
ride->scale_Sum=ride->scale_Sum/mom;
ride->Setwheelscale(1.0 / mom, 1.0 / mom,Pos);
emit ride->Scale_Sum_Change(ride->scale_Sum);
}
}
}
void Order_View_Scale::undo() const
{
if(this->parent()!=nullptr)
{
QGraphicsViewRefactor* ride=qobject_cast<QGraphicsViewRefactor*>(this->parent());
if(!(Delta>0))
{
ride->scale_Sum=ride->scale_Sum*mom;
ride->Setwheelscale(mom,mom,Pos);
emit ride->Scale_Sum_Change(ride->scale_Sum);
}
else
{
ride->scale_Sum=ride->scale_Sum/mom;
ride->Setwheelscale(1.0 / mom, 1.0 / mom,Pos);
emit ride->Scale_Sum_Change(ride->scale_Sum);
}
}
}
3. 新增图元命令对象
新增图元执行动作就是将图元加进QGraphicsScene 场景类 中,撤销动作就是将新增图元从QGraphicsScene 场景类 中删除。
同时使用 QList<QGraphicsItem*> AddtoItems;
保存图元数据。
Order_Append_FlowItem.h
/ <summary>
/ 命令对象
/ 各種图元的新增
/ <summary>
class Order_Append_FlowItem:public Command
{
Q_OBJECT
public:
explicit Order_Append_FlowItem(QList<QGraphicsItem*> _AddtoItems,QObject *parent = nullptr);
~Order_Append_FlowItem() Q_DECL_OVERRIDE {}
///
/// 执行命令
///
void execute() const Q_DECL_OVERRIDE;
///
/// 撤销命令
///
void undo() const Q_DECL_OVERRIDE;
private:
QList<QGraphicsItem*> AddtoItems;
public:
bool isrefresh_data() const Q_DECL_OVERRIDE{return true;}
};
Order_Append_FlowItem.cpp
Order_Append_FlowItem::Order_Append_FlowItem(QList<QGraphicsItem*> _AddtoItems,QObject *parent)
:Command(parent),AddtoItems(_AddtoItems)
{
}
void Order_Append_FlowItem::execute() const
{
if(this->parent()!=nullptr)
{
QGraphicsViewRefactor* ride=qobject_cast<QGraphicsViewRefactor*>(this->parent());
for(QGraphicsItem* item:qAsConst(AddtoItems))
{
if(item->type()==QGraphicsFlowTextItem::Type)
ride->m_scene->Correlation_Text.append(qgraphicsitem_cast<QGraphicsFlowTextItem*>(item));
if(item->type()==QGraphicsConnectingLineItem::Type)
ride->m_scene->ConnectLints.append(qgraphicsitem_cast<QGraphicsConnectingLineItem*>(item));
ride->m_scene->addItem(item);
}
}
}
void Order_Append_FlowItem::undo() const
{
if(this->parent()!=nullptr)
{
QGraphicsViewRefactor* ride=qobject_cast<QGraphicsViewRefactor*>(this->parent());
for(QGraphicsItem* item:qAsConst(AddtoItems))
{
if(item->type()==QGraphicsFlowTextItem::Type)
ride->m_scene->Correlation_Text.removeAll(qgraphicsitem_cast<QGraphicsFlowTextItem*>(item));
if(item->type()==QGraphicsConnectingLineItem::Type)
ride->m_scene->ConnectLints.removeAll(qgraphicsitem_cast<QGraphicsConnectingLineItem*>(item));
ride->m_scene->removeItem(item);
}
}
}
4. 删除图元命令对象
删除图元对象,就是与新增图元对象命令执行与撤销的动作相反,所以这里直接继承了
Order_Append_FlowItem 新增图元命令对象而不是 Command 对象;
Order_Delete_FlowItem.h
/ <summary>
/ 命令对象
/ 图元对象的删除
/ <summary>
class Order_Delete_FlowItem:public Order_Append_FlowItem
{
Q_OBJECT
public:
explicit Order_Delete_FlowItem(QList<QGraphicsItem*> _AddtoItems,QObject *parent = nullptr);
~Order_Delete_FlowItem() Q_DECL_OVERRIDE {}
///
/// 执行命令
///
void execute() const Q_DECL_OVERRIDE;
///
/// 撤销命令
///
void undo() const Q_DECL_OVERRIDE;
private:
QList<QGraphicsItem*> AddtoItems;
public:
bool isrefresh_data() const Q_DECL_OVERRIDE{return true;}
};
Order_Delete_FlowItem.cpp
Order_Delete_FlowItem::Order_Delete_FlowItem(QList<QGraphicsItem*> _AddtoItems,QObject *parent)
:Order_Append_FlowItem(_AddtoItems,parent),AddtoItems(_AddtoItems)
{
}
void Order_Delete_FlowItem::execute() const
{
Order_Append_FlowItem::undo();
}
void Order_Delete_FlowItem::undo() const
{
Order_Append_FlowItem::execute();
}
接收者(Receiver)实现
知道如何执行与请求相关的操作,实际执行命令的对象就是接收者,
在这个案例中通过重构QGraphicsView类,监控键盘事件【Ctrl+Z与Ctrl+Y 】来执行 请求者(Invoker_Command) 的函数,请求者(Invoker_Command) 将请求传递给 命令对象。QGraphicsView类就是接受者,也是客户端(Client)。
命令模式 缺点
扩展命令会导致类的数量增加 , 增加了系统实现的复杂程度 ,需要针对每个命令都要开发一个与之对应的命令类 ;在这个示例中包括修改图元,新增图元,删除图元都需要创建一系列的命令类,在实际开发中这种命令操作只会更多!!!