[WCF REST] Web消息主体风格(Message Body Style)

简介:

对于Web HTTP编程模型来说,服务契约中作为操作的方法无须应用OperationContractAttribute特性,只需要根据需要应用WebGetAttribute与WebInvokeAttribute特性即可。前者针对GET HTTP方法,或者则针对其他HTTP方法。WebGetAttribute与WebInvokeAttribute的属性BodyStyle和IsBodyStyleSetExplicitly涉及到“Web消息主体风格”的话题。

   1: [AttributeUsage(AttributeTargets.Method)]
   2: public sealed class WebGetAttribute : Attribute, IOperationBehavior
   3: {
   4:     //其他成员
   5:     public WebMessageBodyStyle BodyStyle { get; set; }
   6: }
   7:  
   8: [AttributeUsage(AttributeTargets.Method)]
   9: public sealed class WebInvokeAttribute : Attribute, IOperationBehavior
  10: {
  11:     //其他成员
  12:     public WebMessageBodyStyle BodyStyle { get; set; }
  13: }

至于消息主体的风格通过具有如下定义的枚举WebMessageBodyStyle表示。

   1: public enum WebMessageBodyStyle
   2: {
   3:     Bare,
   4:     Wrapped,
   5:     WrappedRequest,
   6:     WrappedResponse
   7: }

我们知道请求消息和回复消息分别是对操作方法输入参数和返回值(输出参数和引用参数)的封装,WebMessageBodyStyle中的Bare表示请求消息和回复消息的主体部分仅仅包含针对输入参数和返回值(输出参数和引用参数)序列化后的内容,而Wrapped则会在外面包装一个基于当前操作的“封套”。枚举项WrappedRequest和WrappedResponse用于单独针对请求消息和回复消息的主体进行封装。

WebGetAttribute与WebInvokeAttribute的属性BodyStyle的默认值为Bare。如果该属性被设置成WrappedRequest,则回复消息主体依然采用Bare风格;如果该属性被设置成WrappedResponse,则请求消息主体依然采用Bare风格。布尔类型的只读属性IsBodyStyleSetExplicitly表示是否针对属性BodyStyle进行了显示设置。

目录
一、Xml+Bare
二、Xml+Wrapped
三、JSON+Bare
四、JSON+Wrapped
五、Bare请求消息风格对单一输入的限制
六、Bare回复消息风格对单一输出的限制

一、Xml + Bare

我们通过之前演示的实例来看看针对不同的消息格式(XML和JSON),请求消息和回复消息的主体在采用不同风格的情况下具有怎样的结构。现在我们对应用在契约接口IEmployees中的Create操作方法上的WebInvokeAttribute进行了如下的修改,即显式地指定了请求消息和回复消息的格式(XML)和主体风格(Bare)。同时也将返回类型从void编程了Employee,并直接将创建的Employee对象返回。

   1: [ServiceContract]
   2: public interface IEmployees
   3: {
   4:     //其他成员
   5:     [WebInvoke(UriTemplate = "/", Method = "POST", 
   6:     RequestFormat = WebMessageFormat.Xml, 
   7:     ResponseFormat = WebMessageFormat.Xml, 
   8:     BodyStyle = WebMessageBodyStyle.Bare)]
   9:     Employee Create(Employee employee);
  10: }
  11:  
  12: public class EmployeesService : IEmployees
  13: {
  14:     //其他成员
  15:     public Employee Create(Employee employee)
  16:     {
  17:         employees.Add(employee);
  18:         return employee;
  19:     }
  20: }

我们针对如下所示的代码通过服务调用添加一个姓名为“王五”的员工。

   1: using (ChannelFactory<IEmployees> channelFactory = new ChannelFactory<IEmployees>("employeeService"))
   2: {
   3:     IEmployees proxy = channelFactory.CreateChannel();
   4:     proxy.Create(new Employee
   5:     {
   6:         Id         = "003",
   7:         Name       = "王五",
   8:          Grade     = "G9",
   9:         Department = "行政部"
  10:     });           
  11: }

