深入Atlas系列之服務(wù)器端支持（下）

2019-11-17 04:51:50

字體：大中小

供稿：網(wǎng)友

　　在上一篇文章里，我們分析了一部分服務(wù)器端的代碼。到現(xiàn)在為止，我們已經(jīng)獲得處理Web Services方法請(qǐng)求的Handler，馬上就要開(kāi)始PRocess Request了。

　　我們知道，處理Web Services方法請(qǐng)求的Handler是RestHandler，所以我們來(lái)看一下它的ProcessHandler方法：

　　ProcessRequest獲得調(diào)用結(jié)果代碼分析：

1 public void ProcessRequest(HttpContext context)
2 {
3 // 根據(jù)Web Services的Cache設(shè)置來(lái)配置Cache策略
4 this.InitializeCachePolicy(context);
5
6 try
7 {
8 string contentType;
9
10 // 從body的JSON字符串中得到輸入的參數(shù)。
11 IDictionary＜string, object＞ inputParams = this.GetRawParams(context);
12
13 // this._webServiceMethodData.Ower.Type即獲得了即將調(diào)用的那個(gè)
14 // Web Service類(lèi)，通過(guò)Activator.CreateInstance方法構(gòu)造實(shí)例。
15 object serviceObj = Activator.CreateInstance(this._webServiceMethodData.Owner.Type);
16
17 // 這是一段很有技巧的代碼，我們目前不去分析它。
18 DataService service = serviceObj as DataService;
19 if (service != null)
20 {
21 service.IsCalledRemotely = true;
22 }
23
24 // Call這個(gè)Web Service方法來(lái)得到結(jié)果
25 object resultObj = this._webServiceMethodData.CallMethodFromRawParams(serviceObj, inputParams);
26
27 ……
28 }
29 catch (Exception e)
30 {
31 ……
32 }
33 }
　　首先調(diào)用InitializeCachePolicy方法來(lái)處理緩存策略，代碼很短也很簡(jiǎn)單，因此不多解釋了。其次查看serviceObj是否是DataService類(lèi)型，假如是的話則將IsCalledRemotely設(shè)為ture，這是比較有技巧的做法，我們目前不去分析它。接著通過(guò)GetRawParams方法方法獲得以Dictionary方式存放的參數(shù)，我們需要看一下它的框架，可以了解它獲得參數(shù)的方法。

　　GetRawParams(HttpContext) ：

1 private IDictionary＜string, object＞ GetRawParams(HttpContext context)
2 {
3 // 假如是Cross Domain access，則拋出異常
4 if (!this._webServiceMethodData.SafeForCrossDomain && ChildRequest.IsCrossDomainRequest(context))
5 {
6 throw new InvalidOperationException(
7 string.Format(
8 CultureInfo.CurrentCulture,
9 AtlasWeb.InvalidCrossDomainRequest,
10 new object[] { this._webServiceMethodData.MethodInfo.Name }));
11 }
12
13 // 假如使用HTTP POST方法
14 if (context.Request.HttpMethod == "POST")
15 {
16 // 則通過(guò)Body中的JSON代碼獲得參數(shù)
17 return this.GetRawParamsFromPostRequest(context);
18 }
19
20 // 由于使用了HTTP GET方法，需要看一下Web Services方法是否答應(yīng)GET操作
21 if (!this._webServiceMethodData.GetVerbEnabled)
22 {
23 throw new InvalidOperationException(
24 string.Format(
25 CultureInfo.CurrentCulture,
26 AtlasWeb.InvalidGetRequest,
27 new object[] { this._webServiceMethodData.MethodInfo.Name }));
28 }
29
30 // 從Query String中獲得參數(shù)
31 return this.GetRawParamsFromGetRequest(context);
32 }
　　一個(gè)Web Service方法，可以使用Microsoft.Web.Services.WebOperationAttribute來(lái)標(biāo)記是否使用能夠通過(guò)GET方法訪問(wèn)。下面的代碼讓該Web Service方法答應(yīng)使用GET方法來(lái)訪問(wèn)：

