WCF服务编程规范Word文件下载.docx

1、MSMQWCF具有互操作性的Web服务支持.NET到.NET的通信分布式事务支持WS标准消息队列WCF同时也使得面向服务编程更加简单而统一了。如果采用旧有的技术，由于各种技术的编程模型完全不一致，使得程序的迁移非常的困难。例如，最初采用.NET Remoting技术开发的分布式系统，由于业务需求的变化，要求发布具有互操作性的Web服务，就需要重新定义服务。并且，客户端的调用方式也发生了变 化，需要添加Web引用，通过UDDI去发现服务。采用WCF则不然。WCF引入了用通道，它封装了消息的通信细节，例如编码、事务处 理、安全等，然后又通过引入绑定的概念，封装了通道的组成顺序与处理细节。最后，引入

2、了独有的Endpoint元素，集成了地址、绑定和契约之间的“三位 一体”，以最简单的方式定义和发布服务。3.3、WCF基础的技术要素WCF的大部分功能都放在一个单独的程序集System.ServiceModel.dll中。WCF的几个最重要的技术元素包括：绑定、契约、端点。如 前所述，绑定封装了通道的组成顺序与处理细节，它直接决定了WCF的通信方式，消息的编码方式，通道的协议，消息传递的可靠性以及安全等内容。通过使用绑 定，我们就无需了解消息在WCF通道中的实现细节，从而简化程序员的开发。正是因为此，WCF为开发人员提供了多个内置绑定，基本上涵盖了WCF应用的大 部分场景。以下是Aaron S

3、konnard在WCF深度绑定一文中列举的内置绑定：绑定类名称传输消息编码消息版本安全模式可靠消息传送事务流（默认情况下禁用）BasicHttpBindingHTTP文本SOAP 1.1无不支持WSHttpBindingSOAP 1.2 WS-Addressing 1.0消息禁用WS-AtomicTransactionsWSDualHttpBinding启用WSFederationHttpBindingNetTcpBindingTCP二进制SOAP 1.2OleTransactionsNetPeerTcpBindingP2PNetNamedPipesBinding命名管道NetMsmqBind

4、ingMsmqIntegrationBinding不支持（使用 WCF 之前的序列化格式）每种绑定对应不同的传输协议、消息编码格式和版本以及安全、可靠性和事务模式。WCF也提供了扩展绑定的方式，例如通过CustomBinding或者定义派生与Binding的类。WCF 的契约包括服务契约、数据契约和消息契约（特别的，还包括了错误契约，用于异常的处理）。其中服务契约为面向服务应用程序的核心，通过它可以定义服务。数 据契约则为服务所要传递的数据。由于服务的调用需要跨进程或机器进行通信，就需要服务数据必须能够被序列化和反序列化。虽然.NET本身提供了数据的序列 化功能，但WCF的数据契约更加符合服务

5、数据的定义习惯。至于消息契约，则可以将服务数据定义为消息，包括XML文本格式、MTOM（消息传输优化机制） 格式和二进制格式。绑定（Binding）、契约（Contract）与服务的地址（Address）组合在一起，则形成了终结点（Endpoint），如下图所示：Address 是Endpoint的网络地址，它标记了消息发送的目的地。Binding描述的是如何发送消息，例如消息发送的传输协议（如TCP，HTTP），安全 （如SSL，SOAP消息安全）。Contract则描述的是消息所包含的内容，以及消息的组织和操作方式，例如是单向，双向还是请求/响应方式。引 入终结点可以说是WCF的一个伟大创

6、举，通过它使得我们能够更加容易的发布和管理服务，尤其是发布和管理多个服务。每个服务必须至少拥有一个终结点，而客 户端正是通过终结点知道服务的相关信息，例如地址、消息编码格式、传输协议以及服务的内容，然后在进行正确的调用。最特别的是，同一个服务可以定义多个终 结点，每个终结点可以是不同的地址、不同的绑定方式，以便于满足多个客户端的不同需要。而对于服务的发布者而言，我们只需要管理终结点的配置，就可以完成 对服务的管理，这也为服务的托管提供了便利。四 原则4.1封装业务逻辑所有能脱离界面的业务逻辑的处理都应该封装在WCF服务中4.2封装数据库访问数据库的访问应该通过WCF提供的接口访问数据库，不对界

7、面显示层暴露数据库的具体内容4.3封装文件存储文件存储应通过WCF提供的接口访问文件服务器进行文件操作4.4 线程安全WCF服务应该是线程安全的，支持异步调用（涉及并发管理）4.5数据完整性Wcf服务应该支持事务，保证数据完整性，所有修改数据库的操作和修改文件的操作都应该有回滚机制（自己实现或使用系统事务）五 实现细则规范5.1服务契约（接口）5.1.1 服务契约定义 WCF的所有服务都会公开为契约（Contract）。契约与平台无关，是描述服务功能的标准方式，服务契约描述了客户端能够执行的服务操作。 ServiceContract属性可以将一个CLR接口（或类）映射为与技术无关的服务（WCF