针对如上所示的服务调用,由于消息格式和主体风格分别为Xml和Bare,所以作为请求消息和回复消息的主体仅仅是Employee对象被序列化后生成的XML片断,具体内容如下所示。

   1: 请求消息主体:
   2: <Employee xmlns="http://www.artech.com/" 
   3:   xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   4:   <Department>行政部</Department>
   5:   <Grade>G9</Grade>
   6:   <Id>003</Id>
   7:   <Name>王五</Name>
   8: </Employee>
   9:  
  10: 回复消息主体:
  11: <Employee xmlns="http://www.artech.com/" 
  12:   xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  13:   <Department>行政部</Department>
  14:   <Grade>G9</Grade>
  15:   <Id>003</Id>
  16:   <Name>王五</Name>
  17: </Employee>

二、Xml + Wrapped

现在我们对契约接口略加修改,将应用在操作方法Create上的WebInvokeAttribute特性的属性BodyStyle设置为Wrapped

   1: [ServiceContract]
   2: public interface IEmployees
   3: {
   4:     //其他成员
   5:     [WebInvoke(UriTemplate = "/", Method = "POST", 
   6:     RequestFormat = WebMessageFormat.Xml, 
   7:     ResponseFormat = WebMessageFormat.Xml, 
   8:     BodyStyle = WebMessageBodyStyle.Wrapped)]
   9:     Employee Create(Employee employee);
  10: }

针对相同的服务调用,请求消息和回复消息将具有如下所示的主体内容。我们可以看出Employee被序列化后生成的XML在请求消息中作为<Create>元素的子元素;对于回复消息来说,Employee被序列化后生成的XML的根元素名称为CreateResult,而不是<Employee>,而整个<CreateResult>内嵌于< CreateResponse >元素中。

   1: 请求消息主体:
   2: <Create xmlns="http://tempuri.org/">
   3:   <employee xmlns:a="http://www.artech.com/" 
   4:         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   5:     <a:Department>行政部</a:Department>
   6:     <a:Grade>G9</a:Grade>
   7:     <a:Id>003</a:Id>
   8:     <a:Name>王五</a:Name>
   9:   </employee>
  10: </Create>
  11:  
  12: 回复消息主体:
  13: <CreateResponse xmlns="http://tempuri.org/">
  14:   <CreateResult xmlns:a="http://www.artech.com/" 
  15:         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  16:     <a:Department>行政部</a:Department>
  17:     <a:Grade>G9</a:Grade>
  18:     <a:Id>003</a:Id>
  19:     <a:Name>王五</a:Name>
  20:   </CreateResult>
  21: </CreateResponse>

三、JSON+ Bare

上面我们通过实例演示了消息格式为Xml情况下针对不同风格的消息主体的内容差异,现在我们按照相同的方式来讨论当消息格式为JSON的时候,针对不同风格的消息主体在结构上又具有怎样差异。如下面的代码片断所示,我们通过对契约接口的修改将服务操作Create的消息格式和主体风格设置成Json和Bare

   1: [ServiceContract]
   2: public interface IEmployees
   3: {
   4:     //其他成员
   5:     [WebInvoke(UriTemplate = "/", Method = "POST", 
   6:     RequestFormat = WebMessageFormat.Json, 
   7:     ResponseFormat = WebMessageFormat.Json, 
   8:     BodyStyle = WebMessageBodyStyle.Bare)]
   9:     Employee Create(Employee employee);
  10: }

同样针对之前的服务调用,以JSON形式表示的Employee对象将直接作为请求消息和回复消息的主体部分,具体的内容如下所示。(S1004)

   1: 请求消息主体:
   2: {"Department":"行政部","Grade":"G9","Id":"003","Name":"王五"}
   3:  
   4: 回复消息主体:
   5: {"Department":"行政部","Grade":"G9","Id":"003","Name":"王五"}

