ASP.NET创建Web服务之设计方针

简介:

使用ASP.NET构造一个简单的XMLWeb服务是相对容易的,然而,XMLWeb服务的真正的强大的功能只有等你研究了基础结构以后才能领悟。XMLWeb服务是建立在.NET框架和公共语言运行时间基础上的。一个XMLWeb服务可以利用这些技术。例如,ASP.NET支持的性能、状态管理和验证全都可被用来构造XMLWeb服务。

XMLWeb服务的基础结构是构建来符合象SOAP、XML和WSDL这样的行业标准,并且它允许其他的平台的客户端与XMLWeb服务互操作。只要一个客户端可以发送符合标准的SOAP消息、依据格式化的服务描述,那么这个客户端可以调用一个使用ASP.NET创建的XMLWeb服务(不管客户端存在于何种平台)。

当你使用ASP.NET构造一个XMLWeb服务时,它自动支持客户端使用SOAP、HTTP-GET和HTTP-POST协议通讯。即使HTTP-GET和HTTP-POST支持使用URL编码的变量名/变量值对来传送消息,支持这两个协议的数据类型也没有支持SOAP协议的数据类型丰富。在SOAP中,使用XML把数据传送到XMLWeb服务或从XMLWeb服务取回消息,你可以使用支持丰富的数据类型集的XSD模式定义复杂的数据类型。使用ASP.NET构造一个XMLWeb服务的开发者不必明确地定义复杂的数据类型。他们可以只构造一个管理类。ASP.NET处理定义到一个XSD模式的映射类和到XML数据的映射对象实例,以便通过网络传输。

重要的是要注意XMLWeb服务并不能取代DCOM,我们应该说XMLWeb服务是跨越使用行业标准的平台通信的一种消息传递基础结构。

因为ASP.NET提供了为XMLWeb服务内部工作的基础结构,开发者可以集中精力来实现他们的特定的XMLWeb服务的功能。使用ASP.NET开发一个XMLWeb服务从下面三步开始:

1.创建一个带有.asmx扩展名的文件。

2.在这个文件里面,使用一条指令声明XMLWeb服务。

3.定义组成XMLWeb服务功能的XMLWeb服务方法。

XMLWeb服务是一个强大的技术,用于提供可通过因特网变成访问的服务。下面的建议将帮助你创建高效的XMLWeb服务:

XMLWeb服务既支持同步的又支持异步的客户端和存放XMLWeb服务的服务器之间的通信。在同步通信情况下,客户端发送一个对服务的请求到服务主机服务器上等待响应。这防止客户端在等待结果的时候,执行其它的操作。然而异步通信导致客户端在等待相应的时候继续处理其它的任务。客户端在可用的时候响应服务请求的结果。

当你使用Web服务描述语言工具(Wsdl.exe)来创建你的代理类的时候,它产生类中的方法的标准的、同步版本和异步版本。异步版本由两个方法组成,称为Begin和End。Begin方法用于初始化XMLWeb服务,而End方法取得结果。

使用异步通信能够改善系统使用率和避免客户端在它等待XMLWeb服务结果的时候的延迟。

下面的代码示例显示如何从一个客户应用程序产生一个到XMLWeb服务的异步调用。

