Server Objects Extension（SOE）开发（二）

前言

SOE的提供了REST和Soap两种模板，只要在模板特定的方法中添加自己的业务逻辑代码即可，开发流程非常的简单便捷。那怎么知道自己的业务逻辑代码该写在模板的那个方法里面呢？这就需要很好的理解SOE的生命周期以及生命周期在模板中的对应。这里将以SOE开发流程来介绍SOE开发rest模板。

环境说明：arcgis server 10.2，visual studio 2012

一、soe的开发流程

通常soe的业务开发流程通常包括以下方面：

1.客户端将参数进行序列化成json对象，通过http协议将参数传递给服务器端

2.服务器端接受和处理参数

通过接受前端的json，反序列化成需要的对象类型，如常见的string，double，或者ao对象如IGometry等

3.业务处理阶段

该阶段调用ArcObject的接口，通常该阶段的代码可以直接从桌面的ao程序移植过来

4.最后阶段是结果返回到前端

soe的前后端的交互是基于http协议的，故结果可以序列化成json返回前端，也可以是图片的形式等符合http协议传输的内容

上图是一个点生成缓冲区的soe实现流程：

1.从客户端获取屏幕坐标点，将屏幕坐标点以json的形式返回到服务端

2.服务端以JsonObject对象实例中反序列化获取参数，

3.参数转换成Ipoint对象

4.调用Ao接口对IPoint对象进行buffer

5.buffer的结果序列化成json对象返回给前端

二、模板及模板对应流程

2.1 模板头

安装完ao sdk，就能以rest或者soap模板的形式实现soe了，打开soe rest模板，前面guid表明soe是com对象的形式实现，

1.指定soe扩展的服务类型，该为10.2版本soe的新特性，在10.2以前的版本中，soe只能扩展MapServer，而10.2的版增加了对imageServer的扩展，

tips：在10.2 rest模板中必须手动选择是扩展MapServer还是imageServer而10.2以前的版本是不需要的

2.all Capabilities 指soe支持的操作，里面填写的名字应该与后面的operation对应 

tips：注意区分这里的Capabilities与服务编辑对话中的Capabilities的区别。这里的Capabilities的可以理解成操作

3.defaultCapilites 是这默认的操作

4.description soe的描述，部署soe后在manager中可以看到期描述

5.soe的显示名称

6.Properties是soe的属性

7.表明是一个rest模板

2.2 IServerObjectExtension 接口的成员

该接口Init（）和shutdown（）方法是必须实现的接口，这两个方法分别在soe的初始化和关闭的时候触发。

Tips：通过该系列文章1可知，soe的初始化只执行一次，故可以将只需执行一次且耗时的操作放在Init（）方法中，比如从MapServer中获取相关的数据

      public void Init(IServerObjectHelper pSOH)
        {
            serverObjectHelper = pSOH;
        }

        public void Shutdown()
        {
        }

而在Shutdown（）方法中可以添加对象释放代码，则在soe关闭后释放资源

IObjectsCostruct接口成员

该接口只有一个成员Construct()方法，通常在该方法中获取soe的属性。也可以将比较耗时的操作放在该方法里。

  public void Construct(IPropertySet props)
        {
            configProps = props;
        }

Tips：soe的属性是soe的管理人员用来对客户端端使用soe的控制，比如点创建buffer，buffer的半径是不断的变化的，今天只允许客户端创建不大于5m buffer，明天也许只允许客户端创建不小于5m的buffer，soe可以将缓冲距离设置成属性，通过在manager里面更改属性值，就可以很好的控制而不需要重新对soe代码更改。

IRESTRequestHandler 成员

GetSchema()和HandleRESTRequest()，获取schema，和处理和返回前端的请求。这两个方法中的代码保存不动。

        public string GetSchema()
        {
            return reqHandler.GetSchema();
        }

        public byte[] HandleRESTRequest(string Capabilities, string resourceName, string operationName, string operationInput, string outputFormat, string requestProperties, out string responseProperties)
        {
            return reqHandler.HandleRESTRequest(Capabilities, resourceName, operationName, operationInput, outputFormat, requestProperties, out responseProperties);
        }

