CTK插件框架学习-事件监听(07)https://mp.csdn.net/mp_blog/creation/editor/137570870
一、简介
在插件B中使用插件A服务,实现一个类继承自ctkServiceTracker(在插件B中),通过该类访问插件A的服务。
二、被追踪插件
参考以下链接中的插件服务
CTK插件框架学习-新建插件(02)
三、追踪服务插件
1、插件类-TestServiceTrackerPlugin
=========================IServiceTrackerPlugin.h=====================
#pragma once#include <QObject>
#include <qstring.h>
class IServiceTrackerPlugin {
public:virtual ~IServiceTrackerPlugin() {}virtual void printf() = 0;
};
Q_DECLARE_INTERFACE(IServiceTrackerPlugin, "zr.IServiceTrackerPlugin")//声明一个接口类,此宏将当前这个接口类向qt系统声明为接口,后面的一长串就是这个接口的唯一标识。=========================TestServiceTrackerPlugin.h=====================#pragma once#include <qobject.h>
#include "IServiceTrackerPlugin.h"class ServiceTrackerClass;class TestServiceTrackerPlugin : public QObject, public IServiceTrackerPlugin
{Q_OBJECTQ_INTERFACES(IServiceTrackerPlugin)//此宏与Q_DECLARE_INTERFACE宏配合使用, 表明当前插件类实现这个服务接口
public:TestServiceTrackerPlugin(ServiceTrackerClass* tracker);~TestServiceTrackerPlugin();virtual void printf();private:ServiceTrackerClass *m_tracker;
};=======================TestServiceTrackerPlugin.cpp=====================#include "TestServiceTrackerPlugin.h"#include "ctkPluginContext.h"
#include "../TestPlugin/iTestPlugin.h"
#include "ServiceTrackerClass.h"TestServiceTrackerPlugin::TestServiceTrackerPlugin(ServiceTrackerClass* tracker): m_tracker(tracker)
{
}TestServiceTrackerPlugin::~TestServiceTrackerPlugin()
{}void TestServiceTrackerPlugin::printf()
{iTestPlugin* service = static_cast<iTestPlugin*>(m_tracker->getService());if (service != nullptr){service->showWidget();}
}
2、激活器类-PluginActivator
============================PluginActivatorh==========================
#pragma once
#include <qobject.h>
#include "ctkPluginActivator.h"
#include "ctkPluginContext.h"
#include "TestServiceTrackerPlugin.h"class ServiceTrackerClass;class PluginActivator :public QObject, ctkPluginActivator
{Q_OBJECTQ_INTERFACES(ctkPluginActivator)//向Qt的插件框架声明,希望将xxx插件放入到框架中。Q_PLUGIN_METADATA(IID "TestServiceTrackerPlugin")//向qt框架申明插件(qt5版本)public:PluginActivator();void start(ctkPluginContext *context);void stop(ctkPluginContext *context);
private:QScopedPointer<TestServiceTrackerPlugin> m_testServiceTrackerPlugin;//智能指针,自动析构回收QScopedPointer < ServiceTrackerClass> m_serviceTracker;ctkServiceRegistration m_ctkServiceRegistration;
};============================PluginActivator.cpp========================#include "PluginActivator.h"
#include <QDebug>
#include "ctkPluginContext.h"
#include "ctkPluginFrameworkLauncher.h"#include "ServiceTrackerClass.h"PluginActivator::PluginActivator()
{}
void PluginActivator::start(ctkPluginContext *context)
{qDebug() << "my TestServiceTrackerPlugin start";//服务追踪m_serviceTracker.reset(new ServiceTrackerClass(context));m_serviceTracker.get()->open();//服务追踪使用者插件m_testServiceTrackerPlugin.reset(new TestServiceTrackerPlugin(m_serviceTracker.get()));ctkDictionary dic;m_ctkServiceRegistration = context->registerService<IServiceTrackerPlugin>(m_testServiceTrackerPlugin.get(), dic);ctkPlugin::State sta = context->getPlugin()->getState();}void PluginActivator::stop(ctkPluginContext *context)
{qDebug() << "my TestServiceTrackerPlugin stop";Q_UNUSED(context)// Q_UNUSED,如果一个函数的有些参数没有用到、某些变量只声明不使用,但是又不想编译器、编辑器报警报,其他没有什么实际性作用ctkServiceReference ref = context->getServiceReference<IServiceTrackerPlugin>();context->ungetService(ref);//注销服务m_ctkServiceRegistration.unregister();//关闭服务追踪m_serviceTracker.get()->close();m_serviceTracker.reset(NULL);//m_testServiceTrackerPlugin.reset(NULL);ctkPlugin::State sta = context->getPlugin()->getState();}
3、服务追踪类-ServiceTrackerClass
===========================ServiceTrackerClass.h==============================
#pragma once#include <ctkPluginContext.h>
#include <ctkServiceTracker.h>
#include "../TestPlugin/iTestPlugin.h"class ServiceTrackerClass :public ctkServiceTracker<iTestPlugin *>
{
public:ServiceTrackerClass(ctkPluginContext* context);~ServiceTrackerClass();protected:// 在 Service 注册时访问iTestPlugin* addingService(const ctkServiceReference& reference);void modifiedService(const ctkServiceReference& reference, iTestPlugin* service);void removedService(const ctkServiceReference& reference, iTestPlugin* service);};===========================ServiceTrackerClass.cpp============================#include "ServiceTrackerClass.h"
ServiceTrackerClass::ServiceTrackerClass(ctkPluginContext * context): ctkServiceTracker<iTestPlugin *>(context)
{
}ServiceTrackerClass::~ServiceTrackerClass()
{
}iTestPlugin * ServiceTrackerClass::addingService(const ctkServiceReference & reference)
{qDebug() << "Adding service:" << reference.getPlugin()->getSymbolicName();iTestPlugin* service = (iTestPlugin*)(ctkServiceTracker::addingService(reference));return service;
}void ServiceTrackerClass::modifiedService(const ctkServiceReference & reference, iTestPlugin * service)
{qDebug() << "Modified service:" << reference.getPlugin()->getSymbolicName();ctkServiceTracker::modifiedService(reference, service);
}void ServiceTrackerClass::removedService(const ctkServiceReference & reference, iTestPlugin * service)
{qDebug() << "Removed service:" << reference.getPlugin()->getSymbolicName();ctkServiceTracker::removedService(reference, service);
}
四、main.cpp
#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 "EventListener.h"#include "../TestPlugin/iTestPlugin.h"
#include "../TestPlugin2/IService1.h"
#include "../TestPlugin2/IService2.h"
#include "../TestPlugin3/IService.h"
#include "../TestServiceFactory/IPrintfService.h"
#include "../TestServiceTrackerPlugin/IServiceTrackerPlugin.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 _DEBUGctkPluginFrameworkLauncher::addSearchPath(path + "/CTKPlugins");//ctkPluginFrameworkLauncher::addSearchPath("E:/Demo(Qt5)/08_CTKPlugin/CTKPlugin/CTK/lib/ctk-0.1/plugins");
#elsectkPluginFrameworkLauncher::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;}//在框架初始化启动成功后再调用事件监听EventListener eventListener;framework->getPluginContext()->connectFrameworkListener(&eventListener, SLOT(slotFrameWorkEvent(ctkPluginFrameworkEvent)));framework->getPluginContext()->connectPluginListener(&eventListener, SLOT(slotPluginEvent(const ctkPluginEvent&)));framework->getPluginContext()->connectServiceListener(&eventListener, "slotServiceEvent");//QString dir = QCoreApplication::applicationDirPath();//dir += "/plugins/TestPlugin.dll";//QUrl url = QUrl::fromLocalFile(dir);QSharedPointer<ctkPlugin> plugin;
#if 1QDirIterator 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;}}
#endif//外部调用测试服务追踪ctkServiceReference ref = framework->getPluginContext()->getServiceReference<IServiceTrackerPlugin>();if (ref){IServiceTrackerPlugin* service = qobject_cast<IServiceTrackerPlugin*>(framework->getPluginContext()->getService(ref));if (service != nullptr){service->printf();}}//ctkPlugin::State sta = plugin->getState();//ctkPluginFrameworkLauncher::stop();//plugin->stop(); //plugin->uninstall();//sta = plugin->getState();CTKPlugin c;c.show();return a.exec();
}