　　[WebOperation(true)]

　　獲得的Dictionary數(shù)據(jù)結(jié)構(gòu)以Key - Value的方式對(duì)應(yīng)的參數(shù)名和表示參數(shù)值的字符串，假如是復(fù)雜類(lèi)型的話會(huì)產(chǎn)生許多層的Dictionary或List，大家應(yīng)該能夠想象出來(lái)它是什么樣子，因?yàn)檫@和大名鼎鼎的JSON非常相似！獲得參數(shù)之后，會(huì)將其傳入WebServiceMethodData的CallMethodFromRawParams方法，以獲得方法執(zhí)行的結(jié)果。

　　WebServiceMethodData.CallMethodFromRawParams方法代碼如下：

　　CallMethodFromRawParams方法分析

1 internal object CallMethodFromRawParams(object target, IDictionary＜string, object＞ parameters)
2 {
3 // 獲得強(qiáng)類(lèi)型的參數(shù)字典
4 parameters = this.StrongTypeParameters(parameters);
5 return this.CallMethod(target, parameters);
6 }
　　首先通過(guò)StrongTypeParameters方法來(lái)獲得一個(gè)強(qiáng)類(lèi)型的參數(shù)字典，它不會(huì)有多層的Dictionary或List。此方法非常的復(fù)雜，在這里就先不進(jìn)行分析了，有愛(ài)好的朋友可以先看一下相關(guān)代碼，我會(huì)在今后的文章中分析這些代碼的細(xì)節(jié)，它們還是寫(xiě)得非常優(yōu)秀的。得到強(qiáng)類(lèi)型的參數(shù)后，就會(huì)使用CallMethod來(lái)調(diào)用方法得到結(jié)果了。在這里面只是使用了簡(jiǎn)單的Reflection，相信大家也能夠想象得到個(gè)中實(shí)現(xiàn)。

　　接下來(lái)就要輸出結(jié)果了，代碼如下：

　　ProcessRequest輸出結(jié)果代碼分析：

1 public void ProcessRequest(HttpContext context)
2 {
3 ……
4
5 try
6 {
7 ……
8
9 // 假如這個(gè)Web Service方法被要求使用xml作為Response
10 if (this._webServiceMethodData.UseXmlResponse)
11 {
12 // 假如result是String，那么直接輸出
13 if (resultObj is string)
14 {
15 body = (string) resultObj;
16 }
17 else if (resultObj is XmlNode)
18 {
19 // 假如是一段XML，則輸出它的OuterXml
20 body = ((XmlNode) resultObj).OuterXml;
21 }
22 else // 假如只是一個(gè)普通的對(duì)象
23 {
24 try
25 {
26 // 使用XmlSerializer來(lái)序列化對(duì)象
27 body = ServicesUtilities.XmlSerializeObjectToString(resultObj);
28 }
29 catch (Exception e)
30 {
31 throw new InvalidOperationException(
32 string.Format(
33 CultureInfo.CurrentCulture,
34 AtlasWeb.InvalidXmlReturnType,
35 new object[] {
36 this._webServiceMethodData.MethodInfo.Name,
37 resultObj.GetType().FullName,
38 e.Message
39 }
40 )
41 );
42 }
43 }
44
45 // contentType為"text/xml"
46 contentType = "text/xml";
47 }
48 else // 假如不以Xml輸出
49 {
50 // 那么以JSON方式輸出
51 body = javascriptObjectSerializer.Serialize(resultObj, this._webServiceMethodData.Owner);
52 // contentType為"application/json"
53 contentType = "application/json";
54 }
55
56 // 設(shè)置ContentType
57 context.Response.ContentType = contentType;
58 // 輸出body
59 if (body != null)
60 {
61 context.Response.Write(body);
62 }
63 }
64 catch (Exception e)
65 {
66 ……
67 }
68 }
　　要設(shè)置該Web Services方法的輸出方式為XML（UseXmlResponse == true），則也是需要使用Microsoft.Web.Services.WebOperationAttribute來(lái)標(biāo)記方法，如下：

