asp.net core 源码每日读 -- WebHost
前言
这个标题也许并不适合这个系列, 因为距离上篇已经半个月有余, 是不是该改名为源码半月读?
为了不让懒癌再次发作, 给自己定个小目标, 一周两篇. 立誓于此, 天地可鉴.
WebHost之重要性
我们先来看看WebHost的函数们
有两个函数需要重点关注一下.
1. Initialize
相信大家记得上一篇中最后在创建了WebHost对象后, 紧接着调用了Initalize函数. 直入主题, 此函数的实现是这样的.
public void Initialize()
{
if (_application == null)
{
_application = BuildApplication();
}
}
简单来说在这个地方主要是为_application 变量赋值. _application 是个什么样的变量呢?
首先, 我们可以知道它是一个RequestDelegate 类型.
private RequestDelegate _application;
其次, 通过查看RequestDelegate 类型的定义, 我们可以获取到一些信息.
//
// Summary:
// A function that can process an HTTP request.
//
// Parameters:
// context:
// The Microsoft.AspNetCore.Http.HttpContext for the request.
//
// Returns:
// A task that represents the completion of request processing.
public delegate Task RequestDelegate(HttpContext context);
综上, 我们知道RequestDelegate是一个委托, 并且注释中提到, 这个委托用来处理HTTP请求.
最后, 我们来看下BuildApplication函数的实现, 一窥究竟.
EnsureApplicationServices();
EnsureServer();
var builderFactory = _applicationServices.GetRequiredService<IApplicationBuilderFactory>();
var builder = builderFactory.CreateBuilder(Server.Features);
builder.ApplicationServices = _applicationServices;
var startupFilters = _applicationServices.GetService<IEnumerable<IStartupFilter>>();
Action<IApplicationBuilder> configure = _startup.Configure;
foreach (var filter in startupFilters.Reverse())
{
configure = filter.Configure(configure);
}
configure(builder);
return builder.Build();
前面两个函数EnsureApplicationServices和EnsureServer从字面意思可以看出来, 确保_applicationServices和Server两个变量不为Null.
先看_applicationServices, 第一次执行到这里的时候, 确实是Null的, 所以我们要看看它是如何被实例的.
private void EnsureApplicationServices()
{
if (_applicationServices == null)
{
EnsureStartup();
_applicationServices = _startup.ConfigureServices(_applicationServiceCollection);
}
}
看来还需要先确保_startup对象不为空, 这样, 我们看看EnsureStartup函数
private void EnsureStartup()
{
if (_startup != null)
{
return;
}
_startup = _hostingServiceProvider.GetRequiredService<IStartup>();
}
_hostingServiceProvider 就是我们在实例化WebHost时传入的参数hostingServiceProvider. 它是一个依赖注入的容器, 前面已经把很多服务都注入其中. 这样确保_startup变量能够获取到IStartup接口的对象. 相信大家对IStartup接口的对象已经很熟悉了, 之前还有一篇文章专门介绍它. 这样, 我们获取到了Startup类的对象, 看看它会被如何利用.
_applicationServices = _startup.ConfigureServices(_applicationServiceCollection);
ConfigureServices函数将返回一个依赖注入的服务容器. 通俗的讲, Startup类中配置进来的服务将被包装后交给_applicationServices.
再回来看一下另外一个确保不为Null的对象Server.
private void EnsureServer()
{
if (Server == null)
{
Server = _applicationServices.GetRequiredService<IServer>();
var serverAddressesFeature = Server.Features?.Get<IServerAddressesFeature>();
var addresses = serverAddressesFeature?.Addresses;
if (addresses != null && !addresses.IsReadOnly && addresses.Count == 0)
{
var urls = _config[WebHostDefaults.ServerUrlsKey] ?? _config[DeprecatedServerUrlsKey];
if (!string.IsNullOrEmpty(urls))
{
serverAddressesFeature.PreferHostingUrls = WebHostUtilities.ParseBool(_config, WebHostDefaults.PreferHostingUrlsKey);
foreach (var value in urls.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries))
{
addresses.Add(value);
}
}
}
}
}
通过依赖注入容器获取IServer的实例, 那IServer类型的实例哪里来呢? 大家是否还记得这样一段代码
var host = new WebHostBuilder()
.UseKestrel()
没错, Kestrel就是被抽象为继承了IServer接口的类, 这里就有证明
public static IWebHostBuilder UseKestrel(this IWebHostBuilder hostBuilder)
{
hostBuilder.UseLibuv();
return hostBuilder.ConfigureServices(services =>
{
services.AddTransient<IConfigureOptions<KestrelServerOptions>, KestrelServerOptionsSetup>();
services.AddSingleton<IServer, KestrelServer>();
});
}
这段代码我是在Kestrel源码中找到的, 也是我后面想要继续研读的代码, 大家尝个鲜
后面的代码则是获取Server对象的一些信息, 不罗嗦.
再继续看BuildApplication这个函数后面的代码
var builderFactory = _applicationServices.GetRequiredService<IApplicationBuilderFactory>();
var builder = builderFactory.CreateBuilder(Server.Features);
builder.ApplicationServices = _applicationServices;
var startupFilters = _applicationServices.GetService<IEnumerable<IStartupFilter>>();
Action<IApplicationBuilder> configure = _startup.Configure;
foreach (var filter in startupFilters.Reverse())
{
configure = filter.Configure(configure);
}
configure(builder);
return builder.Build();
这段逻辑获取到了一个IApplicationBuilder类型的实例builder, 并将builder变量作为参数放到Startup类中的Configure函数中执行. 不知大家是否还记得Configure函数的定义, 我随便找了一段实现
public override void Configure(IApplicationBuilder app)
{
app.Run(async (context) =>
{
await context.Response.WriteAsync("Hello World!");
});
}
参数正是**IApplicationBuilder 接口类型, 从这段代码中可以得知IApplicationBuilder **的对象是用来执行Http请求的, 这就够了, ApplicationBuilder类的源码在HttpAbstractions那个项目中, 我们后面读到的时候进行详解.
2. StartAsync
大家需要注意一下, StartAsync是个虚方法, 说不好在什么地方会对其进行重写. 但是目前我还没有看到, 如果将来有发现情况川酷也会及时向大家通报.
public virtual async Task StartAsync(CancellationToken cancellationToken)
{
HostingEventSource.Log.HostStart();
_logger = _applicationServices.GetRequiredService<ILogger<WebHost>>();
_logger.Starting();
Initialize();
_applicationLifetime = _applicationServices.GetRequiredService<IApplicationLifetime>() as ApplicationLifetime;
_hostedServiceExecutor = _applicationServices.GetRequiredService<HostedServiceExecutor>();
var diagnosticSource = _applicationServices.GetRequiredService<DiagnosticListener>();
var httpContextFactory = _applicationServices.GetRequiredService<IHttpContextFactory>();
var hostingApp = new HostingApplication(_application, _logger, diagnosticSource, httpContextFactory);
await Server.StartAsync(hostingApp, cancellationToken).ConfigureAwait(false);
// Fire IApplicationLifetime.Started
_applicationLifetime?.NotifyStarted();
// Fire IHostedService.Start
_hostedServiceExecutor.Start();
_logger.Started();
// Log the fact that we did load hosting startup assemblies.
if (_logger.IsEnabled(LogLevel.Debug))
{
foreach (var assembly in _options.HostingStartupAssemblies)
{
_logger.LogDebug("Loaded hosting startup assembly {assemblyName}", assembly);
}
}
if (_hostingStartupErrors != null)
{
foreach (var exception in _hostingStartupErrors.InnerExceptions)
{
_logger.HostingStartupAssemblyError(exception);
}
}
}
代码比较多, 但逻辑是很清晰的. 逻辑顺序基本上是这样.
一. 启动Log
二. 调用Initialize函数, 以获得_application对象**
三. 通过_applicationServices这个服务容器获取到一些服务实例.** 其中比较引起我兴趣的是httpContextFactory.
四. 实例化一个HostingApplication**类型的对象. 此时将_application, httpContextFactory作为参数传入, 猜想里面定有玄机, 我们来一窥究竟.
当看到CreateContext这个函数, 心里起了一丝波澜, 这是用于保存HTTP请求上下文的Context对象吗?
public Context CreateContext(IFeatureCollection contextFeatures)
{
var context = new Context();
var httpContext = _httpContextFactory.Create(contextFeatures);
_diagnostics.BeginRequest(httpContext, ref context);
context.HttpContext = httpContext;
return context;
}
答案是肯定的. 这里的代码并不难懂, 对于_httpContextFactory如何创建HttpContext对象, 我们将在HttpAbstractions中进行详解.
另外一个另我激动的地方是ProcessRequestAsync函数.
public Task ProcessRequestAsync(Context context)
{
return _application(context.HttpContext);
}
前面有段注释说道, _application委托是用于处理HTTP请求的. 而_application是由IApplicationBuilder类型的对象Build而来. IApplicationBuilder类型的对象与Startup类的Configure函数又有如此紧密的联系. 相信看到这里大家都会有一个比较清晰理解了.
五. 启动Server. 对于启动Server的代码, 我想留到后面Kestrel源码中进行分析, 大家先将其理解为对这个HTTP server的一个启动动作.
完结
至此Hosting这个工程的源码基本读完, 下一篇准备对这一部分的内容进行一个总结.
--------------------------华丽丽的分割-----------------------------------
愿dotnet社区日益强大, 愿dotnet生态日趋完善. dotnet core技术交流群欢迎你, 扫描下面二维码进群.
