解析Atlas客户端支持(1)

Atlas提供了强大而灵活的服务器端Web Services访问能力。这对于客户端AJAX开发提供了绝好的条件，这几乎也是任何AJAX框架必备的功能。因为只要有了它，就能轻松地以AJAX方式与服务器端进行交互，而其他多样的页面操作自然可以由开发人员尽情开发。对于部分喜欢自己动手的开发人员来说，这甚至是他们仅仅需要的支持。

从这篇文章开始，我会从实现角度剖析Atlas对于Web Services的支持，希望能够帮助大家更深入地理解，更灵活地使用Atlas提供的这一功能。

在Atlas中，对于Web Services的访问，其实都是通过Sys.Net.ServiceMethod类来实现的。我们先通过UML来看一下Sys.Net.ServiceMethod以及其其他一些类的关系。

Sys.Net.WebMethod类是Sys.Net.ServiceMethod和Sys.Net.PageMethod的父类。后者用于访问写于页面中使用WebMethodAttribute标注的方法，不在这篇文章的讨论范围内。Sys.Net.WebMethod内定义了五个抽象函数:get_methodName、addHeaders、get_url、get_body和get_appUrl，其作用应该相当地显而易见。而继承Sys.Net.WebMethod的类，例如Sys.Net.ServiceMethod，则提供了这五个抽象函数的实现。

Sys.Net.WebMethod类有一个非常有趣的函数“invoke”。从UML图中会发现，它居然提供了一个Javascript中没有的功能:“函数重载(overload)”!至于它是如何实现，该如何使用，稍后将结合代码进行详细介绍。

那么就进入代码分析阶段，先从Sys.Net.WebMethod的结构看起，从一个Atlas类的大致结构可以看出该类的成员定义和“构造函数”的实现。

Sys.Net.WebMethod结构:

1 Sys.Net.WebMethod = function() { 2 　//抽象成员定义 3 　this.addHeaders = Function.abstractMethod; 4 　this.get_appUrl = Function.abstractMethod; 5 　this.get_url = Function.abstractMethod; 6 　this.get_body = Function.abstractMethod; 7 8 　//最后这个定义是我补上的，很明显代码里缺少了这个定义 9 　this.get_methodName = Function.abstractMethod; 10 11 　this.invoke = function(params) { 12 …… 13 　} 14 15 　this._invoke = function(params, onMethodComplete, onMethodTimeout, 16 onMethodError, onMethodAborted, userContext, timeoutInterval, priority, useGetMethod) { 17 18 …… 19 20 function onComplete(response, eventArgs) { 21 　…… 22 } 23 24 function onTimeout(request, eventArgs) { 25 　…… 26 } 27 28 function onAborted(request, eventArgs) { 29 　…… 30 } 31 32 …… 33 　} 34 } 35 Sys.Net.WebMethod.registerAbstractClass('Sys.Net.WebMethod');

可以见到五个抽象函数定义，在this._invoke函数是真正产生请求的地方，里面还有数个用于引发事件的方法。整个类的结构非常简单。

接下来我们来仔细分析一下this.invoke函数。

this.invoke函数分析

1 // 参数params是一个Dictionary，用key - value的方式 2 // 保存即将传递给Web Services的参数 3 this.invoke = function(params) { 4 　var numOfParams = arguments.length; 5 6 　// 如果有两个参数，并且第二个参数不是一个函数， 7 　// 则说明函数调用时参数是这样的： 8 　// this.invoke(params, settings); 9 　if (numOfParams == 2 && arguments[1] && typeof(arguments[1]) != 'function') { 10 11 　// 构造一个数组，用于获得每个key的index 12 　var expectedParamNames = 13 ["onMethodComplete", "onMethodTimeout", "onMethodError", 14 "onMethodAborted", "userContext", "timeoutInterval", 15 "priority", "useGetMethod"]; 16 17 　// 传入的第二个参数settings 18 　var paramContainer = arguments[1]; 19 20 　// 将要传递给this._invoke函数的参数数组 21 　var newParams = new Array(expectedParamNames.length + 1); 22 　// 第一个参数就是params 23 　newParams[0] = params; 24 25 　// 枚举settings的每个key 26 　for (var paramName in paramContainer) { 27 // 由于传递给this._invoke时参数需要按照顺序顺序， 28 // 所以必须获得当前key的index。 29 var index = expectedParamNames.indexOf(paramName); 30 31 // 如果setting里有个key是不需要的，那么抛出Error 32 if (index ＜ 0) { 33 　throw Error.createError( 34 String.format( 35 　"'{0}' is not a valid argument. It should be one of {1}", 36 　paramName, expectedParamNames 37 ) 38 　); 39 } 40 41 // 将参数放在数组合适的位置上 42 newParams[index + 1] = paramContainer[paramName]; 43 　} 44 45 　// 将准备好的参数数组传递给this._invoke调用 46 　return this._invoke.apply(this, newParams); 47 } 48 49 // 还有一种调用方式的参数和this_invoke的参数完全相同 50 return this._invoke.apply(this, arguments); 51 }

可以看到，这就是就是this.invoke“函数重载(overload)”的实现方式。到底是故意如此设计还是在后续开发时为了兼容，可能就不得而知了。不过也就是说，我们现在有中参数传递可以使用。