使用Python进行QGIS二次开发1

Date: 2014-11-30 21:09
Summary: 本文记录了使用Python进行QGIS二次开发的过程，以及过程中遇到的问题。由于内容较多，将文章分成2个部分。这是第一部分。

使用Python进行QGIS二次开发1

最近在做QGIS二次开发，支持C++和Python。综合各种原因，考虑选择使用Python语言。在开发过程中遇到不少坑，费了不少劲，也总结了很多经验教训。在此以一些代码为例，简单分享一下QGIS二次开发过程中的种种问题。注意：本人开发的是独立程序，而不是QGIS插件。

主要内容

1. 环境配置

QGIS最新版本到了2.6，但是其官方文档还停留在2.2。抱着好奇的心态先装了一下2.6熟悉了一番，准备进行开发时候遇到了第一个坑，2.6中带的Python启动报错，缺少模块！没办法，看到文档是2.2版本，就想着按着文档来吧，于是又装了2.2。但是事实证明这次出bug的地方是另一处（后面会详细介绍）。还好中间有个2.4的版本，再有bug的话真是考虑换平台了。幸亏这个2.4版本能用。

网上讲环境配置大多数是用C++开发，python开发的比较少。Python开发环境的搭建主要是一些包所在的路径要写到环境变量中才能找到。这里遇到的困难就是环境变量中的路径该怎么写？QGIS在2.x之后加入了不少内容，路径和以前的已经完全不一样了，最可恶的是官方文档中竟然都有错误的。就像下图中，左侧是官方文档给出的路径，右侧是实际的路径，完全匹配不上啊！！！

QGIS文件夹比较

只好自己摸索着前进了。最终配置好的环境如下：

• 操作系统：Win7 64位sp1 virtual box虚拟机

• 环境变量设置：

  QGISDIR=D:/Program Files (x86)/QGIS Chugiak
  QGIS_PREFIX=%QGISDIR%/apps/qgis
  PATH=%QGISDIR%/bin;%QGISDIR%/apps/qgis/bin;(后面是原内容)
  PYTHONPATH=%QGISDIR%/apps/Python27/Lib/site-packages;%QGISDIR%/apps/qgis
  GDAL_DATA=%QGISDIR%/share/gdal (QGIS在加载数据集的时候，需要找GDAL中的配置文件，所以需要这个)

• 开发环境：Pycharm 3.4

• 代码管理：github

环境配好以后打开命令行，输入python启动python解释器，然后输入：

>>> import PyQt4.QtCore
>>> import PyQt4.QtGui
>>> import qgis.core
>>> import qgis.gui
>>> 

如果没有错误的话，就说明环境配置OK。

2. 使用Qt界面

这部分主要就是PyQt的使用了。关于PyQt国内外也有很多教程可以参考.PyQt的使用和Qt的使用类似，只是某些地方不一样。有一本书Rapid GUI Programming with Python and Qt就是专门讲这个的，感兴趣的可以在网上搜一下。这篇帖子是一个很好的介绍Python开发QGIS的资料，不过实用的版本都比较老了，我也是从这里开始的。下面对其中的一些关键点进行解释。

2.1 使用Qt Designer来设计界面

Qt Designer是开发Qt程序的图形界面。可以通过拖拽直接在上面放置Widget进行界面设计，很方便。最后会得到ui文件和qrc文件。

Qt Designer

2.2 编译ui和rc文件

设计完成之后要在PyQt里面用起来的话，还需要一个编译的过程。使用下面的命令进行编译：

pyuic4 -o filename_gui.py filename.ui  
purcc4 -o filename_rc.py filename.qrc

需要注意的是，-o参数指定的是输出文件，filename所使用的文件名一定要是一样的，并且后缀_gui和_rc一定要加，因为_gui文件的最后会import加后缀_rc的文件。否则就会找不到。

2.3 QGIS应用开发

这里以ShapeViewer为例，主窗口代码如下：

class ShapeViewer(QMainWindow, Ui_MainWindow):
  def __init__(self):
    QMainWindow.__init__(self)

    # Required by Qt4 to initialize the UI
    self.setupUi(self)

    # Set the title for the app
    self.setWindowTitle("ShapeViewer")

    # Create the map canvas
    self.canvas = QgsMapCanvas()        
    self.canvas.show()
    self.canvas.setCanvasColor(QColor(255,255,255))
    self.canvas.enableAntiAliasing(True)

    # Lay our widgets out in the main window using a 
    # vertical box layout
    self.layout = QVBoxLayout(self.frame)
    self.layout.addWidget(self.canvas)

    # layout is set - open a layer
    # Add an OGR layer to the map
    file = QFileDialog.getOpenFileName(self, 
                   "Open Shapefile", ".", "Shapefiles (*.shp)")
    fileInfo = QFileInfo(file)

    # Add the layer
    layer = QgsVectorLayer(file, fileInfo.fileName(), "ogr")

    if not layer.isValid():
      return

    # Add layer to the registry
    QgsMapLayerRegistry.instance().addMapLayer(layer);

    # Set extent to the extent of our layer
    self.canvas.setExtent(layer.extent())

    # Set up the map canvas layer set
    cl = QgsMapCanvasLayer(layer)
    layers = [cl]
    self.canvas.setLayerSet(layers)

下面做一些简要的解释：

• 首先调用setupUi，这是Qt中固定的模式
• 新建QgsMapCanvas对象，并调用show使其显示，设置背景颜色为白色（默认是黑色的），并且开启抗锯齿效果
• 使用QVBoxLayout来进行纵向的布局
• 打开一个shp文件作为矢量图层，使用的是gdal里面提供的ogr
• QgsMapLayerRegistry相当于是一个图层管理器，所有的图层都要加到里面去
• 使用setExtent函数来设置MapCanvas的可视范围
• 使用setLayerSet来给MapCanvas设置进行渲染的图层

入口函数和启动Qt程序的代码如下：

def main(argv):
  # create Qt application
  app = QApplication(argv)

  # Initialize qgis libraries
  QgsApplication.setPrefixPath(qgis_prefix, True)
  QgsApplication.initQgis()

  # create main window
  wnd = ShapeViewer()
  # Move the app window to upper left
  wnd.move(100,100)
  wnd.show()

  # run!
  retval = app.exec_()
  
  # exit
  QgsApplication.exitQgis()
  sys.exit(retval)


if __name__ == "__main__":
  main(sys.argv)

解释几点：

• 要注意QGIS的使用方法。设置prefix，进行初始化，最后在程序退出之前QGIS也要退出。
• qgis_prefix变量一定要设置正确。因为QGIS和以前版本组织文件的方法已经不同了，本人试了几次，该变量的值就是前面设置的QGIS_PREFIX环境变量的值，可以直接取出来用。

有几点需要注意：

1. QgsMapLayerRegistry的作用相当于是一个图层管理器，并且提供了添加和删除的接口；QgsMapCanvas中的LayerSet是用来进行渲染的图层的集合，在动态添加和删除图层的时候要注意这两者的区别和使用方法。
2. QGIS2.2地图控件中有bug：程序启动之后必须先失去一下焦点，然后才能显示出地图内容，这是已知的一个bug（http://gis.stackexchange.com/questions/87841/why-qgsmapcanvas-only-appear-after-lost-focus?rq=1），所以避开了2.2的版本。毕竟是开源软件，可以理解。