# Quick Event

**Repository Path**: springbar98/Quick-Event

## Basic Information

- **Project Name**: Quick Event
- **Description**: 基于QT-5.6封装的一套控制与界面完全分离的代码；利用QT的元对象属性，实现控制类的自动实例化；VS-2015编译通过，使用了C++11语法；
- **Primary Language**: C++
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 93
- **Created**: 2021-10-22
- **Last Updated**: 2021-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Quick Event

#### 介绍
基于QT-5.6封装的一套控制与界面完全分离的代码；利用QT的元对象属性，实现控制类的自动实例化；VS-2015编译通过，C++11；使用QuickEvent设计复杂功能可以让开发者，更加专注与自己模块或功能点的开发，也有利于调试和扩展；高内聚，低耦合，不仅让协同开发变得简单，也让重构变的非常轻松；生产级别代码clone即用，示例仅供参考；

#### 软件架构
1.  界面与控制逻辑完全分离
2.  事件管理
3.  线程管理
4.  控制类装填


#### 使用说明

######  发布和订阅
1.通过继承自QuickWork或引入QUICK_EVENT(parent class name)宏来让你的自己定义的类具有发布和订阅事件的能力；

```
//1.继承自QuickWork
class UserWork : public QuickWork
{
    Q_OBJECT
public:
    Q_INVOKABLE explicit UserWork(QObject *parent = nullptr);
    ...
};
//2.使用QUICK_EVENT宏
class Dialog : public QDialog
{
    Q_OBJECT
    QUICK_EVENT(QDialog)
public:
    explicit Dialog(QWidget *parent = nullptr);
    ...
};
```
注:QObject及其子类才能通过QUICK_EVENT宏引入发布订阅；

2.订阅消息
QuickApplication提供了subscibeEvent方法用来订阅一个消息

```
//订阅show_time消息
Dialog::Dialog(QWidget *parent) :
    QDialog(parent),
    ui(new Ui::Dialog)
{
    ui->setupUi(this);
    QuickApplication::subscibeEvent(this, "show_time");
    ...
}
```

3.发布消息
QuickApplication提供了publishEvent方法用来发布一个消息

```
TestWork::TestWork(QObject *parent) : QuickWork(parent)
{
        QTimer::singleShot(2000, this, []() {
        auto time = QDateTime::currentDateTime();
        QuickApplication::publishEvent("show_time", Qt::AutoConnection, time);
    });
}
```

publishEvent定义如下：
```
    template<class ...Args>
    static void publishEvent(QByteArray eventName, Qt::ConnectionType type, Args&&... args)
    {
        ...
    }
```

4.接受并处理消息
引入发布和订阅功能的类通过实现event_ + 消息名称的槽函数即可接受并处理publishEvent推送消息
(需要参数列表匹配一致)

```
public slots:
    void event_show_time(const QDateTime &time);

...

void Dialog::event_show_time(const QDateTime &time)
{
    box->setText(time.toString());
    box->show();
}

```
######  控制类装填
1. QuickWork及其子类允许被反射，通过QUICK_AUTO(class name)宏和QuickController可以实现控制类的自动实例化

QUICK_AUTO(class name)作用

(1).向QT元对象系统注册自己类型

(2).在mian方法之前将自己类名注册到需要反射类列表中，QuickController对象创建后会反射出所有已注册的类，并做线程归属处理

原理：C/C++无法在main之前执行复杂的操作，通过在.h文件中定义static变量且通过函数方式赋值，可以main之前执行一段代码
，利用static在类外修饰变量表示该变量仅对于文件内部可见的原理，不会产生编译错误；[当然对C++11支持良好编译器可以使用constexpr]
但是这个操作可能被执行多次，所以反射类列表使用了Set容器防止重复插入；

######  线程管理
1. QObject及其子类具有线程归属，QuickWork及其子类可以通过设置moveType_来决定被反射后移动大到线程的位置；

```
    typedef enum {
        MainThread = 0, //反射在主线程中且不移动，start函数不能为死循环否者QT事件循环也将被卡死；
        WorkThread,     //反射在工作线程中，区别与主线程；
        NewThread       //反射在新的线程中，会被每个反射出对象创建一个新的线程；
    } MoveThreadType;
```
注:继承自QuickWork后可以覆盖QuickWork::start函数，start函数一定会在被移动到的线程中调用；

#### 更新2.0.0版本

1.通过引入变参模板使得事件响应函数(event_ + 消息名称)的定义更加自由;

2.发布订阅支持了:

同步触发[DirectConnection]；

异步触发[QueuedConnection]；

异步触发等待[BlockingQueuedConnection]；

问题：

1.事件发布后如何确定调用触发函数匹配仍然不够完美;

问题在于QT元对象系统对于方法参数类型的摘要(QMetaMethod::parameterTypes)和C++的typeid()差距过大
目前只匹配外部类型，对于模板无法处理，所以不建议重载参数个数相同的事件响应函数,以下重载就会
产生问题

```
void event_show_time(const QDateTime &time, QList<int> list);

void event_show_time(const QDateTime &time, QList<QString> list);
```

注意
1.跨线程的事件发布传递参数需要使用QT已知的类型

同使用QT的QMetaObject::QMetaCallEvent一样QuickEvent在处理跨线程异步触发时也会在堆中创建变量的副本；

消息订阅者可能是多个，这里使用了QSharedPointer<QVariant>共享这块内存；所以传入参数会被转换成QVariant类型，
未知类型在编译时就会报错;

2.对于同步触发和异步触发等待，则支持任意类型参数；

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request

#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)