CTK插件框架学习-事件通信(04)

已于 2024-04-17 16:32:44 修改
阅读量371 收藏 5
点赞数 8
分类专栏： CTK 文章标签： 学习
于 2024-04-01 17:10:19 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45551020/article/details/137171155
版权

CTK插件框架学习-插件注册调用(03)https://mp.csdn.net/mp_blog/creation/editor/136989802

一、主要流程

  • 发送者注册消息事件
  • 接收者订阅消息事件
  • 接收者相应消息事件

事件监听比插件接口调用耦合性更弱，事件由框架维护，不需要指定发送方和接收方

二、发布订阅插件

2.1、事件发布插件


发送消息类


==========================Publish.ch================================
#pragma once

#include "qstring.h"

typedef struct
{
	QString _name;
	QString _message;
}ST_Msg;

class ctkPluginContext;
class Publish
{
public:
	Publish(ctkPluginContext* context);

	//发布的消息
	void publishMessage(const ST_Msg& msg);

private:
	ctkPluginContext* m_context;
};


==========================Publish.cpp==============================
#include "Publish.h"
#include <qdebug.h>

#include "service/event/ctkEventAdmin.h"
#include "ctkPluginContext.h"

Publish::Publish(ctkPluginContext * context)
	:m_context(context)
{
}

void Publish::publishMessage(const ST_Msg & msg)
{
	ctkServiceReference ref = m_context->getServiceReference<ctkEventAdmin>();
	if (ref)
	{
		ctkEventAdmin* eventAdmin = m_context->getService<ctkEventAdmin>(ref);
		if (eventAdmin)
		{
			ctkDictionary dic;
			dic["name"] = msg._name;
			dic["message"] = msg._message;
			ctkEvent event("EVENT_MESSAGE", dic);

			qDebug() << "Publish message:" << dic;
			
			eventAdmin->sendEvent(event);//同步，消息发送后立即执行
			//eventAdmin->postEvent(event);//异步，由消息队列控制，有超时机制，超时后会被加入黑名单
		}
	}
}

激活器类

=============================PluginActivator.h===================================
#pragma once
#include <qobject.h>
#include "ctkPluginActivator.h"
#include "ctkPluginContext.h"

#include "Publish.h"

class PluginActivator :
	public QObject, ctkPluginActivator
{
	Q_OBJECT
	Q_INTERFACES(ctkPluginActivator)//向Qt的插件框架声明，希望将xxx插件放入到框架中。
	Q_PLUGIN_METADATA(IID "TestPublishPlugin")//向qt框架申明插件（qt5版本）


public:
	PluginActivator();
	virtual void start(ctkPluginContext* context);
	virtual void stop(ctkPluginContext* context);

private:
	QScopedPointer<Publish> m_publish;//智能指针,自动析构回收
};


=============================PluginActivator.cpp=================================
#include "PluginActivator.h"
#include <qdebug.h>

#include "ctkPluginFrameworkLauncher.h"

PluginActivator::PluginActivator()
{
}


void PluginActivator::start(ctkPluginContext* context)
{
	qDebug() << "my PublishPlugin start";
	m_publish.reset(new Publish(context));

	ST_Msg msg;
	msg._name = "Publish";
	msg._message = "hello Publish send message";
	m_publish.get()->publishMessage(msg);

	ctkPlugin::State sta = context->getPlugin()->getState();
}

void PluginActivator::stop(ctkPluginContext* context)
{
	qDebug() << "my PublishPlugin stop";
	Q_UNUSED(context)// Q_UNUSED,如果一个函数的有些参数没有用到、某些变量只声明不使用，但是又不想编译器、编辑器报警报，其他没有什么实际性作用


	m_publish.reset(NULL);

	ctkPlugin::State sta = context->getPlugin()->getState();
}

2.2、事件订阅插件
 

接收消息类

==========================SubscribeEventHandler.h================================
#pragma once

#include <qobject.h>
#include "service/event/ctkEventHandler.h"

class SubscribeEventHandler
	: public QObject, public ctkEventHandler
{
	Q_OBJECT
	Q_INTERFACES(ctkEventHandler)

public:
	SubscribeEventHandler();
	
	virtual void handleEvent(const ctkEvent& event);
};

