README.md · jack416/Quick Event

# 1 介绍
- ✂️ 仅600行C++代码
- 🔣 支持多语言,采用 UTF-8 编码
- ⚡ 使用**QuickEvent**设计复杂功能可以让开发者，更加专注与自己模块或功能点的开发
- 💉 利用**QT**的元对象属性，实现控制类的自动实例化
- 🔨 高内聚，低耦合，不仅让协同开发变得简单，也让重构变的非常轻松；
- 🐋 生产级别代码clone即用，提供参考Demo
- ⚙️️ 跨平台
  | platform | Support | 
  | --- | --- | 
  | Windos VS-2017 | &emsp;√ | 
  | Linux Gcc6 | &emsp;√ | 
  | Mac Gcc6 | &emsp;√ |

# 2 设计说明
1. 界面与控制逻辑完全分离
2. 事件管理
3. 线程管理
4. 控制类装填

# 3 如何使用 QuickEvent?

- QuickEvent使用: 在你的**Cmake**工程中添加**QuickEvent**库
- QuickEvent开发: 您可以获得源码，并在任何平台（Windows/Linux/Mac）上开发它

## 3.1 QuickEvent使用：

###  发布和订阅

#### 1.关联QuickEvent
&emsp;&emsp;通过继承自**QuickWork**或引入**QUICK_EVENT**宏来让你的自己定义的类具有**发布**和**订阅**事件的能力；
```cpp
// 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.订阅消息
&emsp;&emsp;**QuickApplication**提供了**subscibeEvent**方法用来订阅一个消息
```cpp
// 订阅show_time消息
Dialog::Dialog(QWidget *parent) :
    QDialog(parent),
    ui(new Ui::Dialog) {
    ui->setupUi(this);
    QuickApplication::subscibeEvent(this, "show_time");
    ...
}
```
#### 3.发布消息
&emsp;&emsp;**QuickApplication**提供了**publishEvent**方法用来发布一个消息

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

```

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

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

```cpp
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**宏和**QuickController**，可以实现控制类的自动实例化。

**QUICK_AUTO(name)作用:**
- 向QT元对象系统注册自己类型
- 在mian方法之前将自己类名注册到需要反射类列表中，QuickController对象创建后会反射出所有已注册的类，并做线程归属处理

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

###  线程管理 
> 
1. **QObject**及其子类具有线程归属，**QuickWork**及其子类可以通过设置moveType_来决定被反射后移动大到线程的位置。
```cpp
typedef enum {
    MainThread = 0, //反射在主线程中且不移动，start函数不能为死循环否者QT事件循环也将被卡死；
    WorkThread,     //反射在工作线程中，区别与主线程；
    NewThread       //反射在新的线程中，会被每个反射出对象创建一个新的线程；
} MoveThreadType;
```
* 注:继承自**QuickWork**后可以覆盖**QuickWork::start**函数，**start**函数一定会在被移动到的线程中调用；

## 3.2 QuickEvent开发：
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

# 4 版本更新说明

### 更新2.0.0版本

1. 通过引入变参模板使得事件响应函数(event_ + 消息名称)的定义更加自由;
2. 发布订阅支持了:
&emsp;&emsp;&emsp;&emsp;同步触发[DirectConnection]；  
&emsp;&emsp;&emsp;&emsp;异步触发[QueuedConnection]；  
&emsp;&emsp;&emsp;&emsp;异步触发等待[BlockingQueuedConnection]；

##### 存在问题：

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

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

```cpp
void event_show_time(const QDateTime &time, QList<int> list);
void event_show_time(const QDateTime &time, QList<QString> list);
```
##### 注意
1. 跨线程的事件发布传递参数需要使用QT已知的类型
2. 同使用QT的**QMetaObject::QMetaCallEvent**一样**QuickEvent**在处理跨线程异步触发时也会在堆中创建变量的副本；
3. 消息订阅者可能是多个，使用**QSharedPointer::QVariant**共享这块内存；所以传入参数会被转换成**QVariant**类型。
4. 未知类型在编译时就会报错;
5. 对于同步触发和异步触发等待，则支持任意类型参数；

### 更新2.0.2版本

1. QuickEvent使用cmake来组织工程了，添加编译动态库版本，参考CMakeLists.txt；
``` cpp
#true编译生成动态库; false编译生成静态库；
set(quickevent_BUILD_SHARED_LIBS false)
#ON编译示例 OFF不编译示例
set(quickevent_BUILD_EXAMPLES ON)
```
2. 解决继承动自导出类后反射崩溃问题，以下摘自QT源码:qmetatype.h；
``` cpp
 static int qt_metatype_id()
    {
        static QBasicAtomicInt metatype_id = Q_BASIC_ATOMIC_INITIALIZER(0);
        if (const int id = metatype_id.loadAcquire())
            return id;
		//继承自dll导出类的对象T模板类型无法识别，需要Q_DECLARE_METATYPE前置声明
        const char * const cName = T::staticMetaObject.className();
		...
    }
```

jack416/Quick Event

简介

发行版

贡献者

近期动态

jack416/Quick Event .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

jack416/Quick Event