05、NetCore2.0插件框架运行原理之WebHostBuilder源码初窥_.NET_编程开发_程序员俱乐部

05、NetCore2.0插件框架运行原理之WebHostBuilder源码初窥

NetCore2.0的插件框架是要解决对象创建的问题，把创建对象与使用对象进行解耦。调用者不需要关心对象是单例的还是多实例的；插件的扩展和调用也更容易。

一、我们先看看插件框架是如何使用的

首先使用VS2017新建一个控制台程序，要使用插件框架，我们需要引入微软的依赖注入包：

install-package Microsoft.Extensions.DependencyInjection

我们声明一个自己的接口，并实现一个类

// 接口
interface IRun
    {
        void Run();
    }

// 实现类
class Run : IRun
    {
        void IRun.Run()
        {
            Console.WriteLine("跑起来，兄弟");
        }
    }

使用插件框架来注册接口和类的实例；并通过服务提供者来访问接口

using Microsoft.Extensions.DependencyInjection;
using System;

namespace MyServiceBus
{
    class Program
    {
        static void Main(string[] args)
        {
            // 实例化服务插件框架
            IServiceCollection services = new ServiceCollection();
            // 在服务插件框架中加入接口的一个实例（它是单例的）
            services.AddSingleton<IRun, Run>();

            // 服务插件的提供者
            IServiceProvider serviceProvider = services.BuildServiceProvider();

            // ============上下两部分代码一般不会同时出现在一个类中========

            // 从服务插件提供者获取接口的实例（不用关心是如何创建的）
            serviceProvider.GetService<IRun>().Run();
            Console.ReadLine();
        }
    }
}

看看运行效果吧！可以看出，IRun业务的调用方，不需要关心是如何实例化的。

二、在Asp.NetCore2.0中插件框架是如何使用的

一个极简的Web应用程序一般是这样的：

using Microsoft.AspNetCore.Hosting;

namespace MyWebApi
{
    class Program
    {
        static void Main(string[] args)
        {
            var host = new WebHostBuilder()
                .UseKestrel()
                .UseStartup<StartUp>()
                .Build();

            host.Run();
        }
    }
}

从上面的代码中判断，插件框架的初始化和接口注册应该是在WebHostBuild.Build()方法中完成的，从命名就能看出，这是一个建造者模式，把内部复杂的构建方式隐藏了。我们去看一下这个方法的开源代码：

        // 为了说明问题，代码略作调整，保留核心代码
        public IWebHost Build()
        {
            // 初始化服务插件框架：估计里面预制了一些服务插件
            IServiceCollection hostingServices = BuildCommonServices(out var hostingStartupErrors);
            IServiceCollection applicationServices = hostingServices.Clone();
            
            // 服务插件的提供者
            ServiceProvider hostingServiceProvider = hostingServices.BuildServiceProvider();

            AddApplicationServices(applicationServices, hostingServiceProvider);

            var host = new WebHost(
                applicationServices,
                hostingServiceProvider,
                _options,
                _config,
                hostingStartupErrors);

            host.Initialize();

            return host;
        }

我们可以看到在WebHostBuild.Build()方法中，显示的初始化了服务插件框架，我们看一下服务插件框架初始化方法的源码，可以发现确实预制了一些服务：

        // 为了说明问题，代码略作调整，保留核心代码
        private IServiceCollection BuildCommonServices(out AggregateException hostingStartupErrors)
        {
            // 配置选项
            _options = new WebHostOptions(_config);
            var contentRootPath = ResolveContentRootPath(_options.ContentRootPath, AppContext.BaseDirectory);
            var applicationName = _options.ApplicationName;

            // Initialize the hosting environment
            _hostingEnvironment.Initialize(applicationName, contentRootPath, _options);
            _context.HostingEnvironment = _hostingEnvironment;

            // 实例化服务插件框架 
            var services = new ServiceCollection();

            // 预制环境参数插件到框架中
            services.AddSingleton(_hostingEnvironment);
            // 预制上下文插件到框架中
            services.AddSingleton(_context);
            // 预制配置管理插件到框架中
            var builder = new ConfigurationBuilder()
                .SetBasePath(_hostingEnvironment.ContentRootPath)
                .AddInMemoryCollection(_config.AsEnumerable());
            var configuration = builder.Build();
            services.AddSingleton<IConfiguration>(configuration);
            _context.Configuration = configuration;
            // 预制诊断工具插件到框架中
            var listener = new DiagnosticListener("Microsoft.AspNetCore");
            services.AddSingleton<DiagnosticListener>(listener);
            services.AddSingleton<DiagnosticSource>(listener);
            // 预制诊断其他插件到框架中
            services.AddTransient<IApplicationBuilderFactory, ApplicationBuilderFactory>();
            services.AddTransient<IHttpContextFactory, HttpContextFactory>();
            services.AddScoped<IMiddlewareFactory, MiddlewareFactory>();
            services.AddOptions();
            services.AddLogging();
            // Conjure up a RequestServices
            services.AddTransient<IStartupFilter, AutoRequestServicesStartupFilter>();
            services.AddTransient<IServiceProviderFactory<IServiceCollection>, DefaultServiceProviderFactory>();
            // Ensure object pooling is available everywhere.
            services.AddSingleton<ObjectPoolProvider, DefaultObjectPoolProvider>();

            return services;
        }

从代码分析看WebHostBuilder做的事如下:
1. 定义了一些WebHost的配置项
2. 创建依赖注入的容器, 并预制一些service