ASP.NET Core 5.0 (1) - 模板项目创建及解析

本文不是针对初学者的入门文章,而是从asp.net core 5.0 源码的角度分析程序是如何加载并运行的。

创建 ASP.NET Core Web App(MVC) 模板项目

运行 VS2019 并创建新的ASP.NET Core Web App(Model-View-Controller) 模板项目, 在创建向导中 Target Framework选择 .Net 5.0,我们暂时不需要任何的身份验证 所以 Authentication Type
选择 None,项目创建完成后目录结构类似于:

MVCTemplate.jpg

直接 F5 运行,浏览器会默认打开 http://localhost:5000/ 的地址,模板只含有两个页面 Home 及 Privacy

分析模板代码

下面来分析主程序,打开Program.cs

    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }

CreateHostBuilder 方法会创建并配置一个 builder 对象,然后调用Build方法创建一个IHost的实例,最后调用Run 方法启动host。
下面一步步分析这段代码。
首先Host是一个静态类,命名空间是Microsoft.Extensions.Hosting, 这个静态类中只包含两个静态方法,还是重载方法, 只参数不同

public static IHostBuilder CreateDefaultBuilder();
public static IHostBuilder CreateDefaultBuilder(string[] args);

来看看CreateDefaultBuilder具体的实现,去掉了一些具体的配置代码

public static IHostBuilder CreateDefaultBuilder(string[] args)
        {
            var builder = new HostBuilder();

            builder.UseContentRoot(Directory.GetCurrentDirectory());
            builder.ConfigureHostConfiguration(config =>
            {
               //加载DOTNET_ 环境变量和命令行参数
            });

            builder.ConfigureAppConfiguration((hostingContext, config) =>
            {
                //添加json配置文件, user secret,环境变量和命令行参数
            })
            .ConfigureLogging((hostingContext, logging) =>
            {
                //添加log:Event log,Console log,Debug, Event source,配置文件的log
            })
            .UseDefaultServiceProvider((context, options) =>
            {
              //配置依赖注入服务的验证信息
            });

            return builder;
        }

通过调用此方法就初始化好了一个IHostBuilder的实例(HostBuilder)
,至此所有配置的加载以及代码都是针对通用宿主(generic host),没有针对asp.net core 或 HTTP 请求的任何代码,在这个通用宿主的基础上我们可以设置成控制台程序,worker service,以及asp.net core 应用。
要把程序设成asp.net core, 程序调用IHostBuilder的一个扩展方法ConfigureWebHostDefaults,这个方法位于静态类GenericHostBuilderExtensions 中, 调用此方法是为hosting web app加载一些默认的选项。

 public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action<IWebHostBuilder> configure)
        {
            if (configure is null)
            {
                throw new ArgumentNullException(nameof(configure));
            }

            return builder.ConfigureWebHost(webHostBuilder =>
            {
                WebHost.ConfigureWebDefaults(webHostBuilder);

                configure(webHostBuilder);
            });
        }

此方法中继续调用IHostBuilder的另外一个扩展方法ConfigureWebHost

        public static IHostBuilder ConfigureWebHost(this IHostBuilder builder, Action<IWebHostBuilder> configure, Action<WebHostBuilderOptions> configureWebHostBuilder)
        {
            //省略一些参数的检查代码

            // Light up custom implementations namely ConfigureHostBuilder which throws.
            if (builder is ISupportsConfigureWebHost supportsConfigureWebHost)
            {
                return supportsConfigureWebHost.ConfigureWebHost(configure, configureWebHostBuilder);
            }

            var webHostBuilderOptions = new WebHostBuilderOptions();
            configureWebHostBuilder(webHostBuilderOptions);
            var webhostBuilder = new GenericWebHostBuilder(builder, webHostBuilderOptions);
            configure(webhostBuilder);
            builder.ConfigureServices((context, services) => services.AddHostedService<GenericWebHostService>());
            return builder;
        }

在ConfigureWebHost中,首先创建一个GenericWebHostBuilder
的对象,然后调用的传入的委托方法,在上一个ConfigureWebHostDefaults方法中,传入的委托方法是

webHostBuilder =>
            {
                WebHost.ConfigureWebDefaults(webHostBuilder);

                configure(webHostBuilder);
            }

委托方法先是调用的静态类WebHost
)
中的ConfigureWebDefaults,然后接着调用上一级传入的委托方法及Program.cs中传入的

webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                }

ConfigureWebHostDefaults

下面概括一下这个扩展方法

  • 添加 ASPNETCORE_ 开头的环境变量
  • 注册 GenericHostService(详见ConfigureWebHost方法), 这个类是IHostService的一个实现,这个类实现了让asp.net core 可以使用 generic host
  • 配置 Kestrel 当作默认Http Server 服务,反向代理伺服器(例如IIS,Nginx,Apache)会把接受http请求,并转发给Kestrel
  • 注册服务HostFilteringStartupFilter
  • 在Windows上启动IIS 集成
  • 注册路由服务

HostBuilder

这是一个非常重要的类,前面我们讲到了CreateDefaultBuilder是用来初始化一个IHostBuilder的实例,这个实例的默认实现就是HostBuilder,前面讲到的所有配置信息都是应用到这个类的实例的,这个类里定义了几个委托的list集合

private List<Action<IConfigurationBuilder>> _configureHostConfigActions = new List<Action<IConfigurationBuilder>>();
private List<Action<HostBuilderContext, IConfigurationBuilder>> _configureAppConfigActions = new List<Action<HostBuilderContext, IConfigurationBuilder>>();
private List<Action<HostBuilderContext, IServiceCollection>> _configureServicesActions = new List<Action<HostBuilderContext, IServiceCollection>>();
private List<IConfigureContainerAdapter> _configureContainerActions = new List<IConfigureContainerAdapter>();

前面我们看到的几乎所有的加载设置,服务之类的都是添加到对应的委托集合中,然后这些委托会在后续的Build方法中被循环调用。

总结

我们今天创建了一个asp.net core 5.0 mvc模板项目,并解释了CreateHostBuilder做的几件事情

  • 创建一个IHostBuilder的实例并加载一些针对generic host的设置,环境变量的添加、json配置文件加载、log等
  • 接着调用ConfigureWebHostDefaults并宿主配置成能asp.net core的程序

接下来的一篇文章我会解释一下Build这个方法。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容