==========================SubscribeEventHandler.cpp==============================

#include "SubscribeEventHandler.h"
#include <qdebug.h>

#include "service/event/ctkEventAdmin.h"
#include "ctkPluginContext.h"

SubscribeEventHandler::SubscribeEventHandler()
{
}

void SubscribeEventHandler::handleEvent(const ctkEvent & event)
{
	QString name = event.getProperty("name").toString();
	QString message = event.getProperty("message").toString();

	qDebug() << "Subscribe name:" << name;
	qDebug() << "Subscribe message:" << message;
}

激活器类

=============================PluginActivator.h================================
#pragma once

#include <QObject>
#include "ctkPluginActivator.h"
#include "ctkPluginContext.h"

#include "SubscribeEventHandler.h"

class PluginActivator  : public QObject, public ctkPluginActivator
{
	Q_OBJECT
	Q_INTERFACES(ctkPluginActivator)//向Qt的插件框架声明，希望将xxx插件放入到框架中。
	Q_PLUGIN_METADATA(IID "TestSubscribePlugin")//向qt框架申明插件（qt5版本）

public:
	PluginActivator();
	void start(ctkPluginContext *context);
	void stop(ctkPluginContext *context);

private:
	QScopedPointer<SubscribeEventHandler> m_subscribeEventHandler;//智能指针,自动析构回收
};

=============================PluginActivator.cpp==============================

#include "PluginActivator.h"
#include <qdebug.h>

#include "ctkPluginFrameworkLauncher.h"
#include "service/event/ctkEventConstants.h"

PluginActivator::PluginActivator()
{}

void PluginActivator::start(ctkPluginContext* context)
{
	qDebug() << "my SubscribePlugin start";
	m_subscribeEventHandler.reset(new SubscribeEventHandler());

	ctkDictionary dic;
	dic[ctkEventConstants::EVENT_TOPIC] = "EVENT_MESSAGE";//订阅的主题
	dic[ctkEventConstants::EVENT_FILTER] = "(name=Publish)";//过滤的事件
	context->registerService<ctkEventHandler>(m_subscribeEventHandler.get(), dic);

	ctkPlugin::State sta = context->getPlugin()->getState();
}

void PluginActivator::stop(ctkPluginContext* context)
{
	qDebug() << "my SubscribePlugin stop";
	Q_UNUSED(context)// Q_UNUSED,如果一个函数的有些参数没有用到、某些变量只声明不使用，但是又不想编译器、编辑器报警报，其他没有什么实际性作用

	m_subscribeEventHandler.reset(NULL);

	ctkPlugin::State sta = context->getPlugin()->getState();
}

2.3、测试插件

#include "CTKPlugin.h"
#include <QtWidgets/QApplication>


