[WCF REST] WebHttpBinding与消息编码
不论是我们采用SOAP还是REST架构风格,运行时框架体系依然不曾改变,终结点也仍旧是通信的核心。在Web HTTP编程模型中,我们采用基于WebHttpBinding绑定的终结点。绑定是一组相关绑定元素的有序组合,绑定的特性与能力决定于它包含的绑定元素,在这里我们通过分析绑定元素的方式来剖析WebHttpBinding绑定与其它绑定有何不同。采用HTTP/HTTPS通信协议的WebHttpBinding具有一些与WSHttpBinding/WS2007HttpBinding相同的属性,在这里我们只关心如下定义的Security属性。
1: public class WebHttpBinding : Binding, IBindingRuntimePreferences
2: {
3: //其它成员
4: public WebHttpSecurity Security { get; }
5: }
6: public sealed class WebHttpSecurity
7: {
8: // 其它成员
9: public WebHttpSecurityMode Mode { get; set; }
10: public HttpTransportSecurity Transport { get; }
11: }
12: public enum WebHttpSecurityMode
13: {
14: None,
15: Transport,
16: TransportCredentialOnly
17: }
基于SOAP的绑定一般具有两种基本的安全模式,即Message和Transport模式。对于前者,它是完全建立在WS-Security为核心的安全协议之上的,而整个WS-*协议簇都是基于SOAP的,所以自然不能应用在WebHttpBinding上,所以它只能通过HTTPS提供针对Transport模式的安全支持。具体来说,通过枚举WebHttpSecurityMode表示的安全模式具有如下三个选项:
- None:HTTP 请求未使用任何安全性;
- Transport:HTTP 请求使用传输级安全性;
- TransportCredentialOnly:仅提供基于 HTTP 的客户端身份验证。
一、WebHttpBinding的绑定元素
现在我们根据上述三种不同的安全模式创建相应的WebHttpBinding对象,然后通过如下的程序在控制台中答应出所有的绑定元素类型。
1: static void Main(string[] args)
2: {
3: WebHttpBinding binding = new WebHttpBinding(WebHttpSecurityMode.None);
4: ListBindingElements(binding);
5:
6: binding = new WebHttpBinding(WebHttpSecurityMode.Transport);
7: ListBindingElements(binding);
8:
9: binding = new WebHttpBinding(WebHttpSecurityMode.TransportCredentialOnly);
10: ListBindingElements(binding);
11: }
12: static void ListBindingElements(WebHttpBinding binding)
13: {
14: int index = 1;
15: Console.WriteLine(binding.Security.Mode + ":");
16: foreach (var element in binding.CreateBindingElements())
17: {
18: Console.WriteLine("{0}. {1}", index++, element.GetType().FullName);
19: }
20: Console.WriteLine();
21: }
上述的程序执行之后会在控制台上产生如下的输出,从中我们不难看出三个WebHttpBinding均由一个消息编码元素和传输元素组成,我们知道这两种绑定元素最所有类型的绑定所必需的。
1: None:
2: 1. System.ServiceModel.Channels.WebMessageEncodingBindingElement
3: 2. System.ServiceModel.Channels.HttpTransportBindingElement
4:
5: Transport:
6: 1. System.ServiceModel.Channels.WebMessageEncodingBindingElement
7: 2. System.ServiceModel.Channels.HttpsTransportBindingElement
8:
9: TransportCredentialOnly:
10: 1. System.ServiceModel.Channels.WebMessageEncodingBindingElement
11: 2. System.ServiceModel.Channels.HttpTransportBindingElement
对于WebHttpBinding的两个绑定元素来说,由于它通过HTTPS提供针对Transport安全的支持,所以当安全模式为Transport时对应的传输绑定元素为HttpsTransportBindingElement,对于其余两种安全模式则直接采用HttpTransportBindingElement作为传输绑定元素。现在我们着重讨论是作为消息编码绑定元素的WebMessageEncodingBindingElement类型,以及它涉及的消息编码机制。
二、消息编码
我们先来看看WebMessageEncodingBindingElement的基本的定义。如下面的代码片断所示,它是MessageEncodingBindingElement的子类,并且具有与TextMessageEncodingElement类似的属性定义。其中MaxReadPoolSize和MaxWritePoolSize表示表示无需分配新的XmlDictionaryReader/XmlDictionaryWriter便可以读取的便可同时读取/写入的最大消息数,默认值分别是64和16。ReaderQuotas属性返回用于约束读取的XML的复杂度的XmlDictionaryReaderQuotas对象,而WriteEncoding属性表示采用的字符编码类型,默认采用UTF-8编码方式。由于WebHttpBinding不使用SOAP,表示消息版本的MessageVersion属性自然返回None,如果我们对该属性进行设置,指定的属性值也只能是MessageVersion.None。
1: public sealed class WebMessageEncodingBindingElement : MessageEncodingBindingElement,...
2: {
3: //其它成员
4: public override MessageEncoderFactory CreateMessageEncoderFactory();
5:
6: public bool CrossDomainScriptAccessEnabled {get; set; }
7: public WebContentTypeMapper ContentTypeMapper { get; set; }
8:
9: public int MaxReadPoolSize { get; set; }
10: public int MaxWritePoolSize { get; set; }
11: public override MessageVersion MessageVersion { get; set; }
12: public XmlDictionaryReaderQuotas ReaderQuotas { get; }
13: public Encoding WriteEncoding { get; set; }
14: }
除此之外,WebMessageEncodingBindingElement具有CrossDomainScriptAccessEnabled 和ContentTypeMapper这两个重要的属性。前者表示是否支持跨域(Corss-Domain)脚本访问,默认值为False。后者类型为WebContentTypeMapper。WebContentTypeMapper用于进行消息的内容类型(Content Type,有时候也成为媒体类型或者MIME类型)与具体的格式(比如XML、JSON等)之间的映射。
1: public abstract class WebContentTypeMapper
2: {
3: protected WebContentTypeMapper();
4: public abstract WebContentFormat GetMessageFormatForContentType(string contentType);
6: }
7: public enum WebContentFormat
8: {
9: Default,
10: Xml,
11: Json,
12: Raw
13: }
如上面的代码所示,WebContentTypeMapper是一个抽象类,包含的唯一的抽象方法GetMessageFormatForContentType用于根据指定的内容类型返回与之匹配的通过枚举WebContentFormat表示的内容格式。WebContentFormat枚举的Xml、JSON和Raw体现了Web HTTP编程模型支持三种基本格式,其中Raw表示原始的二进制。
最终的消息编码/解码工作是通过继承自MessageEncoder的消息编码器实现的,消息编码器又是通过继承自MessageEncoderFactory的编码器工厂创建出来的,而消息编码绑定元素最终通过方法CreateMessageEncoderFactory创建了编码器工厂。对于WebMessageEncodingBindingElement来说,它的CreateMessageEncoderFactory方法会创建一个具有如下定义的WebMessageEncoderFactory对象。
1: internal class WebMessageEncoderFactory : MessageEncoderFactory
2: {
3: public WebMessageEncoderFactory(Encoding writeEncoding, int maxReadPoolSize,int maxWritePoolSize, XmlDictionaryReaderQuotas quotas,
4: WebContentTypeMapper contentTypeMapper, bool javascriptCallbackEnabled);
5: public override MessageEncoder Encoder { get; }
6: public override MessageVersion MessageVersion { get; }
7: }
8:
WebMessageEncoderFactory是一个继承自MessageEncoderFactory的内部类型。除了布尔类型的参数javascriptCallbackEnabled对应着WebMessageEncodingBindingElement的属性CrossDomainScriptAccessEnabled之外,WebMessageEncoderFactory的构造函数参数与WebMessageEncodingBindingElement的同名属性一一对应。代表消息版本的MessageVersion属性依然返回None,而真正用于最终消息编码/解码工作的是通过Encoder属性返回的具有如下定义的WebMessageEncoder对象。
1: internal class WebMessageEncoderFactory : MessageEncoderFactory
2: {
3: private class WebMessageEncoder : MessageEncoder
4: {
5: //其他成员
6: private MessageEncoder TextMessageEncoder { get; }
7: private MessageEncoder JsonMessageEncoder { get; }
8: private MessageEncoder RawMessageEncoder { get; }
9: }
10: }
如上面的代码片断所示,WebMessageEncoder实际上是内嵌于WebMessageEncoderFactory类型中继承自MessageEncoder的内部类型。WebMessageEncoder本身并不真正地实施消息的编码/解码,最终的消息编码/解码工作是通过三个属性TextMessageEncoder、JsonMessageEncoder和RawMessageEncoder体现的具体消息编码器完成的,而它们又分别对应着通过WebContentFormat枚举表示的三种内容类型Xml、JSON和Raw。
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 2-2.进程通信-多线程
- 微服务[学成在线] day17:基于Zuul网关实现路由转发、过滤器
- Delta Lake 学习笔记(一)
- Delta Lake 学习笔记(二)
- Delta Lake 学习笔记(三)
- 4.IP地址与子网划分
- 08-软考的法律条文
- Intellij IDEA必备插件,提高效率的“七种武器”!
- Mongodb分页查询优化下
- MySQL 案例:大表改列的新技巧(Generated Column)
- Spark 2.2 on K8S Dynamic Resource Allocation
- Java中异常处理的9个最佳实践
- Mongodb执行计划
- Spark 2.2/2.3/2.4 的 Dynamic Resource Allocation
- 04-操作文件与目录