CreateRestSchema()。该方法位于命名空间ESRI.Arcgis.SOESupport中返回一个RestResource对象创建SOE的Schema，返回RestResource对象，从单词的字面意思也可以看出，该方法是创建一个Rest资源。

Schema是有资源和操作组成json对象，在下面的代码片段中出，声明了一个rootRes资源，并为该资源添加了一个sampleOper对象操作，操作名称为sampleOperation，该操作包含两个参数parm1，parm2，这两个参数来自于前端，该操作的具体实现通过一个委托SampleOperHandler实现。

可以为一个soe创建多个资源和操作，资源还可以添加子资源，每个子资源可以添加操作。tips：注意这里参数名和代理的名和下面操作的函数要匹配。

   private RestResource CreateRestSchema()
        {
            RestResource rootRes = new RestResource(soe_name, false, RootResHandler);

            RestOperation sampleOper = new RestOperation("sampleOperation",
                                                      new string[] { "parm1", "parm2" },
                                                      new string[] { "json" },
                                                      SampleOperHandler);

            rootRes.operations.Add(sampleOper);

            return rootRes;
        }

RootResHandler()。

SampleOperHandler()。操作的handler函数，这是SOE的核心。soe的大部分流程在该方法中实现

 

  private byte[] SampleOperHandler(NameValueCollection boundVariables,
                                                  JsonObject operationInput,
                                                      string outputFormat,
                                                      string requestProperties,
                                                  out string responseProperties)
        {
            responseProperties = null;

            string parm1Value;
            bool found = operationInput.TryGetString("parm1", out parm1Value);
            if (!found || string.IsNullOrEmpty(parm1Value))
                throw new ArgumentNullException("parm1");

            string parm2Value;
            found = operationInput.TryGetString("parm2", out parm2Value);
            if (!found || string.IsNullOrEmpty(parm2Value))
                throw new ArgumentNullException("parm2");

            JsonObject result = new JsonObject();
            result.AddString("parm1", parm1Value);
            result.AddString("parm2", parm2Value);

            return Encoding.UTF8.GetBytes(result.ToJson());
        }

1.参数的反序列化

JsonObject对象提供了很多的Tryget**（）方法，如下图所示：

将前端传递过来的json对象反序列化成所需对象，如TryGetAsString获取将json参数转换成string类型的参数。方法的第一参数string为参数的名称，如param1，与操作中参数名称保存一致。

Tips：在转换的时候esri做了智能处理，会判断客户端参数的情况将默认其转换类型。比如你前端传递的参数是12345，soe默认是转成数字而不是string，如果在soe端用tryasstring方法，就不能获取到值。这种智能也给造成麻烦。解决办法是可以将转成object对象，再转成string

2.业务逻辑的实现，可以在这里使用ao的相关代码

3.处理结果序列化

该结果是反序列化的逆结果，如上面模板代码中的addstring，将string对象反序列化话成json等等。除了上面提到的常见数据类型的序列化与反序列化，esri.arcigs.soesupport ，还直接提供了ao对象的如Igometry，IRecordSet等的序列与反序列化，如下图所示

三、SOE从MapServer中获取数据源

soe开发中，一个必须的环节是MapServer中获取业务数据，其中提供了IMapServerDataAccess接口，该接口通过GetDataSource、GetDisplayDataSource获取数据源，当获取的图层是栅格图层则是IRaster类型，矢量是IFeatureClass，表为ITable类型。这两个方法都能获取数据源，不同的区别在当数据源存在关联数据时，GetDataSource不能获取关联数据，而后者是可以的。

从10.1以来，server的服务的发布采用msd的形式，而不是mxd，地图绘制引擎发生了改变，这使得在网络端，地图的绘制速度，效果更佳。这样做带来一个麻烦就是，ao中的渲染接口针对的mxd。地图服务就不能使用ao的carto库中的接口进行渲染，避免使用的mxd的相关的crato接口imap,Ilaye，ifeaturelayer，和页面布局等相关的接口。

 tips：在10.1MapServer通过msd发布，不像以前的版本可以获取整个地图文档，而现在只能获取图层，如果你对获取的图层进行了更改，并不会对mapserver本身发生更改。