#include <iostream>
#include <QStyleFactory>
#include <QDir>
#include <QDirIterator>
#include <QDebug>
#include "ctkPluginFrameworkFactory.h"
#include "ctkPluginFramework.h"
#include "ctkPluginException.h"
#include "ctkPluginContext.h"
#include "ctkPluginFrameworkLauncher.h"
#include "../TestPlugin/iTestPlugin.h"
#include "../TestPlugin2/IService1.h"
#include "../TestPlugin2/IService2.h"
#include "../TestPlugin3/IService.h"
/*
* 1、注意：Plugin-SymbolicName要满足这里的前缀是：TARGET/META-INF格式。TARGET的名字最好和工程名一致，不然可能出现device not open错误。
* 2、如果CTK初始化、插件安装启动等是在一个类中，则与CTK相关的变量应定义成类的属性，不能是成员变量，否则获取不到服务
* 3、CTK插件组成：
（1）每个插件有自己的注册器Activator，继承自QObject和ctkPluginActivator的一个类，并实现ctkPluginActivator的start、stop函数
（2）每个插件必须有一个资源文件，名称一般与插件名称一致，前缀必须为TARGET/META-INF，例：插件名称/META-INF
（3）每个插件必须添加一个元数据文件，名字必须为MANIFEST.MF，并添加到资源文件中
* 4、QSharedPointer framework这个对象既可以作为对象也可以作为对象指针，但要作为插件框架使用必须要用指针方法调用
* 5、生成的插件名(TARGET)不要有下划线，因为CTK会默认将插件名中的下划线替换成点号，最后导致找不到插件 
*/
int main(int argc, char *argv[])
{
	QApplication::setAttribute(Qt::AA_EnableHighDpiScaling);

    QApplication a(argc, argv);
	a.setApplicationName("ctktest");//Linux下没有名称报错

	QString path = QCoreApplication::applicationDirPath();

#ifdef _DEBUG
	ctkPluginFrameworkLauncher::addSearchPath(path + "/CTKPlugins");
#else
	ctkPluginFrameworkLauncher::addSearchPath(path + "/CTKPlugins");
#endif // _DEBUG
	// 设置并启动 CTK 插件框架
	try {
		ctkPluginFrameworkLauncher::start("org.commontk.eventadmin");
	}
	catch (ctkException e)
	{
		std::cout << e.message().toStdString() << std::endl;
	}

	// 启动插件工厂
	ctkPluginFrameworkFactory* ctkFrameWorkFactory = new ctkPluginFrameworkFactory;
	QSharedPointer<ctkPluginFramework> framework = ctkFrameWorkFactory->getFramework();
	try {
		framework->init();
		framework->start();
	}
	catch (const ctkPluginException& e)
	{
		std::cout << "framework init fail" << std::endl;
	}

	QSharedPointer<ctkPlugin> plugin;

/*
* 使用MANIFEST.MF启动依赖插件方法未成功，采用独立加载插件方法
*/
#if 0
	QDirIterator iter(path + "/plugins/", { "*.dll" }, QDir::NoFilter, QDirIterator::Subdirectories);
	while (iter.hasNext()) {
		//qDebug() << iter.next();
		QString dllPath = iter.next();
		QUrl url = QUrl::fromLocalFile(dllPath);
		try
		{
			plugin = framework->getPluginContext()->installPlugin(url);
			qDebug() << QString("Plugin[%1_%2] installed...").arg(plugin->getSymbolicName()).arg(plugin->getVersion().toString());
			
			//获取MANIFEST.MF中的数据
			QHash<QString, QString> headers = plugin->getHeaders();
			ctkVersion version = ctkVersion::parseVersion(headers.value(ctkPluginConstants::PLUGIN_VERSION));
			QString name = headers.value(ctkPluginConstants::PLUGIN_NAME);
		}
		catch (ctkPluginException e) {
			std::cout << e.message().toStdString() << e.getType() << std::endl;
		}

		try {
			plugin->start(ctkPlugin::START_TRANSIENT);//表示立即启用插件，不设置参数的话加载后也不会立即打印输出
			qDebug() << QString("Plugin[%1_%2] started").arg(plugin->getSymbolicName()).arg(plugin->getVersion().toString());
		}
		catch (ctkPluginException e) {
			std::cout << e.message().toStdString() << e.getType() << std::endl;
		}
	}

#else
	
	try
	{
		QUrl url = QUrl::fromLocalFile(path + "/plugins/TestSubscribePlugin.dll");
		plugin = framework->getPluginContext()->installPlugin(url);
		qDebug() << QString("Plugin[%1_%2] installed...").arg(plugin->getSymbolicName()).arg(plugin->getVersion().toString());

		//获取MANIFEST.MF中的数据
		QHash<QString, QString> headers = plugin->getHeaders();
		ctkVersion version = ctkVersion::parseVersion(headers.value(ctkPluginConstants::PLUGIN_VERSION));
		QString name = headers.value(ctkPluginConstants::PLUGIN_NAME);
	}
	catch (ctkPluginException e) {
		std::cout << e.message().toStdString() << e.getType() << std::endl;
	}

	try {
		plugin->start(ctkPlugin::START_TRANSIENT);//表示立即启用插件，不设置参数的话加载后也不会立即打印输出
		qDebug() << QString("Plugin[%1_%2] started").arg(plugin->getSymbolicName()).arg(plugin->getVersion().toString());
	}
	catch (ctkPluginException e) {
		std::cout << e.message().toStdString() << e.getType() << std::endl;
	}

	try
	{
		QUrl url = QUrl::fromLocalFile(path + "/plugins/TestPublishPlugin.dll");
		plugin = framework->getPluginContext()->installPlugin(url);
		qDebug() << QString("Plugin[%1_%2] installed...").arg(plugin->getSymbolicName()).arg(plugin->getVersion().toString());

		//获取MANIFEST.MF中的数据
		QHash<QString, QString> headers = plugin->getHeaders();
		ctkVersion version = ctkVersion::parseVersion(headers.value(ctkPluginConstants::PLUGIN_VERSION));
		QString name = headers.value(ctkPluginConstants::PLUGIN_NAME);
	}
	catch (ctkPluginException e) {
		std::cout << e.message().toStdString() << e.getType() << std::endl;
	}

	try {
		plugin->start(ctkPlugin::START_TRANSIENT);//表示立即启用插件，不设置参数的话加载后也不会立即打印输出
		qDebug() << QString("Plugin[%1_%2] started").arg(plugin->getSymbolicName()).arg(plugin->getVersion().toString());
	}
	catch (ctkPluginException e) {
		std::cout << e.message().toStdString() << e.getType() << std::endl;
	}
#endif

	//ctkPlugin::State sta = plugin->getState();
	//ctkPluginFrameworkLauncher::stop();
	//plugin->stop(); 
	//plugin->uninstall();
	//sta = plugin->getState();

	CTKPlugin c;
	c.show();
    return a.exec();
}