[WebOperation(false, ResponseFormatMode.Xml)]
　　后面會(huì)有一個(gè)例子來(lái)演示這一點(diǎn)。假如該方法被標(biāo)記使用XML方式輸出，則會(huì)判定結(jié)果類(lèi)型。假如是字符串則直接輸出；假如是Xml類(lèi)型的結(jié)果，則輸出它的OuterXml；最后則會(huì)嘗試使用XmlSerializer來(lái)序列化這個(gè)對(duì)象。

　　在默認(rèn)情況下，該對(duì)象會(huì)被JSON序列化輸出，這就是我們最常見(jiàn)的做法。

　　最后，對(duì)于異常情況，也需要進(jìn)行輸出。代碼如下：

　　ProcessRequest輸出異常代碼分析：

1 public void ProcessRequest(HttpContext context)
2 {
3 ……
4
5 try
6 {
7 ……
8 }
9 catch (Exception e)
10 {
11 // 輸出異常信息
12 context.Response.ClearHeaders();
13 context.Response.Clear();
14 // Status Code設(shè)為500
15 context.Response.StatusCode = 500;
16 context.Response.StatusDescription = HttpWorkerRequest.GetStatusDescription(500);
17 using (StreamWriter writer = new StreamWriter(context.Response.OutputStream, new UTF8Encoding(false)))
18 {
19 // 以JSON方式輸出異常信息
20 RestHandler.WriteExceptionJsonString(context, writer, e);
21 return;
22 }
23 }
24 }
　　代碼使用RestHandler.WriteExceptionJsonString來(lái)分別輸出異常的Message，StackTrace和異常的FullName。在代碼里可以使用這一點(diǎn)。

　　到現(xiàn)在為止，可以說(shuō)Atlas在服務(wù)器端對(duì)于Web Services的支持代碼已經(jīng)分析完了。我們通過(guò)兩個(gè)實(shí)例來(lái)具體理解這一點(diǎn)。
QQRead.com 推出數(shù)據(jù)恢復(fù)指南教程數(shù)據(jù)恢復(fù)指南教程數(shù)據(jù)恢復(fù)故障解析常用數(shù)據(jù)恢復(fù)方案硬盤(pán)數(shù)據(jù)恢復(fù)教程數(shù)據(jù)保護(hù)方法數(shù)據(jù)恢復(fù)軟件專(zhuān)業(yè)數(shù)據(jù)恢復(fù)服務(wù)指南
　　范例1：在Web Services方法中使用復(fù)雜的數(shù)據(jù)類(lèi)型。

　　首先，我們定義兩個(gè)表示數(shù)據(jù)的類(lèi)，Employee和Company。代碼如下：

　　Employee與Company代碼：

1 [Serializable]
2 public class Employee : IComparable＜Employee＞
3 {
4 public string Name;
5
6 public int Age;
7
8 #region IComparable＜Employee＞ Members
9
10 public int CompareTo(Employee other)
11 {
12 return this.Name.CompareTo(other.Name);
13 }
14
15 #endregion
16 }
17
18 [Serializable]
19 public class Company
20 {
21 public string Name;
22
23 public Employee[] Employees;
24 }
　　接著我們定義一個(gè)Web Services方法Sort，該方法的作用是拿到公司姓名和一個(gè)Employee數(shù)組作為參數(shù)，將Employee按照姓名排序之后，再組成一個(gè)Company對(duì)象輸出。代碼如下：

　　Sort方法