[C#]


<%@PageLanguage="C#"%>
<%@ImportNamespace="System.Net"%>
<html>
<scriptlanguage="C#"runat="server">
voidEnterBtn_Click(ObjectSrc,EventArgsE)
{
MyMath.Mathmath=newMyMath.Math();
//CalltoAddXMLWebservicemethodasynchronously
//andthenwaitforittocomplete.
IAsyncResultresult=
math.BeginAdd(Convert.ToInt32(Num1.Text),
Convert.ToInt32(Num2.Text),
null,
null);
//Waitforasynchronouscalltocomplete.
result.AsyncWaitHandle.WaitOne();
//CompletetheasynchronouscalltoAddXMLWebservicemethod.
floattotal=math.EndAdd(result);
//DisplayresultsinaLabelcontrol.
Total.Text="Total:"+total.ToString();
}
</script>
<body>
<formaction="MathClient.aspx"runat=server>
<fontface="Verdana">
Enterthetwonumbersyouwanttoaddandthenpress
theTotalbutton.
<p>
Number1:
<asp:textboxid="Num1"
runat=server/>
+
Number2:
<asp:textboxid="Num2"
runat=server/>
=
<asp:buttonid="Total_Button"
text="Total"
OnClick="EnterBtn_Click"
runat=server/>
<p>
<asp:labelid="Total"runat=server/>
</font>
</form>
</body>
</html>
[VisualBasic]
<%@PageLanguage="VB"%>
<%@ImportNamespace="System.Net"%>
<html>
<scriptlanguage="VB"runat="server">
SubEnterBtn_Click(SrcAsObject,EAsEventArgs)
DimmathAsNewMyMath.Math()
'CalltoAddXMLWebservicemethodasynchronously
'andthenwaitforittocomplete.
DimresultAsIAsyncResult=_
math.BeginAdd(Convert.ToInt32(Num1.Text),_
Convert.ToInt32(Num2.Text),_
Nothing,_
Nothing)

'Waitforasynchronouscalltocomplete.
result.AsyncWaitHandle.WaitOne()
'CompletetheasynchronouscalltoAddXMLWebservicemethod.
DimaddtotalAsSingle=math.EndAdd(result)
'DisplayresultsinaLabelcontrol.
Total.Text="Total:"&addtotal.ToString()
EndSub
</script>
<body>
<formaction="MathClient.aspx"runat=server>
<fontface="Verdana">
Enterthetwonumbersyouwanttoaddandthenpress
theTotalbutton.
<p>
Number1:
<asp:textboxid="Num1"
runat=server/>
+
Number2:
<asp:textboxid="Num2"
runat=server/>
=
<asp:buttonid="Total_Button"
text="Total"
OnClick="EnterBtn_Click"
runat=server/>
<p>
<asp:labelid="Total"runat=server/>
</font>
</form>
</body>
</html>

想获得更多关于异步通信的信息,请参阅后面的"和XMLWeb服务异步地通讯"。
通过因特网产生许多服务请求可能影响客户应用程序的性能。当设计你的XMLWeb服务时,通过创建把有关信息集中在一起的方法可以有效利用服务请求。例如,假定你有一个XMLWeb服务,用来检索一本书的信息。我们可以创建一个在一条服务请求中返回所有的信息的方法,来代替单独的检索书名、作者和出版社的方法。一次传送大块的信息比多次传送小块的信息更有效率。

下面的代码示例解释如何把有关信息组织到单个XMLWeb服务方法中。

[C#]


<%@WebServiceLanguage="C#"Class="DataService"%>
usingSystem;
usingSystem.Data;
usingSystem.Data.SqlClient;
usingSystem.Web.Services;
publicclassDataService{
[WebMethod]
publicDataSetGetTitleAuthors(){
SqlConnectionmyConnection=newSqlConnection("PersistSecurityInfo=False;IntegratedSecurity=SSPI;server=localhost;database=pubs");
SqlDataAdaptermyCommand1=newSqlDataAdapter("select*fromAuthors",myConnection);
SqlDataAdaptermyCommand2=newSqlDataAdapter("select*fromTitles",myConnection);
DataSetds=newDataSet();
myCommand1.Fill(ds,"Authors");
myCommand2.Fill(ds,"Titles");
returnds;
}
}

[VisualBasic]



<%@WebServiceLanguage="VB"Class="DataService"%>
ImportsSystem
ImportsSystem.Data
ImportsSystem.Data.SqlClient
ImportsSystem.Web.Services
PublicClassDataService
<WebMethod>_
PublicFunctionGetTitleAuthors()AsDataSet
DimmyConnectionAsNewSqlConnection("PersistSecurityInfo=False;IntegratedSecurity=SSPI;server=localhost;database=pubs")
DimmyCommand1AsNewSqlDataAdapter("select*fromAuthors",myConnection)
DimmyCommand2AsNewSqlDataAdapter("select*fromTitles",myConnection)
DimdsAsNewDataSet()
myCommand1.Fill(ds,"Authors")
myCommand2.Fill(ds,"Titles")
Returnds
EndFunction
EndClass

当设计你的XMLWeb服务时,请确保使用标准的面向对象编程操作。使用封装来隐藏实现细节。对于更复杂的XMLWeb服务,你可以使用继承和多态性来再次使用代码并简化你的设计。

下面的代码示例显示如何使用继承来创建一个执行数学计算的XMLWeb服务。

[C#]


<%@WebServiceLanguage="C#"Class="Add"%>
usingSystem;
usingSystem.Web.Services;
abstractpublicclassMathService:WebService
{
 [WebMethod]
 abstractpublicfloatCalculateTotal(floata,floatb);
}
publicclassAdd:MathService
{
 [WebMethod]
 overridepublicfloatCalculateTotal(floata,floatb)
 {
returna+b;
 }
}
publicclassSubtract:MathService
{
 [WebMethod]
 overridepublicfloatCalculateTotal(floata,floatb)
 {
returna-b;
 }
}
publicclassMultiply:MathService
{
 [WebMethod]
 overridepublicfloatCalculateTotal(floata,floatb)
 {
returna*b;
 }
}
publicclassDivide:MathService
{
 [WebMethod]
 overridepublicfloatCalculateTotal(floata,floatb)
 {
if(b==0)
 return-1;
else
 returna/b;
 }
}

[VisualBasic]


<%@WebServiceLanguage="VB"Class="Add"%>
ImportsSystem
ImportsSystem.Web.Services
MustInheritPublicClassMathService:InheritsWebService
<WebMethod>_
PublicMustOverrideFunctionCalculateTotal(aAsSingle,_
bAsSingle)AsSingle
EndClass
PublicClassAdd:InheritsMathService
<WebMethod>PublicOverridesFunctionCalculateTotal(aAsSingle,bAsSingle)AsSingle
Returna+b
EndFunction
EndClass
PublicClassSubtract:InheritsMathService
<WebMethod>PublicOverridesFunctionCalculateTotal(aAsSingle,bAsSingle)AsSingle
Returna-b
EndFunction
EndClass
PublicClassMultiply:InheritsMathService
<WebMethod>PublicOverridesFunctionCalculateTotal(aAsSingle,bAsSingle)AsSingle
Returna*b
EndFunction
EndClass
PublicClassDivide:InheritsMathService
<WebMethod>PublicOverridesFunctionCalculateTotal(aAsSingle,bAsSingle)AsSingle
 Ifb=0Then
Return-1
 Else
Returna/b
 EndIf
EndFunction
EndClass

使用输出缓冲来改善你的XMLWeb服务的性能。当输出缓冲开启时,服务请求的结果被保存在输出缓冲中一段指定的时间。如果一个类似的XMLWeb服务请求被产生,结果可以从缓冲中取得,而不用重新计算。这样就通过减少XMLWeb服务服务器所需的处理来改善了XMLWeb服务的反馈时间。高速缓存可在客户端和服务器两者上执行。Duration属性允许你指定高速缓冲保存XMLWeb服务输出的时间。

在客户端上使用输出高速缓冲的指令是:


<%@OutputCacheDuration="60"%>

下面的代码示例显示如何在客户应用程序上使用Duration属性来指定输出高速缓冲为60秒。

[C#]


<%@PageLanguage="C#"%>
<%@ImportNamespace="System.Net"%>
<%@OutputCacheDuration="60"VaryByParam="none"%>
<html>
<scriptlanguage="C#"runat="server">
voidEnterBtn_Click(ObjectSrc,EventArgse)
{
 MyMath.Mathmath=newMyMath.Math();
 //CalltheXMLWebservice.
 floattotal=math.Add(Convert.ToInt32(Num1.Text),
 Convert.ToInt32(Num2.Text));
 //DisplaytheresultsinaLabelcontrol.
 Total.Text="Total:"+total.ToString();
}
</script>
<body>
<formaction="MathClient.aspx"runat=server>
<fontface="Verdana">
Enterthetwonumbersyouwanttoaddandpress
theTotalbutton.
<p>
Number1:
<asp:textboxid="Num1"runat=server/>
+Number2:
<asp:textboxid="Num2"runat=server/>
=<asp:buttonid="Total_Button"text="Total"OnClick="EnterBtn_Click"runat=server/>
<p>
<asp:labelid="Total"runat=server/>
</font>
</form>
</body>
</html>

[VisualBasic]


<%@PageLanguage="VB"%>
<%@ImportNamespace="System.Net"%>
<%@OutputCacheDuration="60"VaryByParam="none"%>
<html>
<scriptlanguage="VB"runat="server">
SubEnterBtn_Click(SrcAsObject,eAsEventArgs)
 DimmathAsNewMyMath.Math()
 'CalltheXMLWebservice.
 DimaddtotalAsSingle=math.Add(Convert.ToInt32(Num1.Text),Convert.ToInt32(Num2.Text))
 'DisplaytheresultsinaLabelcontrol.
 Total.Text="Total:"&addtotal.ToString()
EndSub
</script>
<body>
<formaction="MathClient.aspx"runat=server>
<fontface="Verdana">
Enterthetwonumbersyouwanttoaddandpress
theTotalbutton.
<p>
Number1:
<asp:textboxid="Num1"runat=server/>
+
Number2:
<asp:textboxid="Num2"runat=server/>
=<asp:buttonid="Total_Button"text="Total"OnClick="EnterBtn_Click"runat=server/>
<p>
<asp:labelid="Total"runat=server/>
</font>
</form>
</body>
</html>

你还可以使用WebMethod属性类的CacheDuration属性来在服务器上允许高速缓冲。下面的代码示例显示如何在XMLWeb服务方法上使用CacheDuration属性来指定输出高速缓冲为60秒。

[C#]


<%@WebServiceLanguage="C#"Class="MathService"%>
usingSystem;
usingSystem.Web.Services;
publicclassMathService:WebService{
[WebMethod(CacheDuration=60)]
publicfloatAdd(floata,floatb)
{
returna+b;
}
[WebMethod(CacheDuration=60)]
publicfloatSubtract(floata,floatb)
{
returna-b;
}
[WebMethod(CacheDuration=60)]
publicfloatMultiply(floata,floatb)
{
returna*b;
}
[WebMethod(CacheDuration=60)]
publicfloatDivide(floata,floatb)
{
if(b==0)return-1;
returna/b;
}
}

[VisualBasic]


<%@WebServiceLanguage="VB"Class="MathService"%>
ImportsSystem
ImportsSystem.Web.Services
PublicClassMathService
InheritsWebService
<WebMethod(CacheDuration:=60)>_
PublicFunctionAdd(aAsSingle,bAsSingle)AsSingle
Returna+b
EndFunction

<WebMethod(CacheDuration:=60)>_
PublicFunctionSubtract(aAsSingle,bAsSingle)AsSingle
Returna-b
EndFunction

<WebMethod(CacheDuration:=60)>_
PublicFunctionMultiply(aAsSingle,bAsSingle)AsSingle
Returna*b
EndFunction

<WebMethod(CacheDuration:=60)>_
PublicFunctionDivide(aAsSingle,bAsSingle)AsSingle
Ifb=0Then
Return-1
EndIf
Returna/b
EndFunction
EndClass

当设计你的XMLWeb服务时,努力遵循如何格式化模式的结构。

XMLWeb服务使用SOAP作为主要的传送和序列化协议。一个SOAP消息由一个可选择的头体和消息体组成。头部分包含可以被Web服务器体系结构处理的信息。SOAP没有定义任何头。消息体部分包含由应用程序处理的信息,例如用于XMLWeb服务的参数或返回值。

提供用于你的XMLWeb服务的文档,如一个静态HTML文件,描述你的服务的操作和数据结构。还包括如何使用这个XMLWeb服务的示例。不要依靠服务描述或服务帮助页面作为你唯一的文档。

目录
相关文章
|
28天前
|
开发框架 前端开发 JavaScript
ASP.NET Web Pages - 教程
ASP.NET Web Pages 是一种用于创建动态网页的开发模式,采用HTML、CSS、JavaScript 和服务器脚本。本教程聚焦于Web Pages,介绍如何使用Razor语法结合服务器端代码与前端技术,以及利用WebMatrix工具进行开发。适合初学者入门ASP.NET。
|
1天前
|
运维 前端开发 C#
一套以用户体验出发的.NET8 Web开源框架
一套以用户体验出发的.NET8 Web开源框架
一套以用户体验出发的.NET8 Web开源框架
|
2月前
|
XML JSON 安全
Web服务是通过标准化的通信协议和数据格式
【10月更文挑战第18天】Web服务是通过标准化的通信协议和数据格式
177 69
|
28天前
|
开发框架 .NET PHP
ASP.NET Web Pages - 添加 Razor 代码
ASP.NET Web Pages 使用 Razor 标记添加服务器端代码,支持 C# 和 Visual Basic。Razor 语法简洁易学,类似于 ASP 和 PHP。例如,在网页中加入 `@DateTime.Now` 可以实时显示当前时间。
|
1月前
|
Go UED
Go Web服务中如何优雅平滑重启?
在生产环境中,服务升级时如何确保不中断当前请求并应用新代码是一个挑战。本文介绍了如何使用 Go 语言的 `endless` 包实现服务的优雅重启,确保在不停止服务的情况下完成无缝升级。通过示例代码和测试步骤,详细展示了 `endless` 包的工作原理和实际应用。
55 3
|
1月前
|
JSON Go UED
Go Web服务中如何优雅关机?
在构建 Web 服务时,优雅关机是一个关键的技术点,它确保服务关闭时所有正在处理的请求都能顺利完成。本文通过一个简单的 Go 语言示例,展示了如何使用 Gin 框架实现优雅关机。通过捕获系统信号和使用 `http.Server` 的 `Shutdown` 方法,我们可以在服务关闭前等待所有请求处理完毕,从而提升用户体验,避免数据丢失或不一致。
27 1
|
1月前
|
XML 安全 PHP
PHP与SOAP Web服务开发:基础与进阶教程
本文介绍了PHP与SOAP Web服务的基础和进阶知识,涵盖SOAP的基本概念、PHP中的SoapServer和SoapClient类的使用方法,以及服务端和客户端的开发示例。此外,还探讨了安全性、性能优化等高级主题,帮助开发者掌握更高效的Web服务开发技巧。
|
2月前
|
XML JSON 安全
定义Web服务
【10月更文挑战第18天】定义Web服务
83 12
|
1天前
|
监控 前端开发 API
一款基于 .NET MVC 框架开发、功能全面的MES系统
一款基于 .NET MVC 框架开发、功能全面的MES系统
|
3月前
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
51 7