四、JSON+ Wrapped

我们最后来演示Json消息格式在Wrapped风格下具有怎样的结构,为此我们只需要将应用在Create操作方法上的WebInvokeAttribute特性的BodyStyle属性设置为Wrapped。

   1: [ServiceContract]
   2: public interface IEmployees
   3: {
   4:     //其他成员
   5:     [WebInvoke(UriTemplate = "/", Method = "POST", 
   6:     RequestFormat = WebMessageFormat.Json, 
   7:     ResponseFormat = WebMessageFormat.Json, 
   8:     BodyStyle = WebMessageBodyStyle.Wrapped)]
   9:     Employee Create(Employee employee);
  10: }

如下面的代码所示,由于请求消息和回复消息采用Wrapped风格,表示Employee的JSON对象最终作为最终JSON对象的“employee”属性和“CreateResult”属性。(S1005)

   1: 请求消息主体:
   2: {"employee":{"Department":"行政部","Grade":"G9","Id":"003","Name":"王五"}}
   3:  
   4: 回复消息主体:
   5: {"CreateResult":{"Department":"行政部","Grade":"G9","Id":"003","Name":"王五"}}

五、Bare请求消息风格对单一输入的要求

对于Bare消息主体风格来说,意味着对象被序列化后生成的XML或者JSON表示直接作为消息的主体,所以只适用于单一对象。具体来说,只有具有唯一输入参数的操作方法才能将请求消息的主题风格设置为Bare。

   1: [ServiceContract(Namespace = "http://www.artech.com/")]
   2: public interface ICalculator
   3: {
   4:     [WebInvoke(BodyStyle = WebMessageBodyStyle.Bare)]
   5:     double Add( double x,  double y);
   6: }

如上所示的是我们熟悉的计算服务的契约接口的定义。消息主体风格为Bare的操作方法Create具有两个输入参数(x和y),在对实现了该契约接口进行寄宿的时候就会抛出如下图所示的InvalidOperationException异常,提示“约定“ICalculator”的操作‘Add’指定要序列化多个请求正文参数,但没有任何包装元素。如果没有包装元素,至多可序列化一个正文参数。请删除多余的正文参数,或将 WebGetAttribute/WebInvokeAttribute 的 BodyStyle 属性设置为 Wrapped”。

image

六、Bare回复消息风格对单一输出的要求

由于回复参数是对返回值、引用参数和输出参数的封装,所以当操作方法具有引用参数或者输出参数时不能将回复消息的主体风格设置为Bare。

   1: [ServiceContract(Namespace = "http://www.artech.com/")]
   2: public interface ICalculator
   3: {    
   4:     [WebInvoke(BodyStyle = WebMessageBodyStyle.WrappedRequest)]
   5:     void Add( double x,  double y, out double result);
   6: }

同样以计算服务契约为例,现在我们通过如上的方式以输出参数的形式返回加法运算的结果,并将应用在操作方法上的WebInvokeAttribute特性的BodyStyle属性设置为WrappedRequest,这意味着请求消息和回复消息分别采用Wrapped和Bare风格。当我们对实现了该契约接口的服务设施寄宿时会抛出下图所示的InvalidOperationException异常,并提示“约定‘ICalculator’的操作‘Add’至少指定一个响应正文参数不是操作的返回值。当 WebGetAttribute/WebInvokeAttribute 的 BodyStyle 属性设置为 Bare 时,只允许使用返回值。请删除多余的响应正文参数或将 BodyStyle 属性设置为 Wrapped”。

image


