GeoServer源码解析和扩展 (二)注册服务
先上源码下载
上一章我们介绍了GeoServer源码分析的必要性(这个就见仁见智了)以及诸项准备工作,并且在最后还给出了OWS请求处理流程的伪代码。
这一章我们来看看要注册自己的服务需要做哪些工作。假设我们要为一个物流公司GOODS开发系统,有一个功能是给定起点和终点的城市名称以及包裹的重量返回运费,运费的计算公式如下:
运费(¥) = 距离(千米) X 货物重量(千克)
我们需要知道城市间的距离,这就需要用到GIS系统(当然也可以不用),假设已经部署了GeoServer服务器(个人以为如果要求不高或者钱没有多到烫人,使用这种免费的软件足够用了)。基本设计是这样的,为GeoServer注册一个新的服务“trans”,它有一个方法“GetOutlay”,方法参数是:起点“FROM”,终点“TO”,货物质量“WEIGHT”,返回运费。下面是一个典型的请求:
http://localhost:8080/geoserver/trans?request=GetOutlay&from=Chengdu&to=Shanghai&weight=100。
让我们来看看要注册一个服务都需要做些什么。以wms为例,在wms包的applicationContext.xml文件里有如下片段。
首先,我们需要创建一个Java项目“trans”,然后在项目中包含配置文件“applicationContext.xml”
在配置文件里添加如下片段
为项目增加一个类com.goods.TransService,它有一个公共方法GetOutlay,这个方法可以没有参数也没有返回值。为了能在Eclipse里面运行,我们需要把“trans”项目增加到“web-app”项目的依赖关系里
我们有了一个服务类并且注册到了运行时环境里,现在我们需要让Servlet找到它,打开web-app下面的的web.xml文件
在里面添加下面一段
然后在本项目的配置文件中增加下面一段
现在,启动GeoServer,在浏览器中敲入“http://localhost:8080/geoserver/trans?request=GetOutlay&from=Chengdu&to=Shanghai&weight=100”,回车。浏览器页面为空,没有报错,表示服务注册成功了,但是这个服务还没有任何功能。
继续以WMS为例,来看看DefaultWebMapService类的GetMap函数
它有一个参数GetMapRequest和一个返回值GetMapResponse,GetMapRequest是从org.vfny.geoserver.Request继承来的,而GetMapResponse实现了org.vfny.geoserver.Response接口,这两个抽象类在Dispatcher处理请求时会用到。先不多想,照猫画虎,于是我们有了GetOutlayResponse和GetOutlayRequest
然后修改TransService的代码如下
再次启动项目,运行例子,我们得到这样一条异常
异常是从Dispatcher的dispatch函数抛出的,因为没有找到创建GetOutlayRequest的reader。于是我们再次到wms的配置文件里取经,请看下面这段
看来我们还需要一个叫GetOutlayKvpReader的类。增加GetOutlayKvpReader到“trans”项目
并且在配置文件中添加如下信息
仔细研究GetMapKvpRequestReader的代码之后,写出GetOutlayKvpReader的代码,如下:
Dispatcher将会利用这个类从请求参数里创建GetOutlayRequest对象。再次运行程序,又出现一个异常
这一次是Dispatcher的response函数抛出,大意是找不到处理GetOutlayResponse类型的response。再一次,从wms的配置文件中我们找到了这样一段
这说明我们还需要把GetOutlayResponse注册到运行时中去,在本项目的配置文件中添加如下信息
这一次运行程序,浏览器没有抛出异常,但还是没有结果。
来回想一下我们的设计:找到两个城市,计算距离,计算运费,输出。城市名称是从请求参数里获得的,并且已经由GetOutlayKvpReader将它们保存到GetOutlayRequest对象里面,现在需要查询城市地理坐标。通过研究GetMapResponse的代码,我们决定把这部分代码放到GetOutlayResponse的execute函数中,并且需要用到Catalog对象,这个对象可以查询已经部署的要素类型(测试数据在此下载,如何部署可以参看这篇文章)。我们需要把Catalog对象传给GetOutlayResponse,而GetOutlayResponse又是在TransService里面创建的,所以我们应该把Catalog传给TransService。先来修改TransService的代码
然后修改配置文件里面注册服务的那一段,添加引用Catalog的信息
如果你对变量“catalog”感到迷惑的话,可以去看看main包的配置文件,这个变量是这里创建的
不难看出,Catalog在整个GeoServer中只有一个实例。最后完成GetOutlayResponse的execute函数
和writeTo函数
启动程序,运行请求,会得到如下结果。
这表示我们的服务能够工作了。
将这个项目输出成jar文件,然后将jar文件复制到目录“[GeoServer安装目录]\webapps\geoserver\WEB-INF\lib”下,按照前面步骤修改“[GeoServer安装目录]\webapps\geoserver\WEB-INF\web.xml”文件,启动GeoServer,运行请求,会得到同样的结果,大功告成。
本章我们快速的实现了一个服务,并且将它注册到GeoServer中。但是留下了很多疑问,这些疑问不搞清楚,就只能算知其然而不知所以然。下一章我会重点介绍GeoServer的结构,到时候本章许多疑问将会迎刃而解。