CTK插件框架学习-源码下载编译(01)https://mp.csdn.net/mp_blog/creation/editor/136891825
开发环境
window11、vs17、Qt5.14.0、cmake3.27.4
开发流程
- 新建ctk框架调用工程(CTKPlugin)
- 拷贝CTK源码编译完成后的头文件和库文件到工程目录,并配置工程属性
- main.cpp
#include "CTKPlugin.h" #include <QtWidgets/QApplication> #include <iostream> #include <QStyleFactory> #include <QDir> #include <QDirIterator> #include "ctkPluginFrameworkFactory.h" #include "ctkPluginFramework.h" #include "ctkPluginException.h" #include "ctkPluginContext.h" #include "ctkPluginFrameworkLauncher.h" #include "../TestPlugin/iTestPlugin.h" #include "../TestPlugin/LogServicesI.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 + "/plugins"); #else ctkPluginFrameworkLauncher::addSearchPath(path + "/libs/plugins"); #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; } QString dir = QCoreApplication::applicationDirPath(); dir += "/plugins/TestPlugin.dll"; QUrl url = QUrl::fromLocalFile(dir); QSharedPointer<ctkPlugin> plugin; try { plugin = framework->getPluginContext()->installPlugin(url); //获取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);//表示立即启用插件,不设置参数的话加载后也不会立即打印输出 } catch (ctkPluginException e) { std::cout << e.message().toStdString() << e.getType() << std::endl; } //测试插件 iTestPlugin* it = NULL; ctkServiceReference ref = framework->getPluginContext()->getServiceReference<iTestPlugin>(); if (ref) { it = framework->getPluginContext()->getService<iTestPlugin>(ref); } if (it) { it->showWidget(); } //ctkPlugin::State sta = plugin->getState(); //ctkPluginFrameworkLauncher::stop(); //plugin->stop(); //plugin->uninstall(); //sta = plugin->getState(); CTKPlugin c; c.show(); return a.exec(); }
- 拷贝CTK源码编译完成后的头文件和库文件到工程目录,并配置工程属性
- 新建插件工程(TestPlugin)
- 拷贝源码编译完成后的头文件和库文件到工程目录,并配置工程属性(同上)
- 新建注册器类
PluginActivator.h#pragma once #include <qobject.h> #include "ctkPluginActivator.h" #include "ctkPluginContext.h" #include "TestPlugin.h" class PluginActivator : public QObject, ctkPluginActivator { Q_OBJECT Q_INTERFACES(ctkPluginActivator)//向Qt的插件框架声明,希望将xxx插件放入到框架中。 Q_PLUGIN_METADATA(IID "TestPlugin")//向qt框架申明插件(qt5版本) public: PluginActivator(); void start(ctkPluginContext *context); void stop(ctkPluginContext *context); private: QScopedPointer<TestPlugin> m_testPlugin;//智能指针,自动析构回收 };
PluginActivator.cpp#include "PluginActivator.h" #include <QDebug> #include "ctkPluginContext.h" PluginActivator::PluginActivator() { } void PluginActivator::start(ctkPluginContext *context) { //实现插件自己的功能 qDebug() << "my plugin start"; m_testPlugin.reset(new TestPlugin(context)); ctkDictionary dic; context->registerService<iTestPlugin>(m_testPlugin.get(), dic); } void PluginActivator::stop(ctkPluginContext *context) { qDebug() << "my plugin stop"; Q_UNUSED(context)// Q_UNUSED,如果一个函数的有些参数没有用到、某些变量只声明不使用,但是又不想编译器、编辑器报警报,其他没有什么实际性作用 ctkServiceReference ref = context->getServiceReference<iTestPlugin>(); context->ungetService(ref); }
- 新建插件接口文件
iTestPlugin.h#pragma once #include <QObject> #include <qstring.h> class iTestPlugin { public: virtual ~iTestPlugin() {} virtual void showWidget() = 0; }; Q_DECLARE_INTERFACE(iTestPlugin, "zr.iTestPlugin")//声明一个接口类,此宏将当前这个接口类向qt系统声明为接口,后面的一长串就是这个接口的唯一标识。
- 新建插件实现文件
iTestPlugin.h#pragma once #include <qobject.h> #include "iTestPlugin.h" #include "MyWidget.h" class ctkPluginContext; class TestPlugin : public QObject, public iTestPlugin { Q_OBJECT Q_INTERFACES(iTestPlugin)//此宏与Q_DECLARE_INTERFACE宏配合使用, 表明当前插件类实现这个服务接口 public: TestPlugin(ctkPluginContext* context); ~TestPlugin(); virtual void showWidget(); private: ctkPluginContext *m_context; QScopedPointer<MyWidget> m_myWidget;//空测试窗口 };
iTestPlugin.cpp#include "TestPlugin.h" #include "ctkPluginContext.h" TestPlugin::TestPlugin(ctkPluginContext* context) : m_context(context) { m_myWidget.reset(new MyWidget()); } TestPlugin::~TestPlugin() { } void TestPlugin::showWidget() { m_myWidget.get()->show(); }
- 添加资源文件
- 每个插件必须有一个资源文件,名称一般与插件名称一致,前缀必须为TARGET/META-INF,例:插件名称/META-INF
- 每个插件必须添加一个元数据文件,名字必须为MANIFEST.MF,并添加到资源文件中
- 生成插件库文件到框架指定的调用目录
- 插件卸载后没有从框架中移除,热插拔实现待定。。。