作者:蒋金楠
微信公众账号:大内老A
微博: www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送,或者想看看个人推荐的技术资料,可以扫描左边二维码(或者长按识别二维码)关注个人公众号(原来公众帐号 蒋金楠的自媒体将会停用)。
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
相关文章
|
7月前
|
开发框架 监控 .NET
Visual Basic的Web服务和REST API开发指南
【4月更文挑战第27天】本文探讨了使用Visual Basic(VB.NET)构建Web服务和RESTful API的方法。首先介绍了Web服务的基础和REST API的概念,然后阐述了.NET Framework与.NET Core/.NET 5+对VB.NET的支持,以及ASP.NET Core在Web开发中的作用。接着,详细讲解了创建RESTful API的步骤,包括控制器与路由设置、模型绑定与验证,以及返回响应。此外,还讨论了安全措施、测试方法、部署选项和监控策略。最后强调,VB.NET开发者可以通过ASP.NET Core涉足现代Web服务开发,拓宽技术领域。
276 1
|
4月前
|
开发框架 中间件 .NET
分享 ASP.NET Core Web Api 中间件获取 Request Body 两个方法
分享 ASP.NET Core Web Api 中间件获取 Request Body 两个方法
151 0
|
5月前
|
开发框架 安全 .NET
使用VB.NET构建Web服务和REST API的指南
【7月更文挑战第2天】使用VB.NET构建Web服务和REST API的指南:从Web服务基础到ASP.NET Core实践,涵盖控制器、路由、模型绑定、安全措施(如JWT、HTTPS)及测试、部署(Azure、Docker)与监控工具。了解如何利用VB.NET在现代云环境中创建高效、安全的API。开始你的VB.NET Web服务开发之旅!**
231 1
|
6月前
|
JavaScript 前端开发 定位技术
Rest风格WEB服务(Rest Style Web Service)的真相
Rest风格WEB服务(Rest Style Web Service)的真相
155 1
|
7月前
|
JSON 安全 API
【专栏】四种REST API身份验证方法:基本认证、OAuth、JSON Web Token(JWT)和API密钥
【4月更文挑战第28天】本文探讨了四种REST API身份验证方法:基本认证、OAuth、JSON Web Token(JWT)和API密钥。基本认证简单但不安全;OAuth适用于授权第三方应用;JWT提供安全的身份验证信息传递;API密钥适合内部使用。选择方法时需平衡安全性、用户体验和开发复杂性。
851 0
|
7月前
|
JSON API 网络架构
Python Web 开发: 解释 Django REST framework 的作用,以及如何定义序列化器(Serializer)?
Python Web 开发: 解释 Django REST framework 的作用,以及如何定义序列化器(Serializer)?
85 0
|
XML 缓存 JSON
REST vs SOAP:两种 Web 服务协议的分析
REST(Representational State Transfer)和 SOAP(Simple Object Access Protocol)都是 Web 服务架构的两种主要风格。两者都提供了一种通信方式,可以让不同的应用程序通过网络互相交换数据。但是,它们之间有一些重要的区别。
|
2月前
|
XML JSON API
ServiceStack:不仅仅是一个高性能Web API和微服务框架,更是一站式解决方案——深入解析其多协议支持及简便开发流程,带您体验前所未有的.NET开发效率革命
【10月更文挑战第9天】ServiceStack 是一个高性能的 Web API 和微服务框架,支持 JSON、XML、CSV 等多种数据格式。它简化了 .NET 应用的开发流程,提供了直观的 RESTful 服务构建方式。ServiceStack 支持高并发请求和复杂业务逻辑,安装简单,通过 NuGet 包管理器即可快速集成。示例代码展示了如何创建一个返回当前日期的简单服务,包括定义请求和响应 DTO、实现服务逻辑、配置路由和宿主。ServiceStack 还支持 WebSocket、SignalR 等实时通信协议,具备自动验证、自动过滤器等丰富功能,适合快速搭建高性能、可扩展的服务端应用。
147 3
|
1月前
|
设计模式 前端开发 数据库
Python Web开发:Django框架下的全栈开发实战
【10月更文挑战第27天】本文介绍了Django框架在Python Web开发中的应用,涵盖了Django与Flask等框架的比较、项目结构、模型、视图、模板和URL配置等内容,并展示了实际代码示例,帮助读者快速掌握Django全栈开发的核心技术。
156 45