ArcGIS Server9.3 AJAX系列(二)Client CallBack解决方案

       之前的文章有提到ArcGIS Server93提供了两种AJAX模式，一种是client callback模式，一种是partial postback模式。本篇将主要介绍ArcGIS Server的script. callback解决方案，对应client callback模式。

       Client Callback模式，我们称之为客户端回调。使用这种AJAX模式时，处理客户端请求的服务器控件必须实现ICallbackEventHandler接口。该接口提供了两个方法，GetCallbackResult和RaiseCallbackEvent。通过这两个方法所实现的功能主要是：从客户端接收一个数据参数，在服务器端获取这个参数，并执行一个实现所需功能的事件，最后返回客户端所需结果数据。通俗点说，RaiseCallbackEvent就是接收客户端的指令，然后对其进行处理，最后通过GetcallbackResult返回给客户端。这就是客户端回调的机理。

       另外有几点需要特别说明。一，客户端在请求时实际上调用了WebForm_DoCallback函数，这个函数被包含在ASP.NET System.Web.dll中，是ASP.NET为实现客户端回调提供的一个底层函数，它封装了一些AJAX实现的细节，可以方便开发人员实现快速开发。二，任何服务器端控件，只要实现了ICallbackEventHandler接口都可以实现对客户端请求的相应，并返回客户端，Page也是一种服务器控件，它也实现了这一接口。所有的Web ADF控件其实也都实现了这一接口，因此很多情况下我们不需要明确的对ADF控件的内容进行更新，因为它可以自动更新。

       下面来看看客户端回调使用的几种情景：

       (一)仅由Web ADF控件处理客户端请求

       这种情景的流程如下图所示，服务器端的Web ADF控件处理客户端发来的请求，生成一个或多个CallBackResults，以序列化的JSON字符串传回客户端，交由客户端Web ADF JavaScript的函数processCallbackResult处理。这个函数位于aspnet_client文件夹下的ESRI.ADF.System.debug.js文件中，是Web ADF JavaScript库用来解析JSON字符串，修改客户端内容的函数。

       这种方案其实经常出现在自定义ToolBarItem实现一些功能的情境下。由于所有的Web ADF控件都实现了ICallbackEventHandler接口，也就意味着这些控件实现了GetCallbackResult和RaiseCallbackEvent方法。当通过Toolbar与Map进行交互时，会自动调用Map的以上两种方法，实现地图的自动刷新。如下图所示：

       NOTE：这张图是EDN的解释图，但是这张图是92版本的，93版本的processCallbackResult函数位于aspnet_client文件夹下的ESRI.ADF.System.debug.js文件中。

       另外，有时候也需要更新页面上其他非ADF控件的内容，这可以通过定制CallbackResult实现。

       (二)由非Web ADF控件处理客户端请求，Web ADF JavaScript处理服务器响应

       下面这两张图描述了和第一种情形类似的过程，只不过将客户端的Web ADF换成了页面上的其他非Web ADF控件。这直接导致服务器端处理客户端请求的控件由Map变成了Page。

       这张情况使用的范围更广，因为不可能所有的功能都放到Toolbar上去实现。

       (三)由非Web ADF控件处理客户端请求，在客户端自定义JavaScript函数处理服务器响应

       这也是三种情景中最难的一种情况，因为所有的服务器逻辑以及客户端的相应代码都需要设计人员自己定制。下面这段代码中的 customFunction就是我们需要在客户端自己定义的相应函数，它负责处理服务器发来的原始callback字符串。要知道如何解析callback字符串，就必须知道其构造模式，之前提到的processCallbackResult函数就是这样一个解析函数，我们可以参照它编写我们的定制函数。

       [C#]

       string m_ADFCallbackFunctionString =

       Page.ClientScript.GetCallbackEventReference(this, "message", "customFunction", "context", "handleError", true);

       总结：

       总体上说来，第一种情景比较适合基于Toolbar的应用，第二种情景则应用很广，应该是Server开发人员用得最多的方案，第三种情景则比较适合于对Server的整个AJAX架构非常清楚，对Callback字符串解析比较了解，并且希望可以定制一些Server所不具有功能的高级开发人员所用。