QGIS插件机制研究与实验（插件开发C++版）

我就是我 2022-11-20 09:49 720阅读 0赞

研究完QGIS的插件机制，基本就知道了C++的插件开发，当然可能QGIS这种只是C++插件开发中的一种，以后如果见到其他类的插件开发会继续研究。本次研究的QGIS版本为2.18.5，但其他版本的插件机制与此大同小异，所以只要这个理解了即可举一反三，触类旁通。

# 1 研究 #

## 1.1 结构 ##

首先，还是要看一下插件机制的结构图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center]  
这是我通过研究源码绘制出的，至于是怎么一步步研究源码得出这个结果，思路可以参照[这篇文章][Link 1]。知道了结构就为研究原理奠定了基础，而了解了原理，再进行插件开发就容易了。图中的各个类需要解释一下：

### 1.1.1 QgisInterface ###

先来看一下头文件  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 1]  
该类隶属GUI模块，可以看到里面定义了大量接口，几乎涉及了QGIS里的常用操作，添加图层，获取菜单栏等等。我这里就不再列出所有源码了，大家可以自己去看。这个类顾名思义就是QGIS接口，插件便是通过这些接口和QGSI进行交互的。后面会具体讲解如何进行交互。

### 1.1.2 QgsPluginManager ###

插件管理器，隶属APP模块，负责加载、卸载插件等，当你点开QGIS应用上的插件管理器时，弹出的就是这个东东。

### 1.1.3 QgisPlugin ###

插件。简单看一下描述  
![在这里插入图片描述][2020102814562121.png_pic_center]  
所有插件都必须继承的抽象基类，这告诉我们要想进行插件开发，首先你的插件要继承该类。这一点在结构图上就有体现。接着往下看  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 2]  
在构造函数中，你可以传入插件名、描述、分类、版本等。这些信息就是将来显示在插件管理器里面的。再往下看  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 3]  
这里定义了一些函数指针，**特别注意，这一些都是需要自定义插件里实现的，并且要实现为导出函数**。**第一个函数是最重要的，一个工厂函数，用于创建你的插件**。具体在后面实验里讲。其它函数就是主程序用来获取描述、版本等信息。

### 1.1.4 QgsPluginRegistry ###

插件注册器，单例类，聚合于插件管理器，负责插件的注册、加载等。其实插件管理器的加载，具体是由插件注册器完成的。

## 1.2 流程 ##

首先要找的就是loadPlugin()函数，根据插件机制的核心类，我们先打开qgspluginmanager.cpp看看，发现有这个函数  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 4]  
可以看到在这里根据插件插件类型（C++/Python），调用pRegistry加载，pRegistry就是QgsPluginRegistry，我们再打开qgspluginregistry.cpp找到loadCppPlugin()，这个函数较大，所以就只截取关键部分来解释。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 5]  
这里用了QLibrary，目的是解析插件中的导出函数（因为插件本身的物理形式是dll文件），获取其函数指针，这些函数指针就是上一节我说的必须要实现为导出函数的那些。可以看到在这里他获取到了插件类型（pType）和（pName）的函数指针。再往下看  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 6]  
这里开始解析“classFactory”符号，也就是上一节提到的那个要实现的创建你自己插件的函数。cf是获取到的函数指针，下面用这个函数指针创建了插件，注意这里有个参数mQgisInterace，没忘吧，这个就是插件和QGIS交互的接口，通过它可以在QGIS界面上添加菜单，添加界面等操作，还可以直接添加图层等等。**这一步走完插件就算加载上了。**  
为什么要必须实现那些函数指针，看下这个函数就知道了QgsPluginRegistry::checkCppPlugin（）这里有一段  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 7]  
在这里要获取描述、版本等的函数指针，如果获取不到返回false。  
接着往下看看那些版本、图标等元数据信息在哪里获取，看下这个函数  
QgsPluginManager::getCppPluginsMetadata()里的一段  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 8]  
就是在这里获取到了插件里的各类信息。好了，到这里基本流程就差不多了，有问题的可以及时交流。

# 2 实验 #

知道了原理接下来实现就很容易了。以下代码是我之前在做切图工具时的代码，后来想把它作为QGIS插件。所以大家看的时候要有取舍，着重看插件实现的部分，这些代码只是为了说明问题，并不能独立运行。大家比葫芦画瓢就行。

