WCF技术剖析之五：利用ASP.NET兼容模式创建支持会话（Session）的WCF服务

原文:WCF技术剖析之五：利用ASP.NET兼容模式创建支持会话（Session）的WCF服务

在《基于IIS的WCF服务寄宿（Hosting）实现揭秘》中，我们谈到在采用基于IIS（或者说基于ASP.NET）的WCF服务寄宿中，具有两种截然不同的运行模式：ASP.NET并行（Side by Side）模式和ASP.NET兼容模式。对于前者，WCF通过HttpModule实现了服务的寄宿，而对于后者，WCF的服务寄宿通过一个HttpHandler实现。只有在ASP.NET兼容模式下，我们熟悉的一些ASP.NET机制才能被我们使用，比如通过HttpContext的请求下下文；基于文件或者Url的授权；HttpModule扩展；身份模拟（Impersonation）等。

由于在ASP.NET兼容模式下，ASP.NET采用与.aspx Page完全一样的方式处理基于.svc的请求，换言之，我们就可以借助当前HttpContext的SessionState维护会话状态，进而创建一个支持会话的WCF Service。接下来，我们就通过一个简单的例子，一步步地创建这样的会话服务。本案例采用如图1所示的3层结构。 （Source Code从这里下载）

 

图1 ASP.NET兼容模式案例应用结构

 

步骤一、定义服务契约：ICalculator

案例依然沿用计算服务的例子，不过通过原来直接与传入操作数并得到运算结果的方式不同，为了体现会话状态的存在，我们将本案例的WCF服务定义成“累积计算服务”：保留上一次运算的结果，并将其作为后续运算的操作数。为此，定义了如下一个接口作为服务契约：前面4个操作代表基本的加、减、乘、除运算，计算结果通过GetResult方法获得。

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

   1: using System.ServiceModel;

   2: namespace Artech.AspCompatibleServices.Contracts
   3: {
   4:     [ServiceContract]
   5:     public interface ICalculator
   6:     {
   7:         [OperationContract]
   8:         void Add(double x);
   9:         [OperationContract]
  10:         void Subtract(double x);
  11:         [OperationContract]
  12:         void Multiply(double x);
  13:         [OperationContract]
  14:         void Divide(double x);
  15:         [OperationContract]
  16:         double GetResult();
  17:     }
  18: }

步骤二、实现服务：CalculatorService