三、MANIFEST.MF文件参数

实现插件依赖启动

f4608d8a95074a81874ab3c494292a5e.png

Plugin-SymbolicName:本插件名称

Plugin-Version:本插件版本号

Require-Plugin:依赖插件名称

Plugin-version=依赖插件版本号， 默认为1.0

resolution=mandatory为强依赖没有找到则本插件不能启动，optional为弱依赖没有找到也正常启动

四、类通信和信号槽区别

1、使用event发送效率优于信号槽，信号槽方式会在qt信号槽机制中转再发送到ctk框架

2、两种方式可以混合使用

3、同步：sendEvent / Qt::DirectConnection

4、异步：postEvent / Qt::QueuedConnection

 

CTK插件框架学习-信号槽(05)https://mp.csdn.net/mp_blog/creation/editor/137240105

 

白衫长发时光与她
关注
  • 8
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
官方CTK插件框架基础介绍文档
06-13
可用于QT的插件式框架
ctk插件框架开发工程示例，完美可运行，极其具有参考性
03-10
ctk插件框架开发工程示例，完美可运行，极其具有参考性ctk插件框架开发工程示例，完美可运行，极其具有参考性ctk插件框架开发工程示例，完美可运行，极其具有参考性ctk插件框架开发工程示例，完美可运行，极其具有...
插件开发中常用的监听方式
只有代码的世界
01-29 1000
监听器在插件开发过程上总是必要的,监听的方式有好几种，这里介绍两总常用的监听方式. 一种是在需要的时候直接使用，哪里需要就在哪里添加。这种方式的好处是写代码的时候可以很快的添加，不会打乱逻辑。另一种是创建一个内部类，对各种需要监听的事件进行分类处理。这种方式的好处是可以对监听进行很好的管理，代码显得很精简，模块化。对于事件响应不多的插件可以选择第一种，对于事件响应较多的可以选择第二种方式。
CTK插件框架学习-事件监听(07)
weixin_45551020的博客
04-11 347
事件监听指当事件发生变化时所产生的通信，是动态的，对于已经发生过的事件无法监听。
CTK Plugin Framework插件框架学习4--插件通信【事件监听】
贝勒里恩的博客
01-11 2229
接收者注册监听事件（接收方想监听xxx信息）发送者发送事件（发送方发送xxx信息）接收者接收到事件并响应（接收方收到xxx事件后的动作）相比调用插件接口监听事件插件间依赖关系更弱，不用指定事件的接收方和发送方是谁在编译输出的CTK文件夹中可以找到加载EventAdmin动态库main.cpp中新增如下代码。
CTK插件框架学习-插件注册调用(03)
weixin_45551020的博客
03-29 1172
CTK插件框架学习-新建插件(02)
CTK插件框架学习-服务工厂(06)
weixin_45551020的博客
04-08 370
注册插件时使用服务工厂注册，使用getService根据调用者插件资源文件内容获取在服务工厂内的对应实现在服务工厂中可以知道是哪个插件正在调用服务工厂懒汉模式，在需要时（通过服务工厂获取时）才创建出对象实例可以根据需要在服务工厂内创建出多个其他插件对应需要的功能。
CTK插件框架学习-服务追踪(08)
weixin_45551020的博客
04-15 414
在插件B中使用插件A服务，实现一个类继承自ctkServiceTracker（在插件B中），通过该类访问插件A的服务。
CTK Plugin Framework插件框架学习6--事件监听
贝勒里恩的博客
01-11 651
框架事件插件事件服务事件但是这些事件只有在变化时才能监听到，如果已经变化过后，进入一个稳定的状态，这时才去监听，那么是无法监听到的。
CTK Plugin Framework插件框架学习3--插件通信【注册接口调用】
贝勒里恩的博客
01-10 2006
通过Qt基于CTK Plugin Framework搭建插件框架–创建插件一文，我们知道了CTK创建插件的基本流程，但是在这篇文章中，我们只是创建了一个空插件，一个只有激活类的插件，没有任何功能。一个CTK标准插件应该包含有：接口类、接口实现类、激活类；接口类就只做接口声明；实现类就只实现接口；激活类就负责将服务整合到ctk框架中；
CTK插件框架学习-信号槽通信(05)
weixin_45551020的博客
04-02 345
CTK插件框架学习-事件监听(04)
GreetCTK_CTK插件框架_consonant7x3_
10-02
通过CTK框架实现插件化编程，该例子说明了如何使用CTK插件，以及使用CTK插件的步骤，第一步先初始化框架，第二步启动CTK框架，第三步获取插件上下文，第四步安装插件，第五步启动插件。
ctk插件框架在c++应用Qt开发plugin
01-07
https://github.com/knowledge0603/ctk-source 或者 https://github.com/commontk/CTK 3、下载2步骤文件，解压文件到CTK文件夹路径 在CTK路径下执行 cmake 然后执行 make 然后执行 make install 4、ubuntu下安装需要...
CTK插件框架介绍1
08-08
设计CTK Plugin Framework 的设计（参考：设计文档）受到了 OSGi（Java 的动态组件系统）的极大启发，并且提供了一种开发模型，其中应用程
FME学习之旅---day27
最新发布
summer_corner的博客
05-17 280
我们付出一些成本，时间的或者其他，最终总能收获一些什么。
使用多实例学习进行乳腺癌组织病理学图像分类和定位
qq_47896523的博客
05-16 1406
乳腺癌是女性最主要的死亡原因，病理学家根据病理切片中观察到的各种视觉特征（例如细胞核的形态特征、细胞核的微观和宏观结构等）做出决定。计算机辅助诊断（CAD）系统可以帮助病理学家自动做出决策。卷积神经网络是最广泛使用的深度学习框架，用于学习图像类别之间的复杂判别特征。多年来，VGG16 [3] 和 ResNet18 [4] 等各种 CNN 架构在海量 ImageNet 数据集上产生了出色的结果。CNN 被用于医学图像以产生最先进的结果。为图像中存在的所有类别提供了定位信息。
WEB转Flutter基础学习笔记（内含vue和flutter对比）
小易不止于搬砖的博客
05-17 774
笔者是一名web前端，记录在转栈flutter时的学习笔记，内涵和vue的对比，能够辅助前端同学更容易理解flutter
详细介绍下CTK框架是怎么实现事件管理的
05-27
CTK事件框架是基于Qt框架的事件管理机制实现的，它遵循了Qt事件处理的基本思想：事件的产生和处理是分离的。 在CTK事件框架中，事件的产生通常是由用户交互、系统消息、定时器等方式触发的，这些事件被封装成对应的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值