一,描述

Qt 通常使用信号和槽,进行模块间通信,但是绑定的时候,必须要有一个地方,同时知道信号和槽的所属对象,耦合性还是太紧密,这个库,只要按照规定的写法,就可以实现信号和槽的通信,并且不需要绑定,减少了一层耦合。

二,使用

  • A B两个类都需要包含头文件。#include PSEventController.h

  • A类中触发的地方,调用publish函数。

//比如按下按钮 ,需提供一个唯一的标识字符串,可自定义参数
PSEventController::publish(“addLine”,Q_ARG(bool,isChecked));

  • B类中 定义 on_psEvent_xxx 函数,并实现。

//此处的addLine 即为上述pulish 函数中的第一个参数,isChecked 为publis中的第二个参数
void on_psEvent_addLine(bool isChecked);

  • B类中初始化的时候 执行 subscribe 函数。

PSEventController::subscribe(this,addLine);

这样,A 和B 两个类 发布和订阅的唯一字符串标识符只要一致,A 在pubsh 的时候 B 就可以subscribe到,并且A 和B 完全耦合,相互不可见。

三,库 具体内容

//PSEventController.h
#ifndef PSEVENTCONTROLLER_H
#define PSEVENTCONTROLLER_H

#include <QObject>
#include <QReadWriteLock>
#include <QMap>
#include <QList>

#define METHOD_PREFIX on_psEvent_

class PSEventController : public QObject
{
    Q_OBJECT
public:
    static void unSubscribe(QObject* listener, const QByteArray& eventName);
    static bool subscribe(QObject* listener, const QByteArray& eventName);
    static bool publish(const QByteArray& eventName, Qt::ConnectionType connectionType,
        QGenericArgument val0 = QGenericArgument(), QGenericArgument val1 = QGenericArgument(),
        QGenericArgument val2 = QGenericArgument(), QGenericArgument val3 = QGenericArgument(),
        QGenericArgument val4 = QGenericArgument(), QGenericArgument val5 = QGenericArgument(),
        QGenericArgument val6 = QGenericArgument(), QGenericArgument val7 = QGenericArgument(),
        QGenericArgument val8 = QGenericArgument(), QGenericArgument val9 = QGenericArgument());

    static inline bool publish(const QByteArray& eventName,
        QGenericArgument val0 = QGenericArgument(), QGenericArgument val1 = QGenericArgument(),
        QGenericArgument val2 = QGenericArgument(), QGenericArgument val3 = QGenericArgument(),
        QGenericArgument val4 = QGenericArgument(), QGenericArgument val5 = QGenericArgument(),
        QGenericArgument val6 = QGenericArgument(), QGenericArgument val7 = QGenericArgument(),
        QGenericArgument val8 = QGenericArgument(), QGenericArgument val9 = QGenericArgument())
    {
        return publish(eventName, Qt::AutoConnection, val0, val1, val2, val3, val4, val5, val6, val7, val8, val9);
    }

    static inline QString get_Errors()
    {
        return ps_LastError_;
    }

    static inline void clearEvents()
    {
        QWriteLocker locker(&ps_Lock_);
        psEvents_pool_.clear();
    }

    static inline QByteArray methodFormatting(const QByteArray& eventName) {
        return METHOD_PREFIX + eventName;
    }
private:
    static QMap<QByteArray, QList<QObject*>> psEvents_pool_;
    static QReadWriteLock ps_Lock_;

    static QString ps_LastError_;
};

#endif // PSEVENTCONTROLLER_H
//PSEventController.cpp
#include PSEventController.h
#include <QWriteLocker>

QMap<QByteArray, QList<QObject*>> PSEventController::psEvents_pool_;
QReadWriteLock PSEventController::ps_Lock_;
QString PSEventController::ps_LastError_;

void PSEventController::unSubscribe(QObject* listener, const QByteArray& eventName)
{
    QWriteLocker locker(&ps_Lock_);
    int index = -1;
    if (psEvents_pool_.contains(eventName) &&
        (index = psEvents_pool_[eventName].indexOf(listener)) >= 0 && index < psEvents_pool_[eventName].count())
        psEvents_pool_[eventName].takeAt(index);
}

bool PSEventController::subscribe(QObject* listener, const QByteArray& eventName)
{
    QWriteLocker locker(&ps_Lock_);
    if (psEvents_pool_.contains(eventName)) {
        if (-1 != psEvents_pool_[eventName].indexOf(listener)) {
            ps_LastError_ = QString(This object is subscribed to this eventName);
            return false;
        }
        psEvents_pool_[eventName].push_back(listener);
        return true;
    } else {
        psEvents_pool_.insert(eventName, { listener });
        return true;
    }
}

bool PSEventController::publish(const QByteArray& eventName, Qt::ConnectionType connectionType,
    QGenericArgument val0, QGenericArgument val1, QGenericArgument val2, QGenericArgument val3,
    QGenericArgument val4, QGenericArgument val5, QGenericArgument val6, QGenericArgument val7,
    QGenericArgument val8, QGenericArgument val9)
{
    QReadLocker locker(&ps_Lock_);
    if (!psEvents_pool_.contains(eventName)) {
        ps_LastError_ = QString(No objects subscribe to this eventName);
        return false;
    }
    auto methodName = methodFormatting(eventName);
    QStringList errors;
    for (auto listener : psEvents_pool_[eventName]) {
        if (!listener)
            continue;
        auto ret = QMetaObject::invokeMethod(listener, methodName, connectionType,
            val0, val1, val2, val3, val4, val5, val6, val7, val8, val9);
        if (!ret)
            errors.append(QString(%1:%2).arg(listener->metaObject()->className()).arg(listener->objectName()));
    }
    if (errors.isEmpty())
        return true;
    ps_LastError_ = QString(%1 execution failed:[\n).arg(QString(eventName));
    for (auto& err : errors)
        ps_LastError_ += QString(%1;\n).arg(err);
    ps_LastError_ += ]\n;
    return false;
}