服务的实现和.svc都定义在一个ASP.NET Web站点项目中。对于定义在 CalculatorService中的每次运算，先通过HttpContext从SessionState中取出上一次运算的结果，完成运算后再将新的运算结果保存到SessionState中。通过在CalculatorService上应用AspNetCompatibilityRequirementsAttribute实现对ASP.NET兼容模式的支持。

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

   1: using System.ServiceModel.Activation;
   2: using System.Web;
   3: using Artech.AspCompatibleServices.Contracts;
   4: [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
   5: public class CalculatorService : ICalculator
   6: {
   7:     public void Add(double x)
   8:     {
   9:         HttpContext.Current.Session["__Result"] = GetResult() + x;
  10:     }
  11:     public void Subtract(double x)
  12:     {
  13:         HttpContext.Current.Session["__Result"] = GetResult() - x;
  14:     }
  15:     public void Multiply(double x)
  16:     {
  17:         HttpContext.Current.Session["__Result"] = GetResult() * x;
  18:     }
  19:     public void Divide(double x)
  20:     {
  21:         HttpContext.Current.Session["__Result"] = GetResult() / x;
  22:     }
  23:     public double GetResult()
  24:     {
  25:         if (HttpContext.Current.Session["__Result"] == null)
  26:         {
  27:             HttpContext.Current.Session["__Result"] = 0.0;
  28:         }
  29:         return (double)HttpContext.Current.Session["__Result"];
  30:     }
  31: }

下面是CalculatorService对应的.svc的定义和Web.config。为了简洁，在<@ServiceHost%>指令中，仅仅设置一个必需属性Service。对于ASP.NET兼容模式的支持，配置<serviceHostingEnvironment aspNetCompatibilityEnabled="true"/>必不可少。

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

   1: <?xml version="1.0"?>
   2: <configuration>
   3:   <system.serviceModel>
   4:     <serviceHostingEnvironment aspNetCompatibilityEnabled="true"/>
   5:     <services>
   6:       <service name="CalculatorService">
   7:         <endpoint binding="wsHttpBinding" contract="Artech.AspCompatibleServices.Contracts.ICalculator" />
   8:       </service>
   9:     </services>
  10:   </system.serviceModel>
  11: </configuration>

步骤三、创建客户端：Client

CalculatorService的客户端应用通过一个Console应用程序模拟，其服务调用方式并无特别之处，下面是相关的代码和配置。

   1: using System;
   2: using System.ServiceModel;
   3: using Artech.AspCompatibleServices.Contracts;
   4: namespace Artech.AspCompatibleServices.Clients
   5: {
   6:     class Program
   7:     {
   8:         static void Main(string[] args)
   9:         {
  10:             using (ChannelFactory<ICalculator> channelFactory = new ChannelFactory<ICalculator>("CalculatorService"))
  11:             {
  12:                 ICalculator proxy = channelFactory.CreateChannel(); 
  13:                 Console.WriteLine("初始值为: {0}", proxy.GetResult()); proxy.Add(1); 
  14:                 Console.WriteLine("Add(3)", proxy.GetResult()); 
  15:                 Console.WriteLine("运算结果为: {0}", proxy.GetResult()); proxy.Multiply(10);
  16:                 Console.WriteLine("Multiply(10)", proxy.GetResult()); Console.WriteLine("运算结果为: {0}", proxy.GetResult()); proxy.Subtract(2); 
  17:                 Console.WriteLine("Subtract(2)", proxy.GetResult()); Console.WriteLine("运算结果为: {0}", proxy.GetResult());
  18:             } Console.Read();
  19:         }
  20:     }
  21: }

 

   1: <?xml version="1.0" encoding="utf-8" ?>
   2: <configuration>
   3:     <system.serviceModel>
   4:         <client>
   5:             <endpoint  address="http://localhost/AspCompatibleServices/CalculatorService.svc"
   6:                 binding="wsHttpBinding" contract="Artech.AspCompatibleServices.Contracts.ICalculator"
   7:                 name="CalculatorService"/>
   8:         </client>            </system.serviceModel>
   9: </configuration>

但是，但我们运行客户端的程序，输出的结果并不像我们希望的那样。从下面的结果可以看出，每次通过GetResult（）方法得到的结果都是0，也就是说，服务端并没有将运算结果保存下来。

   1: 初始值为：0
   2: Add（3）运算结果为：0
   3: Multiply（10）运算结果为：0
   4: Subtract（2）运算结果为：0

允许Cookie传递

要解释这个问题，得从Session的实现机制说起。众所周知，HTTP是无状态（Stateless）的传输协议，对服务端来说，它收到的每个HTTP请求都是全新的请求。ASP.NET会话（Session）的实现很简单，就是让每次HTTP请求携带Session的识别信息（Session ID），那么服务就可以根据此信息判断请求来自哪个客户端了。关于Session识别信息的保存，ASP.NET有两种方式：Cookie和URL，前者将其放到Cookie中，每次HTTP请求将会携带该Cookie的值，后者则将其作为请求URL的一部分。一般情况下采用基于Cookie的实现机制，如果Cookie禁用则采用后者。

那么对于ASP.NET兼容模式下的WCF也一样，要想让服务端能够识别会话，就需要让每个服务调用的HTTP请求携带Session的识别信息，我们也可以通过传递Cookie的方式来解决这个问题。对于WCF来说，Cookie传递能够通过Binding来控制，对于WsHttpBinding来说，默认情况下并不允许Cookie的传递。我们可以通过WsHttpBinding的AllowCookies来控制是否允许传递Cookie，该属性可以通过配置进行设置。为此，我们对客户端的配置进行了如下的修改。再次运行我们的案例程序，将会得到你期望的输出。

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

   1: <?xml version="1.0" encoding="utf-8" ?>
   2: <configuration>
   3:     <system.serviceModel>
   4:         <client>
   5:             <endpoint address="http://localhost/AspCompatibleServices/CalculatorService.svc"
   6:                 binding="wsHttpBinding" contract="Artech.AspCompatibleServices.Contracts.ICalculator"
   7:                 name="CalculatorService"  bindingConfiguration="CookieAllowableBinding"/>
   8:         </client>
   9:         <bindings>
  10:         <wsHttpBinding>
  11:             <binding name="CookieAllowableBinding" allowCookies="true"/>
  12:         </wsHttpBinding>
  13:         </bindings>
  14: </system.serviceModel>
  15: </configuration>

客户端输出结果：

   1: 初始值为：0
   2: Add（3）运算结果为：3
   3: Multiply（10）运算结果为：30
   4: Subtract（2）运算结果为：28
时间： 2024-08-04 16:12:15

WCF技术剖析之五：利用ASP.NET兼容模式创建支持会话（Session）的WCF服务的相关文章

WCF技术剖析之二十九：换种不同的方式调用WCF服务[提供源代码下载]

原文:WCF技术剖析之二十九:换种不同的方式调用WCF服务[提供源代码下载] 我们有两种典型的WCF调用方式:通过SvcUtil.exe(或者添加Web引用)导入发布的服务元数据生成服务代理相关的代码和配置:通过ChannelFactory<TChannel>创建服务代理对象.在这篇文章中,我们采用一种独特的方式进行服务的调用.从本质上讲,我们只要能够创建于服务端相匹配的终结点,就能够实现正常的服务调用.在WCF客户端元数据架构体系中,利用MetadataExchangeClient可以获取服

《WCF技术剖析》博文系列汇总[持续更新中]

http://www.cnblogs.com/artech/archive/2009/11/21/1607686.html 近半年以来,一直忙于我的第一本WCF专著<WCF技术剖析(卷1)>的写作,一直无暇管理自己的Blog.在<WCF技术剖析(卷1)>写作期间,对WCF又有了新的感悟,为此以书名开始本人的第三个WCF系列.本系列的目的在于对<WCF技术剖析>的补充,会对书中的一些内容进行展开讲述,同时会囊括很多由于篇幅的原因忍痛割弃的内容. [第1篇] 通过一个ASP

WCF技术剖析之一：通过一个ASP.NET程序模拟WCF基础架构

原文:WCF技术剖析之一:通过一个ASP.NET程序模拟WCF基础架构 细算起来,已经有好几个月没有真正的写过文章了.近半年以来,一直忙于我的第一本WCF专著<WCF技术剖析>的写作,一直无暇管理自己的Blog.到目前为止<WCF技术剖析(卷1)>的写作暂告一段落,初步预计于下个月由武汉博文视点出版.在<WCF技术剖析>写作期间,对WCF又有了新的感悟,为此以书名开始本人的第三个WCF系列.本系列的目的在于对<WCF技术剖析>的补充,会对书中的一些内容进行展

WCF技术剖析之二：再谈IIS与ASP.NET管道

原文:WCF技术剖析之二:再谈IIS与ASP.NET管道 在2007年9月份,我曾经写了三篇详细介绍IIS架构和ASP.NET运行时管道的文章,深入介绍了IIS 5.x与IIS 6.0HTTP请求的监听与分发机制,以及ASP.NET运行时管道对HTTP请求的处理流程: [原创]ASP.NET Process Model之一:IIS 和 ASP.NET ISAPI [原创]ASP.NET Process Model之二:ASP.NET Http Runtime Pipeline - Part I

WCF技术剖析之六：为什么在基于ASP.NET应用寄宿（Hosting）下配置的BaseAddress无效

原文:WCF技术剖析之六:为什么在基于ASP.NET应用寄宿(Hosting)下配置的BaseAddress无效 本篇文章来源于几天前一个朋友向我咨询的问题.问题是这样的,他说他采用ASP.NET应用程序的方式对定义的WCF服务进行寄宿(Hosting),并使用配置的方式对服务的BaseAddress进行了设置,但是在创建ServiceHost的时候却抛出InvalidOperationException,并提示相应Address Scheme的BaseAddress找不到.我意识到这可能和WC

WCF技术剖析之十：调用WCF服务的客户端应该如何进行异常处理

原文:WCF技术剖析之十:调用WCF服务的客户端应该如何进行异常处理 在前面一片文章(服务代理不能得到及时关闭会有什么后果?)中,我们谈到及时关闭服务代理(Service Proxy)在一个高并发环境下的重要意义,并阐明了其根本原因.但是,是否直接调用ICommunicationObject的Close方法将服务代理关闭就万事大吉了呢?事情远不会这么简单,这其中还会涉及关于异常处理的一些操作,这就是本篇文章需要讨论的话题. 一.异常的抛出与Close的失败 一般情况下,当服务端抛出异常,客户客户

WCF技术剖析之四：基于IIS的WCF服务寄宿（Hosting）实现揭秘

原文:WCF技术剖析之四:基于IIS的WCF服务寄宿(Hosting)实现揭秘 通过<再谈IIS与ASP.NET管道>的介绍,相信读者已经对IIS和ASP.NET的请求处理管道有了一个大致的了解,在此基础上去理解基于IIS服务寄宿的实现机制就显得相对容易了.概括地说,基于IIS的服务寄宿依赖于两个重要的对象:System.ServiceModel.Activation.HttpModule和System. ServiceModel.Activation.HttpHandler. 一.通过Htt

WCF技术剖析之八：ClientBase&lt;T&gt;中对ChannelFactory&lt;T&gt;的缓存机制

原文:WCF技术剖析之八:ClientBase<T>中对ChannelFactory<T>的缓存机制 和传统的分布式远程调用一样,WCF的服务调用借助于服务代理(Service Proxy).而ChannelFactory<T>则是服务代理的创建者.WCF采用基于终结点(Endpoint)服务消费方式:WCF服务通过一个或者多个终结点暴露给潜在的服务消费者,服务的消费中通过与之匹配的终结点与之交互.在客户端,我们具有两种典型的服务代理创建方式,其一是通过诸如SvcUti

WCF技术剖析之三十：一个很有用的WCF调用编程技巧[下篇]

原文:WCF技术剖析之三十:一个很有用的WCF调用编程技巧[下篇] 在<上篇>中,我通过使用Delegate的方式解决了服务调用过程中的异常处理以及对服务代理的关闭.对于<WCF技术剖析(卷1)>的读者,应该会知道在第7章中我通过类似于AOP的方式解决了相似的问题,现在我们来讨论这个解决方案. 通过<服务代理不能得到及时关闭会有什么后果?>的介绍,我们知道了及时关闭服务代理的重要意义,并且给出了正确的编程方式.如果严格按照上面的编程方式,就意味着对于每一个服务调用,都要