8、契约），WCF契约与类型的访问限定无关，因为类型的访问限定属于CLR的概念。即使将ServiceContract属性标记在内部接口上，该接口同样会被公开为服务契约，以便跨越服务边界实现服务的调用。如果接口没有标记ServiceContract属性，WCF客户端则无法访问它。这一特定遵循了面向服务的一个原则，即服务边界要清晰。为满足这一原则，所有的契约必须明确要求：只有接口或类可以被标记为ServiceContract属性，其他类型都不允许。WCF使用OperationContract属性显著标明接口或类的哪些方法需要暴露为WCF契约的服务操作。另外WCF只运允许将OperationContra

9、ct属性标记到方法上，而不允许标记到同样属于CLR概念的属性，索引器和事件上。WCF只能识别逻辑功能的操作（Operation）。此外契约操作不能使用对象参数，只允许使用基本类型或者数据契约。 例：ServiceContractInterface IMyContract OperationContract String MyMethod（string text）; /没有OperationContract标记，不会成为契约的一部分 String MyOtherMethod（string text）Class MyService : ImyContract Public string MyMet

10、hod（string text） Public string MyOtherMethod（string text）5.1.2 操作重载5.1.3 契约分解 合理的契约分解可以实现深度化，松散耦合，精细调整，以及契约的重用，这些优势有助于改善整个系统。 设计面向服务的系统时，需要平衡两个影响系统的因素（下图），一为实现服务契约的代价，一个则是将服务契约合并或者集成为一个应用程序的代价 如果定义了太多的细粒度的服务契约，虽然他们易于实现，但是集成它们的代价太高，另一方面，如果仅定义了几个复杂而又庞大的服务契约，虽然集成的代价可能会降低，但制约了契约的实现，以及系统集成的灵活性原则上一个功能模块封装

11、成一个服务契约，对于比较庞大的模块可以按功能分解成两到三个服务契约5.2 数据契约（类）5.2.1 数据契约定义数据契约定义了与服务交互的数据类型。面向服务的核心原则就是在跨越服务边界时服务不能够暴露他们的实现技术，这意味着WCF不允许在跨越边界时公开CLR数据类型。需要找到一种方法，实现CLR数据类型与标准的平台无关的表现形式，这就是基于XML的样式。事实上，将对象（或值类型）作为操作参数或操作结果传递时，真正需要发送的是对象的状态，然后接收端再将它转换为本地的表现形式。这种传递状态的方式称为值编组。执行值编组的最简单办法是利用大多数平台自身提供的序列化技术。通常在WCF中用DataCont

12、ract特性来标记类可以被序列化，用DataMember特性标记类的序列化的成员。DataContractPublic class Contract DataMember Public string FirstName get;set; Public string LastName5.2.2 推断数据契约wcf有推断数据契约功能，如果编组类型是公共类型，且未标记DataContract特性，WCF就会自动推断，认为DataContract特性被应用到该类型上，且它所有的公有成员均被应用了DataMember特性，依赖于数据契约的推断是一种草率的方法，它与WCF的大多数内容背道而驰。既然WCF无

13、法从仅有的接口定义中推断出服务契约，或者默认允许事务或可靠性，它就不应该推断数据契约。面向服务在很大程度上偏向于默认“否决”的方式（安全是一个例外）,正因为如此，它需要最大限度的封装与解耦合。对数据契约显示的使用DataContract特性，就使得你可以利用数据契约的功能，如版本控制，定制序列化成员等。5.2.3 版本控制服务应尽可能地与它们的客户端解藕，特别涉及版本控制与技术问题时。任意一个版本的客户端都应该能够调用所有版本的服务。WCF的版本判断与.NET不同，并不借助版本号。当服务和客户端共享一个数据契约时，一个重要目标是要允许服务和客户端各自演化数据契约版本。为支持重要的解藕，WCF支

14、持版本的向前和向后兼容。5.2.3.1新增成员数据契约最常见的变化是在其中一端添加了新的成员，然后将新的契约发送到旧的客户端或服务。在反序列化这样的数据契约类型时，DataContractSerialize会忽略新增成员。这样，服务和客户端就能够接收包含新增成员的数据，且该新增成员并非原有契约的一部分。5.2.3.2缺失成员默认情况下，WCF允许服务与客户端双方都可以移除数据契约的成员。当接收端的DataContractSerialize在消息中无法找到所需信息去反序列化这些成员时，会根据成员的默认值进行反序列化。也就是说，把引用类型设置为NULL,将值类型设置为0。在操作过程中，这就像发送方

15、从来没有初始化这些成员一样。这种默认策略允许服务接收包含缺失成员的数据，或者能够返回包含了缺失成员的数据到客户端。5.2.3.3必备成员与新增成员采取忽略新成员的方式不同，缺失成员的默认处理有可能会导致接收端调用链的操作失败，从而导致运行良好的系统产生灾难性的后果。其原因在于缺失的成员有可能是正确执行操作的必要条件。如果成员是缺失的，则可以通过将DataMember特性的IsRequired属性值设置为true来避免WCF调用这些操作而导致调用失败:Class MyContact DataMember（IsRequired=true）IsRequired默认值为false,即忽略缺失成员。如果