1 [WebService(Namespace = "http://tempuri.org/")]
2 [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
3 public class ComplexTypeWS : System.Web.Services.WebService {
4
5 [WebMethod]
6 public Company Sort(string companyName, Employee[] employees)
7 {
8 Array.Sort＜Employee＞(employees);
9
10 Company company = new Company();
11 company.Name = companyName;
12 company.Employees = employees;
13 return company;
14 }
15 }
　　然后就是Html了。在頁(yè)面最上方（id為employees的div）會(huì)顯示內(nèi)存中目前所有的Employee，之后是向內(nèi)存中添加Employee的輸入框，接著是填寫(xiě)公司名的文本框和排序按鈕，最后則是經(jīng)過(guò)了Web Services排序后的結(jié)果顯示區(qū)域（id為sortedDisplay的div）：

　　HTML代碼：

1 ＜body style="font-family:Verdana; font-size: 14px;"＞
2 ＜form id="form1" runat="server"＞
3 ＜atlas:ScriptManager runat="server" ID="ScriptManager1" /＞
4
5 ＜div＞Employees:＜/div＞
6 ＜div id="employees"＞＜/div＞
7 ＜hr /＞
8 ＜div＞Add Employee:＜/div＞
9 ＜div＞Name: ＜input type="text" id="empName" /＞＜/div＞
10 ＜div＞Age: ＜input type="text" id="empAge" /＞＜/div＞
11 ＜input type="button" value="Add employee" onclick="addEmployee()" /＞＜br /＞
12 ＜hr /＞
13 ＜div＞Company Name:＜input type="text" id="companyName" /＞＜/div＞
14 ＜input type="button" value="Sort!" onclick="sort()" /＞＜br /＞
15 ＜hr /＞
16 ＜div id="sortedDisplay"＞＜/div＞
17 ＜/form＞
18 ＜/body＞
　　最后我們來(lái)看Javascript代碼：

　　Javascript代碼：

1 ＜script language="javascript"＞
2 // 內(nèi)存中的Employee數(shù)組
3 var empArray = new Array();
4
5 // 添加一個(gè)Employee
6 function addEmployee()
7 {
8 // 建立一個(gè)對(duì)象表示Employee
9 var emp = new Object();
10 emp.Name = $('empName').value;
11 emp.Age = parseInt($("empAge").value, 10);
12
13 // 加入數(shù)組
14 empArray.push(emp);
15
16 // 更新最上方的顯示
17 updateSource();
18 }
19
20 // 將內(nèi)存中的empArray數(shù)組顯示在id為employee的div中
21 function updateSource()
22 {
23 var html = "";
24
25 for (var i = 0; i ＜ empArray.length; i++)
26 {
27 var emp = empArray[i];
28 html += ((i + 1) + ". " + emp.Name + ", " + emp.Age + " years old.＜br /＞")
29 }
30
31 $("employees").innerHTML = html;
32 }
33
34 // 訪問(wèn)Web Service進(jìn)行排序
35 function sort()
36 {
37 // 構(gòu)造參數(shù)
38 var params = { "companyName" : $("companyName").value, "employees" : empArray };
39 // 構(gòu)造Web Service方法訪問(wèn)對(duì)象
40 var method = new Sys.Net.ServiceMethod("ComplexTypeWS.asmx", "Sort", null);
41
42 // 調(diào)用Web Service方法
43 method.invoke(params, onMethodComplete);
44 }
45
46 // 回調(diào)函數(shù)
47 function onMethodComplete(company, response, userContext)
48 {
49 // 在id為sortedDisplay的div中顯示所有的Employee，
50 // 可以發(fā)現(xiàn)company對(duì)象和服務(wù)器端對(duì)象的結(jié)構(gòu)相同
51 var html = "Company Name: " + company.Name;
52 for (var i = 0; i ＜ company.Employees.length; i++)
53 {
54 var emp = company.Employees[i];
55 html += ("＜br /＞" + (i + 1) + ". " + emp.Name + ", " + emp.Age + " years old.")
56 }
57
58 $("sortedDisplay").innerHTML = html;
59
60 // 清空內(nèi)存中的Employee
61 empArray.length = 0;
62 // 更新最上方的顯示
63 updateSource();
64 }
65 ＜/script＞
　　所有的代碼都在這里，我們來(lái)看一下使用。首先打開(kāi)頁(yè)面，輸入數(shù)個(gè)Employee，如圖：

　　然后點(diǎn)擊填寫(xiě)好Company Name并點(diǎn)擊Sort按鈕，則可以看出按照姓名排序后的結(jié)果：

　　我們使用Fiddler查看一下數(shù)據(jù)傳輸，可以看到Request Body和Response Body里的JSON代碼：

點(diǎn)擊查看大圖

　　可以看出，Atlas使用了JSON方式傳遞數(shù)據(jù)非常的直觀，對(duì)于復(fù)雜的類(lèi)型支持也非常好。在客戶端得到的對(duì)象，其結(jié)構(gòu)和服務(wù)器端相同，這對(duì)于開(kāi)發(fā)人員帶來(lái)了不小的便利。 QQRead.com 推出數(shù)據(jù)恢復(fù)指南教程數(shù)據(jù)恢復(fù)指南教程數(shù)據(jù)恢復(fù)故障解析常用數(shù)據(jù)恢復(fù)方案硬盤(pán)數(shù)據(jù)恢復(fù)教程數(shù)據(jù)保護(hù)方法數(shù)據(jù)恢復(fù)軟件專(zhuān)業(yè)數(shù)據(jù)恢復(fù)服務(wù)指南
　　范例2：使用Web Services將對(duì)象序列化成XML并使用客戶端XSLTView空間輸出信息

　　使用了與上例相同的Employee和Company兩個(gè)類(lèi)，在這里就不重復(fù)了，先來(lái)看一下Web Service方法GetXmlSerializedCompany的代碼：

　　GetXmlSerializedCompany方法代碼：

1 [WebService(Namespace = "http://tempuri.org/")]
2 [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
3 public class ComplexTypeWS : System.Web.Services.WebService {
4
5 [WebMethod]
6 [WebOperation(false, ResponseFormatMode.Xml)]
7 public Company GetXmlSerializedCompany(Company company)
8 {
9 return company;
10 }
11 }
　　這個(gè)方法簡(jiǎn)單地令人驚奇，只是直接將參數(shù)返回。其精妙之處就是使用了Microsoft.Web.Services.WebOperationAttribute進(jìn)行標(biāo)記，表明了該方法將以XML形式輸出。

　　接下來(lái)是HTML，與上例非常的相似，就不多作解釋了。代碼如下：

　　HTML代碼：

1 ＜atlas:ScriptManager ID="ScriptManager1" runat="server" /＞
2
3 ＜form id="form1" runat="server"＞
4
5 ＜div＞Employees:＜/div＞
6 ＜div id="employees"＞＜/div＞
7 ＜hr /＞
8 ＜div＞Add Employee:＜/div＞
9 ＜div＞Name: ＜input type="text" id="empName" /＞＜/div＞
10 ＜div＞Age: ＜input type="text" id="empAge" /＞＜/div＞
11 ＜input type="button" value="Add employee" onclick="addEmployee()" /＞＜br /＞
12 ＜hr /＞
13 ＜div＞Company Name:＜input type="text" id="companyName" /＞＜/div＞
14 ＜input type="button" value="Serialize!" onclick="serialize()" /＞＜br /＞
15 ＜hr /＞
16 ＜div id="xmlDisplay"＞＜/div＞
17
18 ＜/form＞
　　然后預(yù)備一下Atlas Xml Script，聲明一個(gè)XmlDataSource，用來(lái)獲得XSLT文件。再添加一個(gè)XSLTView，將其transform屬性與XmlDataSource的document屬性綁定起來(lái)。代碼如下：

　　Atlas Xml Script代碼：

1 ＜script type="text/xml-script"＞
2 ＜page＞
3 ＜components＞
4 ＜xmlDataSource id="xsltSource" autoLoad="true" serviceURL="Company.xsl" /＞
5 ＜xsltView id="xmlDisplay"＞
6 ＜bindings＞
7 ＜binding property="transform" dataContext="xsltSource" dataPath="document" /＞
8 ＜/bindings＞
9 ＜/xsltView＞
10 ＜/components＞
11 ＜/page＞
12 ＜/script＞
　　順便給出Company.xsl文件代碼：

　　Company.xsl：

1 ＜?xml version="1.0" encoding="utf-8"?＞
2 ＜xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"＞
3 ＜xsl:template match="/Company"＞
4 ＜div＞
5 Company:
6 ＜xsl:value-of select="Name" /＞
7 ＜/div＞
8 ＜xsl:for-each select="Employees/Employee"＞
9 ＜div＞
10 ＜xsl:value-of select="Name" /＞
11 ＜xsl:text＞, ＜/xsl:text＞
12 ＜xsl:value-of select="Age" /＞
13 ＜xsl:text＞ years old.＜/xsl:text＞
14 ＜/div＞
15 ＜/xsl:for-each＞
16 ＜/xsl:template＞
17 ＜/xsl:stylesheet＞
　　然后是Javascript代碼，大部分與上例相同，只作了少量注釋?zhuān)?br />
　　Javascript代碼：

1 ＜script language="javascript"＞
2 var empArray = new Array();
3
4 function addEmployee()
5 {
6 var emp = new Object();
7 emp.Name = $('empName').value;
8 emp.Age = parseInt($("empAge").value, 10);
9
10 empArray.push(emp);
11 updateSource();
12 }
13
14 function updateSource()
15 {
16 var html = "";
17
18 for (var i = 0; i ＜ empArray.length; i++)
19 {
20 var emp = empArray[i];
21 html += ((i + 1) + ". " + emp.Name + ", " + emp.Age + " years old.＜br /＞")
22 }
23
24 $("employees").innerHTML = html;
25 }
26
27 function serialize()
28 {
29 // 構(gòu)造一個(gè)Company對(duì)象作為參數(shù)，
30 // 結(jié)構(gòu)和服務(wù)器端對(duì)象相同。
31 var company = new Object();
32 company.Name = $("companyName").value;
33 company.Employees = empArray;
34
35 var params = { "company" : company }
36 var method = new Sys.Net.ServiceMethod("ComplexTypeWS.asmx", "GetXmlSerializedCompany", null);
37
38 method.invoke(params, onMethodComplete);
39 }
40
41 function onMethodComplete(resultXml, response, userContext)
42 {
43 // 這時(shí)第一個(gè)參數(shù)是一個(gè)Xml，
44 // 用它來(lái)設(shè)置XSLTView的document屬性。
45 $("xmlDisplay").control.set_document(resultXml);
46
47 empArray.length = 0;
48 updateSource();
49 }
50 ＜/script＞
　　代碼就是這些，接下來(lái)看一下使用。首先依舊是添加數(shù)個(gè)Employee：

　　填寫(xiě)Company Name并點(diǎn)擊“Serialize!”按鈕，可以看到下方的XSLT輸出：

　　使用Fiddler查看的Request Body和Response Body的信息：

點(diǎn)擊查看大圖

　　正如我們所期望的那樣，Response Body里的信息是Company對(duì)象被Xml序列化之后的結(jié)果，然后使用XSLT轉(zhuǎn)換后即得到了我們需要的信息！

　　通過(guò)了上面兩個(gè)例子，我們可以看出Atlas對(duì)于Web Services的支持是非常靈活的。具體的使用方式讓開(kāi)發(fā)人員有很大的發(fā)揮空間，開(kāi)發(fā)人員完全可以選擇合適的方式把Atlas靈活運(yùn)用在自己的項(xiàng)目中。

　　當(dāng)然，Atlas對(duì)于Web Services的支持還遠(yuǎn)不止這些，在以后的文章里我會(huì)繼續(xù)從實(shí)現(xiàn)角度對(duì)Atlas的Web Services進(jìn)行分析，并提供更多的范例給大家參考。希望大家支持我的“深入Atlas系列”，謝謝大家。

上一篇：項(xiàng)目開(kāi)發(fā)計(jì)劃

下一篇：跳出程序員的視界感悟軟件測(cè)試