如果你想深刻理解ASP.NET Core请求处理管道,可以试着写一个自定义的Server
我们在上面对ASP.NET Core默认提供的具有跨平台能力的KestrelServer进行了详细介绍(《聊聊ASP.NET Core默认提供的这个跨平台的服务器——KestrelServer》),为了让读者朋友们对管道中的Server具有更加深刻的认识,接下来我们采用实例演示的形式创建一个自定义的Server。这个自定义的Server直接利用HttpListener来完成针对请求的监听、接收和响应,我们将其命名为HttpListenerServer。在正式介绍HttpListenerServer的设计和实现之前,我们先来显示一下如何将它应用到 一个具体的Web应用中。
一、HttpListenerServer的使用
我们依然采用最简单的Hello World应用来演示针对HttpListenerServer的应用,所以我们在Startup类的Configure方法中编写如下的程序直接响应一个“Hello World”字符串。
1: public class Startup
2: {
3: public void Configure(IApplicationBuilder app)
4: {
5: app.Run(context => context.Response.WriteAsync("Hello World!"));
6: }
7: }
在作为程序入口的Main方法中,我们直接创建一个WebHostBuilder对象并调用扩展方法UseHttpListener完成针对自定义HttpListenerServer的注册。我们接下来调用UseStartup方法注册上面定义的这个启动类型,然后调用Build方法创建一个WebHost对象,最后调用Run方法运行这个作为宿主的WebHost。
1: public class Program
2: {
3: public static void Main()
4: {
5: new WebHostBuilder()
6: .UseHttpListener()
7: .UseStartup<Startup>()
8: .Build()
9: .Run();
10: }
11: }
12:
13: public static class WebHostBuilderExtensions
14: {
15: public static IWebHostBuilder UseHttpListener(this IWebHostBuilder builder)
16: {
17: builder.ConfigureServices(services => services.AddSingleton<IServer, HttpListenerServer>());
18: return builder;
19: }
20: }
我们自定义的扩展方法UseHttpListener的逻辑很简单,它只是调用WebHostBuilder的ConfigureServices方法将我们自定义的HttpListenerServer类型以单例模式注册到指定的ServiceCollection上而已。我们直接运行这个程序并利用浏览器访问默认的监听地址(http://localhost:5000),服务端响应的“Hello World”字符串会按照如下图所示的形式显示在浏览器上。
二、总体设计
接下来我们来介绍一下HttpListenerServer的大体涉及。除了HttpListenerServer这个实现了IServer的自定义Server类型之外,我们只定义了一个名为HttpListenerServerFeature的特性类型,下图所示的UML基本上体现了HttpListenerServer的总体设计。
三、HttpListenerServerFeature
如果我们利用HttpListener来监听请求,它会为接收到的每次请求创建一个属于自己的上下文,具体来说这是一个类型为HttpListenerContext对象。我们可以利用这个HttpListenerContext对象获取所有与请求相关的信息,针对请求的任何响应也都是利用它完成的。上面这个HttpListenerServerFeature实际上就是对这个作为原始上下文的HttpListenerContext对象的封装,或者说它是管道使用的DefaultHttpContext与这个原始上下文之间沟通的中介。
如下所示的代码片段展示了HttpListenerServerFeature类型的完整定义。简单起见,我们并没有实现上面提到过的所有特性接口,而只是选择性地实现了IHttpRequestFeature和IHttpResponseFeature这两个最为核心的特性接口。它的构造函数除了具有一个类型为HttpListenerContext的参数之外,还具有一个字符串的参数pathBase用来指定请求URL的基地址(对应IHttpRequestFeature的PathBase属性),我们利用它来计算请求URL的相对地址(对应IHttpRequestFeature的Path属性)。IHttpRequestFeature和IHttpResponseFeature中定义的属性都可以直接利用HttpListenerContext对应的成员来实现,这方面并没有什么特别之处。
1: public class HttpListenerServerFeature : IHttpRequestFeature, IHttpResponseFeature
2: {
3: private readonly HttpListenerContext httpListenerContext;
4: private string queryString;
5: private IHeaderDictionary requestHeaders;
6: private IHeaderDictionary responseHeaders;
7: private string protocol;
8: private readonly string pathBase;
9:
10: public HttpListenerServerFeature(HttpListenerContext httpListenerContext, string pathBase)
11: {
12: this.httpListenerContext = httpListenerContext;
13: this.pathBase = pathBase;
14: }
15:
16: #region IHttpRequestFeature
17:
18: Stream IHttpRequestFeature.Body
19: {
20: get { return httpListenerContext.Request.InputStream; }
21: set { throw new NotImplementedException(); }
22: }
23:
24: IHeaderDictionary IHttpRequestFeature.Headers
25: {
26: get { return requestHeaders
27: ?? (requestHeaders = GetHttpHeaders(httpListenerContext.Request.Headers)); }
28: set { throw new NotImplementedException(); }
29: }
30:
31: string IHttpRequestFeature.Method
32: {
33: get { return httpListenerContext.Request.HttpMethod; }
34: set { throw new NotImplementedException(); }
35: }
36:
37: string IHttpRequestFeature.Path
38: {
39: get { return httpListenerContext.Request.RawUrl.Substring(pathBase.Length);}
40: set { throw new NotImplementedException(); }
41: }
42:
43: string IHttpRequestFeature.PathBase
44: {
45: get { return pathBase; }
46: set { throw new NotImplementedException(); }
47: }
48:
49: string IHttpRequestFeature.Protocol
50: {
51: get{ return protocol ?? (protocol = this.GetProtocol());}
52: set { throw new NotImplementedException(); }
53: }
54:
55: string IHttpRequestFeature.QueryString
56: {
57: Get { return queryString ?? (queryString = this.ResolveQueryString());}
58: set { throw new NotImplementedException(); }
59: }
60:
61: string IHttpRequestFeature.Scheme
62: {
63: get { return httpListenerContext.Request.IsWebSocketRequest ? "https" : "http"; }
64: set { throw new NotImplementedException(); }
65: }
66: #endregion
67:
68: #region IHttpResponseFeature
69: Stream IHttpResponseFeature.Body
70: {
71: get { return httpListenerContext.Response.OutputStream; }
72: set { throw new NotImplementedException(); }
73: }
74:
75: string IHttpResponseFeature.ReasonPhrase
76: {
77: get { return httpListenerContext.Response.StatusDescription; }
78: set { httpListenerContext.Response.StatusDescription = value; }
79: }
80:
81: bool IHttpResponseFeature.HasStarted
82: {
83: get { return httpListenerContext.Response.SendChunked; }
84: }
85:
86: IHeaderDictionary IHttpResponseFeature.Headers
87: {
88: get { return responseHeaders
89: ?? (responseHeaders = GetHttpHeaders(httpListenerContext.Response.Headers)); }
90: set { throw new NotImplementedException(); }
91: }
92: int IHttpResponseFeature.StatusCode
93: {
94: get { return httpListenerContext.Response.StatusCode; }
95: set { httpListenerContext.Response.StatusCode = value; }
96: }
97:
98: void IHttpResponseFeature.OnCompleted(Func<object, Task> callback, object state)
99: {
100: throw new NotImplementedException();
101: }
102:
103: void IHttpResponseFeature.OnStarting(Func<object, Task> callback, object state)
104: {
105: throw new NotImplementedException();
106: }
107: #endregion
108:
109: private string ResolveQueryString()
110: {
111: string queryString = "";
112: var collection = httpListenerContext.Request.QueryString;
113: for (int i = 0; i < collection.Count; i++)
114: {
115: queryString += $"{collection.GetKey(i)}={collection.Get(i)}&";
116: }
117: return queryString.TrimEnd('&');
118: }
119:
120: private IHeaderDictionary GetHttpHeaders(NameValueCollection headers)
121: {
122: HeaderDictionary dictionary = new HeaderDictionary();
123: foreach (string name in headers.Keys)
124: {
125: dictionary[name] = new StringValues(headers.GetValues(name));
126: }
127: return dictionary;
128: }
129:
130: private string GetProtocol()
131: {
132: HttpListenerRequest request = httpListenerContext.Request;
133: Version version = request.ProtocolVersion;
134: return string.Format("{0}/{1}.{2}", request.IsWebSocketRequest ? "HTTPS" : "HTTP", version.Major, version.Minor);
135: }
136: }
四、HttpListenerServer
接下来我们来看看HttpListenerServer的定义。如下面的代码片段所示,用来监听请求的HttpListener在构造函数中被创建,与此同时,我们会创建一个用于获取监听地址的ServerAddressesFeature对象并将其添加到属于自己的特性列表中。当HttpListenerServer随着Start方法的调用而被启动后,它将这个ServerAddressesFeature对象提取出来,然后利用它得到所有的地址并添加到HttpListener的Prefixes属性表示的监听地址列表中。接下来,HttpListener的Start方法被调用,并在一个无限循环中开启请求的监听与接收。
1: public class HttpListenerServer : IServer
2: {
3: private readonly HttpListener listener;
4:
5: public IFeatureCollection Features { get; } = new FeatureCollection();
6:
7: public HttpListenerServer()
8: {
9: listener = new HttpListener();
10: this.Features.Set<IServerAddressesFeature>(new ServerAddressesFeature());
11: }
12:
13: public void Dispose()
14: {
15: listener.Stop();
16: }
17:
18: public void Start<TContext>(IHttpApplication<TContext> application)
19: {
20: foreach (string address in this.Features.Get<IServerAddressesFeature>().Addresses)
21: {
22: listener.Prefixes.Add(address.TrimEnd('/') + "/");
23: }
24:
25: listener.Start();
26: while (true)
27: {
28: HttpListenerContext httpListenerContext = listener.GetContext();
29:
30: string listenUrl = this.Features.Get<IServerAddressesFeature>().Addresses.First(address => httpListenerContext.Request.Url.IsBaseOf(new Uri(address)));
31: string pathBase = new Uri(listenUrl).LocalPath.TrimEnd('/') ;
32: HttpListenerServerFeature feature = new HttpListenerServerFeature(httpListenerContext, pathBase);
33:
34: FeatureCollection features = new FeatureCollection();
35: features.Set<IHttpRequestFeature>(feature);
36: features.Set<IHttpResponseFeature>(feature);
37: TContext context = application.CreateContext(features);
38:
39: application.ProcessRequestAsync(context).ContinueWith(task =>
40: {
41: httpListenerContext.Response.Close();
42: application.DisposeContext(context, task.Exception);
43: });
44: }
45: }
46: }
HttpListener的GetContext方法以同步的方式监听请求,并利用接收到的请求创建返回的HttpListenerContext对象。我们利用它解析出当前请求的基地址,并进一步创建出描述当前原始上下文的HttpListenerServerFeature。接下来我们将这个对象分别采用特性接口IHttpRequestFeature和IHttpResponseFeature添加到创建的FeatureCollection对象中。然后我们将这个FeatureCollection作为参数调用HttpApplication的CreateContext创建出上下文对象,并将其作为参数调用HttpApplication的ProcessContext方法让注册的中间件来逐个地对请求进行处理。
如果你想深刻理解ASP.NET Core请求处理管道,可以试着写一个自定义的Server的更多相关文章
- 理解 ASP.NET Core: 处理管道
理解 ASP.NET Core 处理管道 在 ASP.NET Core 的管道处理部分,实现思想已经不是传统的面向对象模式,而是切换到了函数式编程模式.这导致代码的逻辑大大简化,但是,对于熟悉面向对象 ...
- 用.Net Core控制台模拟一个ASP.Net Core的管道模型
在我的上几篇文章中降到了asp.net core的管道模型,为了更清楚地理解asp.net core的管道,再网上学习了.Net Core控制台应用程序对其的模拟,以加深映像,同时,供大家学习参考. ...
- 理解ASP.NET Core - 错误处理(Handle Errors)
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或[点击此处查看全文目录](https://www.cnblogs.com/xiaoxiaotank/p/151852 ...
- 理解ASP.NET Core - [02] Middleware
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 中间件 先借用微软官方文档的一张图: 可以看到,中间件实际上是一种配置在HTTP请求管道中,用 ...
- 理解ASP.NET Core - 配置(Configuration)
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 配置提供程序 在.NET中,配置是通过多种配置提供程序来提供的,包括以下几种: 文件配置提供程 ...
- 理解ASP.NET Core - 选项(Options)
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 Options绑定 上期我们已经聊过了配置(IConfiguration),今天我们来聊一聊O ...
- 理解ASP.NET Core - 路由(Routing)
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 Routing Routing(路由):更准确的应该叫做Endpoint Routing,负责 ...
- 理解ASP.NET Core - 文件服务器(File Server)
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 提供静态文件 静态文件默认存放在 Web根目录(Web Root) 中,路径为 项目根目录(C ...
- 理解ASP.NET Core - 日志(Logging)
注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 快速上手 添加日志提供程序 在文章主机(Host)中,讲到Host.CreateDefault ...
随机推荐
- 干货来袭-整套完整安全的API接口解决方案
在各种手机APP泛滥的现在,背后都有同样泛滥的API接口在支撑,其中鱼龙混杂,直接裸奔的WEB API大量存在,安全性令人堪优 在以前WEB API概念没有很普及的时候,都采用自已定义的接口和结构,对 ...
- app开发外包注意事项,2017最新资讯
我们见过很多创业者,栽在这app外包上.很多创业者对于app外包这件事情不是特别重视,以为将事情交给app外包公司就完事了,实际上不是的.无论是从选择app外包公司还是签订合同.售后维护等各方面都有许 ...
- python与c互相调用
虽然python开发效率很高,但作为脚本语言,其性能不高,所以为了兼顾开发效率和性能,通常把性能要求高的模块用c或c++来实现或者在c或c++中运行python脚本来处理逻辑,前者通常是python中 ...
- 【NLP】干货!Python NLTK结合stanford NLP工具包进行文本处理
干货!详述Python NLTK下如何使用stanford NLP工具包 作者:白宁超 2016年11月6日19:28:43 摘要:NLTK是由宾夕法尼亚大学计算机和信息科学使用python语言实现的 ...
- Spark踩坑记——数据库(Hbase+Mysql)
[TOC] 前言 在使用Spark Streaming的过程中对于计算产生结果的进行持久化时,我们往往需要操作数据库,去统计或者改变一些值.最近一个实时消费者处理任务,在使用spark streami ...
- 解构C#游戏框架uFrame兼谈游戏架构设计
1.概览 uFrame是提供给Unity3D开发者使用的一个框架插件,它本身模仿了MVVM这种架构模式(事实上并不包含Model部分,且多出了Controller部分).因为用于Unity3D,所以它 ...
- [原] KVM 虚拟化原理探究(2)— QEMU启动过程
KVM 虚拟化原理探究- QEMU启动过程 标签(空格分隔): KVM [TOC] 虚拟机启动过程 第一步,获取到kvm句柄 kvmfd = open("/dev/kvm", O_ ...
- c++ pair 使用
1. 包含头文件: #include <utility> 2. pair 的操作: pair<T1,T2> p; pair<T1,T2> p(v1,v2); pai ...
- Visual Studio Code——Angular2 Hello World 之 2.0
最近看到一篇用Visual Studio Code开发Angular2的文章,也是一篇入门教程,地址为:使用Visual Studio Code開發Angular 2專案.这里按部就班的做了一遍,感觉 ...
- 查看mac中磁盘空间占用情况
今天发现磁盘空间不够了,首先要找到那些文件夹占用了磁盘空间. du命令很好使 du -c -d 1 -m | sort -n -c 显示当前文件夹总计占用空间 -d 1 层级为1,即只显示当前目录下一 ...