#ifndef TOOLSLICEMAP_H
    #define TOOLSLICEMAP_H
    
    // Qt Includes
    #include <QObject>
    #include <QAction>
    #include <QToolBar>
    
    // QGIS Includes
    #include <qgisplugin.h>
    #include <qgisinterface.h>
    #include <qgisgui.h>
    class QMenu;
    class QMainWindow;
    class QgsSliceMapToolPlugin : public QObject, public QgisPlugin//必须继承QgisPlugin
    { 
        Q_OBJECT
    
      public:
    
        explicit QgsSliceMapToolPlugin( QgisInterface * theInterface );
        //! Destructor
        virtual ~QgsSliceMapToolPlugin();
    
      public slots:
    
        virtual void initGui() override;//初始化界面
        //显示对话框
        void run();
        //卸载插件
        void unload() override;
        //显示帮助文档
        void help();
    
      private:
    
        //QGIS接口
        QgisInterface *mQGisIface;
        
        QAction * mQActionPointer;
    	QMenu* m_pToolMenu;
    	
    
    };
    
    #endif //ToolSliceMap_H

#include "ToolSliceMap.h"
    //#include "qgsselectgeoraster_ui.h"
    #include <QMessageBox>
    #include <QMenu>
    #include <QMenuBar>
    #include <QMainWindow>
    #include <VBF_DlgToolSliceMap.h>
    #include <qgsmapcanvas.h>
    #include <qgsmaplayerregistry.h>
    //元数据信息，包括名称、版本、图标等
    static const QString sName = QObject::tr( "Slice Map Tool" );
    static const QString sDescription = QObject::tr( "you can use this to produce tiles" );
    static const QString sCategory = QObject::tr( "Layers" );
    static const QString sPluginVersion = QObject::tr( "Version 1.0" );
    static const QgisPlugin::PLUGINTYPE sPluginType = QgisPlugin::UI;
    static const QString sPluginIcon = ":/SliceMapTool/hello.svg";
    QgsSliceMapToolPlugin::QgsSliceMapToolPlugin( QgisInterface * theQgisInterface )
        : QgisPlugin( sName, sDescription, sCategory, sPluginVersion, sPluginType )
        , mQGisIface( theQgisInterface )
        , mQActionPointer( nullptr )
    { 
    	m_pToolMenu = NULL;
    	//m_pMainWnd = NULL;
    }
    
    QgsSliceMapToolPlugin::~QgsSliceMapToolPlugin()
    { 
    
    }
    
    //初始化界面
    void QgsSliceMapToolPlugin::initGui()
    { 
    	//获取主窗口
    	QMainWindow* pMainWnd = qobject_cast<QMainWindow*>(mQGisIface->mainWindow());
    	if (pMainWnd)
    		 m_pToolMenu = pMainWnd->menuBar()->addMenu("Tools");//添加菜单
    	
    	
    	//创建Action
    	mQActionPointer = new QAction( QIcon( ":/SliceMapTool/hello.svg" ), tr( "slice map tool" ), this );
    	mQActionPointer->setObjectName( "mQActionPointer" );
    	// 设置tooltip
    	mQActionPointer->setWhatsThis( tr( "you can use this to produce tiles" ) );
    	
    	connect( mQActionPointer, SIGNAL( triggered() ), this, SLOT( run() ) );
    
    	if(m_pToolMenu)
    		m_pToolMenu->addAction(mQActionPointer);//添加Action
    	
    }
    
    void QgsSliceMapToolPlugin::help()
    { 
    }
    //点击按钮时要干的事
    void QgsSliceMapToolPlugin::run()
    { 
    	//disconnect(QgsMapLayerRegistry::instance(),0,0,0);
    	QgsMapLayerRegistry::instance()->blockSignals(true);
    	CVBF_DlgToolSliceMap tool;
    	tool.exec();
    	QgsMapLayerRegistry::instance()->blockSignals(false);
    
    }
    //卸载插件
    void QgsSliceMapToolPlugin::unload()
    { 
      // remove the GUI
    	if (m_pToolMenu)
    	{ 
    		delete m_pToolMenu;
    		m_pToolMenu = NULL;
    	}
      delete mQActionPointer;
      mQActionPointer = nullptr;
    }
    
    //以下就是要求实现的导出函数
    
    //插件创建
    QGISEXTERN QgisPlugin * classFactory( QgisInterface * theQgisInterfacePointer )
    { 
      return new QgsSliceMapToolPlugin( theQgisInterfacePointer );
    }
    QGISEXTERN QString name()
    { 
      return sName;
    }
    
    
    QGISEXTERN QString description()
    { 
      return sDescription;
    }
    
    
    QGISEXTERN QString category()
    { 
      return sCategory;
    }
    
    QGISEXTERN int type()
    { 
      return sPluginType;
    }
    
    QGISEXTERN QString version()
    { 
      return sPluginVersion;
    }
    
    QGISEXTERN QString icon()
    { 
      return sPluginIcon;
    }
    
    QGISEXTERN void unload( QgisPlugin * thePluginPointer )
    { 
      delete thePluginPointer;
    }