16、消息中的成员被标记为必备成员，当接收端的DataContractSerialize无法找到所需要的信息进行反序列化时，就会取消这次调用，发送端会引发NetDispatcherFaultException异常。客户端和服务端都能够将他们的部分或所有数据成员标记为必备，彼此之间是完全独立的。当拥有一个必备新成员的数据契约发送到接收方时，即使接收方无法识别该成员，这样的调用实际上仍然是有效的，同时也允许这样的传递。5.2.4 枚举枚举类型的定义总是支持序列化的。当定义一个新的枚举时，不必应用DataContract特性，就可以在数据契约中使用它。 如果要将确定的枚举值排除与数据契约之外，首先就需要为

17、枚举类型标记DataContract属性，然后再将那些希望包含在枚举数据类型中的枚举值，明确的标记为EnumMember特性，没有标记EnumMember特性的枚举值不属于该枚举的数据契约。EnumMember特性还有一个用途，通过它的Value属性为现有的枚举数据契约的枚举值设置别名。Enum ContactType /传输时名称为MyCustomer EnumMember（Value=”MyCustomer”） Customer, EnumMember Vendor, /不会成为数据契约的一部分 Partner生成的传输型表示形式如下： MyCustomer, Vendor5.2.5委托与

18、事件 所有的委托和事件定义都被编译到可序列化的类中，理论上，委托和事件相当于数据契约类型的成员变量。 如：Class MyDataContract Public EventHandler MyEvent; field:DataMember Public event EventHandle Myeve;在实际操作中，当数据契约引用一个自定义委托时，导入的数据契约将包含一个无效的委托定义，虽然可以手动修改定义，但更大的问题是在包含了委托成员变量的对象时，委托的内部调用列表也会被序列化。在大多数情况下，对于服务和客户端而言，这并非理想结果，因为列表具体的结构是本地的，客户端或服务无法跨服务边界共享委

19、托列表的结构。此外，不能保证内部列表中的目标对象都是可序列化的，或者都是有效的数据契约。这会导致序列化的操作时而成功，时而失败。所有，我们约定不要将DataMember特性应用到委托/事件上。5.2.6 泛型不能定义包含了泛型类型参数的数据契约。泛型是.NET的特定技术，使用他们可能会与WCF的面向服务特性发生冲突。但是，仍然可以在数据契约中使用限定的泛型类型，只要在契约中指定了类型参数，并且指定的类型参数具有有效的数据契约，不过这就失去了使用泛型的意义，故不推荐。5.2.7 集合5.2.7.1 .net内建集合在.net中,各种类型的集合均实现了IEnumerable或IEenumerabl

20、e接口。所有内建的.net集合，如数组，列表和栈都实现了这些接口。一个数据契约的数据成员可以是集合类型，服务契约也可以定义直接与集合交互的操作，因为.net集合是.net特有的，WCF不能在服务元数据中公开他们。而服务的类型非常有用，所有WCF专门为集合提供了编组原则。定义服务操作时，不管使用下列那种集合接口IEenumerable,Ilist和ICollection,他们的传输型表示形式都使用数组。Interface IcontactManager IEnumerable GetContacts（）;Class ContactManager:IcontactManager Public IE

21、numerable GetContacts（） List conts = new List（）; return conts; 导出的结果为： Contact GetContacts（）;5.2.7.2 具体集合类型如果契约中的集合为具体集合类型（不是接口），而且属于可序列化集合（标记为Serializable特性而不是DataContract特性），那么，只要提供的集合包含了Add（）方法，并符合如下的一种方法签名，WCF就能够自动地将集合规范为数组类型。Public void Add（object obj）; /Collection uses IEnumerablePublic void A

22、dd（T item）; /Collection uses IEnumerable GetMyClasss（）;public class Service : IServicepublic List GetMyClasss（） MyClass m = new MyClass（）; list = new List list.Add（m）; return list; /客户端/ public interface IService WCFClient.Service.MyClass GetMyClasss（）;public partial class ServiceClient : System.Ser

23、viceModel.ClientBase, WCFClient.Service.IService public WCFClient.Service.MyClass GetMyClasss（） return base.Channel.GetMyClasss（）; 注意：为了能够将它编组为数组，集合必须包含Add（）方法，但并不需要实现Add（）方法。5.2.7.3自定义集合并非只有内建的集合类型才具有自动编组为数组的能力，任何自定义集合只要符合相同的先决条件（包含Add（）方法），就可以被编组为数组。5.2.7.4 字典集合字典集合是一个特殊的集合类型，它可以为两个数据契约类型建立映射关系，因此，字典集合不会被编组为数组或列表。如果字典集合是一个实现了IDdictionary接口的可序列化集合，那么它会被公开为Dictionary;这种处理方式同样适用于HashTable集合类型SerializablePublic class MyDictionary:IDdictionaryMyDictionary GetContacts（）;Dictionary GetMyClassDict（）;公开的定义为：5.2.7.5 Colle