由于我是直接在源码里构建所以需要用到CMakeList，所以不在源码里就不用它，这里如果有朋友需要在源码里构建，也可以参考一下

########################################################
    # Files
    
    SET (SLICEMAPTOOLPLUGIN_SRCS
         ToolSliceMap.cpp
         VBF_DlgToolSliceMap.cpp
         VBF_ToolSliceMap.cpp
    )
    
     SET (SLICEMAPTOOL_UIS
          VBF_DlgToolSliceMap.ui
     )
    
    SET (SLICEMAPTOOL_MOC_HDRS
         ToolSliceMap.h
         VBF_DlgToolSliceMap.h
         VBF_ToolSliceMap.h
    )
    
    SET (SLICEMAPTOOL_RCCS  SliceMapTool.qrc)
    
    ########################################################
    # Build
    
     QT4_WRAP_UI (SLICEMAPTOOL_UIS_H  ${SLICEMAPTOOL_UIS})
     QT4_WRAP_CPP (SLICEMAPTOOL_MOC_SRCS  ${SLICEMAPTOOL_MOC_HDRS})
    
     QT4_ADD_RESOURCES(SLICEMAPTOOL_RCC_SRCS ${SLICEMAPTOOL_RCCS})
    
    #ADD_LIBRARY (oracleplugin SHARED ${ORACLE_SRCS} ${ORACLE_MOC_SRCS} ${ORACLE_RCC_SRCS} ${ORACLE_UIS_H})
    ADD_LIBRARY (ToolSliceMap SHARED ${SLICEMAPTOOLPLUGIN_SRCS} ${SLICEMAPTOOL_MOC_SRCS} ${SLICEMAPTOOL_RCC_SRCS} ${SLICEMAPTOOL_UIS_H})
    
    INCLUDE_DIRECTORIES(
         ${CMAKE_CURRENT_SOURCE_DIR}
         ${CMAKE_CURRENT_BINARY_DIR}
         ../../core ../../core/geometry ../../core/raster
         ../../gui
         ..
    	 ${VBF_INTERFACE_INCLUDE}/VBF_DB
    	 ${VBF_INTERFACE_INCLUDE}
    	 ${VBF_PUBLIC_INCLUDE}
    	 
    )
    INCLUDE_DIRECTORIES( SYSTEM
         ${GDAL_INCLUDE_DIR}
    )
    
    TARGET_LINK_LIBRARIES(ToolSliceMap
      qgis_gui
      VBF_ToolSliceMap
    )
    
    
    ########################################################
    # Install
    
    INSTALL(TARGETS ToolSliceMap
      RUNTIME DESTINATION ${QGIS_PLUGIN_DIR}
      LIBRARY DESTINATION ${QGIS_PLUGIN_DIR})

最后把编译生成的插件，放在QGIS安装目录的plugins文件下（例如：apps/qgis/plugins），重启QGIS，打开插件管理器就能看到你的插件了。

# 3 效果 #

![在这里插入图片描述][20201028183846901.gif_pic_center]  
文末附上一些教程：  
开源GIS视频教程 [点这里][Link 2] 密码：498202  
开源gis视频介绍[点这里][Link 3] 密码：498202  
大数据课程: [点这里][Link 4] 密码：498202  
Python相关: [点这里][Link 5] 密码：498202

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/5787286d3722470a9017dfbf6b536611.png
[Link 1]: https://blog.csdn.net/a374682949/article/details/108560372
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/2d2156e729e2428d8ac453562cf4f7ea.png
[2020102814562121.png_pic_center]: https://img-blog.csdnimg.cn/2020102814562121.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20201028145921815.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201028160508334.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201028163317997.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 5]: https://img-blog.csdnimg.cn/20201028164458963.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 6]: https://img-blog.csdnimg.cn/20201028164943417.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 7]: https://img-blog.csdnimg.cn/20201028170736346.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk_size_16_color_FFFFFF_t_70_pic_center 8]: https://img-blog.csdnimg.cn/20201028172759424.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2EzNzQ2ODI5NDk=,size_16,color_FFFFFF,t_70#pic_center
[20201028183846901.gif_pic_center]: https://img-blog.csdnimg.cn/20201028183846901.gif#pic_center
[Link 2]: https://72k.us/file/24073260-421151217
[Link 3]: https://blog.csdn.net/a374682949/article/details/104232027
[Link 4]: https://72k.us/file/24073260-421226432
[Link 5]: https://72k.us/file/24073260-421226422