.NET Core实战项目之CMS 第三章 入门篇-源码解析配置文件及依赖注入

做者：依乐祝
原文连接：http://www.javashuo.com/article/p-hmpbfpjc-cd.html

写在前面

上篇文章我给你们讲解了ASP.NET Core的概念及为何使用它，接着带着你一步一步的配置了.NET Core的开发环境并建立了一个ASP.NET Core的mvc项目，同时又经过一个实战教你如何在页面显示一个Content的列表。不知道你有没有跟着敲下代码，千万不要作眼高手低的人哦。这篇文章咱们就会设计一些复杂的概念了，由于要对ASP.NET Core的启动及运行原理、配置文件的加载过程进行分析，依赖注入，控制反转等概念的讲解等。俗话说，授人以鱼不如授人以渔，因此文章旨在带着你们分析源码，让你们能知其然更能知其因此然。为了偷懒，继续使用上篇文章的例子了！有兴趣的朋友能够加群637326624相互交流！
再次感谢张队的审稿！

本文已收录至.NET Core实战项目之CMS 第一章 入门篇-开篇及整体规划 点击能够查看更多教程。

ASP.NET Core启动源码解析

这部分我就带着你们一块儿看下asp.net core项目的运行流程吧！顺带着了解下asp.net core的运行原理，说的很差的话，但愿你们给以指正，从而可以正确的帮助更多的人。

1. 首先上一下上篇文章的项目结构吧，以下所示，熟悉C#的朋友应该知道，要找程序的入库，那么就应该找到Main方法。而asp.net core的main方法就在Program.cs文件中。

2. 打开后看到以下的代码，我加了注释，大伙将就看下，下面咱们来一步一步的分析

   /// <summary>
           /// Main方法，程序的入口方法
           /// </summary>
           /// <param name="args"></param>
           public static void Main(string[] args)
           {
               CreateWebHostBuilder(args)//调用下面的方法，返回一个IWebHostBuilder对象
                   .Build()//用上面返回的IWebHostBuilder对象建立一个IWebHost
                   .Run();//运行上面建立的IWebHost对象从而运行咱们的Web应用程序换句话说就是启动一个一直运行监听http请求的任务
           }
   
           public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
               WebHost.CreateDefaultBuilder(args)//使用默认的配置信息来初始化一个新的IWebHostBuilder实例
                   .UseStartup<Startup>();// 为Web Host指定了Startup类

   能够看到asp.net core程序实际上就是一个控制台程序，运行一个webhost对象从而启动一个一直运行的监听http请求的任务。因此咱们的重点就是分析一下这个WebHost建立的过程：
   建立IWebHostBuilder-》建立IWebHost-》而后运行建立的IWebHost。

3. 这里咱们从IWebHostBuilder的Build分析下建立的过程，有兴趣的朋友能够看下，没兴趣的朋友能够直接跳到下一个步骤继续阅读。

   1. 首先到aspnetcore的github开源地址https://github.com/aspnet/AspNetCore/tree/release/2.1 上去下载源码（咱们使用的是2.1）。而后使用vscode打开解压后的文件夹。至于vscode如何加载文件，你能够看我这篇文章使用Visual Studio Code开发.NET Core看这篇就够了 固然你也能够在上面的网页上直接找到相应的目录浏览也是能够的。（看结构好像是使用vscode进行开发的）

   2. 根据IWebHostBuilder的命名空间咱们找到了它的实现，路径为src/Hosting/Hosting/src/WebHostBuilder.cs

   3. 经过上面的代码咱们能够看到首先是经过BuildCommonServices来构建一个ServiceCollection。为何说这么说呢，先让咱们咱们跳转到BuidCommonServices方法中看下吧。

      能够看到，var services = new ServiceCollection();首先new一个ServiceCollection而后往services里面注入不少内容，好比：WebHostOptions ，IHostingEnvironment ，IHttpContextFactory ，IMiddlewareFactory 等等（其实这里已经设计到依赖注入的概念了，先思考下吧），而后咱们在后续就可使用了！最后这个BuildCommonServices就返回了这个services对象。

   4. 在上面的依赖注入中有一个方法，不知道你们注意到没有，由于咱们在步骤2贴出的代码里面有一个UseStartup<Startup>() 其实在上面的BuildCommonServices方法中也有对IStartup的注入的。首先，判断Startup类是否继承于IStartup接口，若是是继承的，那么就能够直接加入在services 里面去，若是不是继承的话，就须要经过ConventionBasedStartup(methods)把method转换成IStartUp后注入到services里面去。结合上面咱们的代码，貌似咱们平时用的时候注入的方式都是采用后者。

   5. 咱们再回到build方法拿到了BuildCommonServices方法构建的ServiceCollection实例后，经过GetProviderFromFactory(hostingServices) 方法构造出了IServiceProvider 对象。到目前为止，IServiceCollection和IServiceProvider都拿到了。而后根据IServiceCollection和IServiceProvider对象构建WebHost对象。构造了WebHost实例还不能直接返回，还须要经过Initialize对WebHost实例进行初始化操做。那咱们看看在初始化函数Initialize中，都作了什么事情吧。

   6. 这里咱们把代码导航到src/Hosting/Hosting/src/Internal/WebHost.cs找到Initialize方法。以下图所示：主要就是一个EnsureApplicationServices 方法。

   7. 咱们继续导航查看这个方法的内容以下：就是拿到Startup 对象，而后把_applicationServiceCollection 中的对象注入进去。

   8. 至此咱们build中注册的对象以及StartUp中注册的对象都已经加入到依赖注入容器中了，接下来就是Run起来了。这个run的代码在src\Hosting\Hosting\src\WebHostExtensions.cs中，代码以下：WebHost执行RunAsync运行web应用程序并返回一个只有在触发或关闭令牌时才完成的任务（这里又涉及到异步编程的知识了，我们之后再详细讲解） 。这就是咱们运行ASP.Net Core程序的时候，看到的那个命令行窗口了，若是不关闭窗口或者按Ctrl+C的话是没法结束的。

   9. 至此启动的过程的源码分析完成了。

   配置文件

   上面给你们介绍了ASP.NET Core的启动过程，中间牵扯到了一些依赖注入的概念。关于依赖注入的概念呢，咱们后面再说，这里先给你们讲解下配置文件的加载过程。

4. 打开上篇文章咱们建立的项目，并在appsettings.json里面加入以下内容：

   {
     "Logging": {
       "LogLevel": {
         "Default": "Warning"
       }
     },
     "Content": {
       "Id": 1,
       "title": "title1",
       "content": "content1",
       "status": 1,
       "add_time": "2018-11-21 16:29",
       "modify_time": null
     },
     "AllowedHosts": "*"
   }

5. 而后在Startup类中ConfigureServices中注册TOptions对象以下所示：

   services.Configure<Content>(Configuration.GetSection("Content"));//注册TOption实例对象

   这段代码也就是从appsettings.json这个配置文件中的Content这个节点匹配到Content这个对象上。

6. 修改下ContentController这个控制器代码以下：

   private readonly Content contents;
           public ContentController(IOptions<Content> option)
           {
               contents = option.Value;
           }
           /// <summary>
           /// 首页显示
           /// </summary>
           /// <returns></returns>
           public IActionResult Index()
           {
   
               return View(new ContentViewModel { Contents=new List<Content> { contents} });
           }

7. 按下F5运行下，而后导航到Content目录看到以下页面：说明成功从appsettings.json这个文件中加载了内容。这一切是怎么发生的呢？下面咱们就一步一步的来分析。

8. 咱们回过头来看咱们的Main方法，发现里面有一个CreateDefaultBuilder方法，就是这个方法里面为咱们作了一些默认的设置，而后加载咱们的配置文件的！

9. 咱们在源码里面找到CreateDefaultBuilder 的源码（反正我找了半天，起初在Hosting下面找，实际上在MetaPackages下面的），位置在src\MetaPackages\src\Microsoft.AspNetCore\WebHost.cs 有的人可能找不到哦，能够看到这个方法会在ConfigureAppConfiguration 的时候默认加载appsetting文件，并作一些初始的设置，因此咱们不须要任何操做，就能加载appsettings 的内容了。

10. 既然知道了原理后，咱们就试着重写下这个ConfigureAppConfiguration 而后加载咱们自定义的json文件吧。

11. 鼠标右键新建一个Content.json文件，而后输入以下的内容：

    {
      "ContentList": 
        {
          "Id": 1,
          "title": "title1 from diy json",
          "content": "content1 from diy json",
          "status": 1,
          "add_time": "2018-11-21 16:29",
          "modify_time": null
        }
    
    }

12. 而后打开Program.cs。按以下代码进行改造：

    /// <summary>
            /// Main方法，程序的入口方法
            /// </summary>
            /// <param name="args"></param>
            public static void Main(string[] args)
            {
                CreateWebHostBuilder(args)//调用下面的方法，返回一个WebHostBuilder对象
                    .Build()//用上面返回的WebHostBuilder对象建立一个WebHost
                    .Run();//运行上面建立的WebHost对象从而运行咱们的Web应用程序换句话说就是启动一个一直运行监听http请求的任务
            }
    
            public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
                WebHost.CreateDefaultBuilder(args)//使用默认的配置信息来初始化一个新的IWebHostBuilder实例
                .ConfigureAppConfiguration((hostingContext, config) =>
                {
                    var env = hostingContext.HostingEnvironment;
    
                    config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                          .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true)
                          .AddJsonFile("Content.json",optional:false,reloadOnChange:false)
                          .AddEnvironmentVariables();
    
                })
                .UseStartup<Startup>();// 为Web Host指定了Startup类

13. 而后Startup里面ConfigureServices中的代码修改以下：

14. 而后按下F5运行下代码吧，以下图所示，从咱们最新添加的json文件中加载出来数据了。

15. 这里多讲一点，传统asp.net的web.config文件若是有更改的话是必需要重启站点才能使，配置文件生效的，可是asp.net core的配置文件是支持热更新的，及不重启网站也能加载更新，只须要设置一下属性便可，以下图所示：

16. 配置文件的源码解读这块就到这里了。下面开始依赖注入的讲解。

依赖注入与控制反转

若是你们仔细阅读文章的话，相信已经看出来了，我上面提到过好几回依赖注入的概念。那么究竟什么是依赖注入呢？下面咱们就拿咱们上面的ContentController来好好的来理解下。
依赖注入：当一个对象ContentController须要另外一个对象Content来协同完成任务的时候，那么这个ContentController就对这个Content对象产生了依赖关系。那么在这个ContentController中，是怎么注入的呢？就是从控制器中注入的了，以下图所示：

从asp.net 转过来的你是否是想起了以前的千篇一概的new对象啊。没对象本身new（要是女友也能new多好啊……）固然除了单例对象，静态哈。

这里又设计一个概念就是控制反转。

那么什么是控制反转呢？你上面看到没有，你本身new对象就是正转，由于你本身建立本身所要使用的对象，。那么这种不须要你本身new对象，而是直接传进来就是控制反转了。（不知道比喻的恰不恰当哈）

依赖注入与控制反转你是否已经了解了呢，喜欢思考的朋友可能会问了，那这个构造函数里面的IOptions<Content> option 又是怎么出来的？这里就要引入一个容器的概念了。

什么是容器呢？

这里建立IOptions<Content> option 这个对象的东西就是容器。还记得上面咱们分析源码的时候，IServiceCollection 里面注入了不少东西吗？其实就是往IServiceCollection 这个容器里面注入方法，这样其余地方使用的时候就能自动注入了。

这就是容器的好处，由容器来统一管理实例的建立和销毁，你只须要关心怎么用就好了，不须要关心怎么建立跟销毁。

固然容器建立的实例都是有生命周期的，。下面罗列一下，就不过多的讲解了。

• Transient： 每一次访问都会建立一个新的实例
• Scoped： 在同一个Scope内只初始化一个实例 ，能够理解为（ 每个request级别只建立一个实例，同一个http request会在一个 scope内）
• Singleton ：整个应用程序生命周期之内只建立一个实例

使用的方式也很简单，我会在接下来的课程中详细的经过实例来进行讲解!由于如今的例子还没发演示。

总结

本文一步一步带着你先分析了ASP.NET Core的启动过程及运行的原理，紧接着给你讲了配置文件的加载过程及原理，并经过示例代码演示了如何加载自定义的配置文件，最后引出了依赖注入以及控制反转的概念，并经过对咱们上面例子的分析来紧身对依赖注入以及控制反转的理解。至此让你知其然更知其因此然。对ASP.NET Core的原理相信你已经了然于胸了！有问题的小伙伴能够加群637326624讨论。那么接下来让咱们再准备下dapper,vue以及git的快速入门就开始咱们的asp.net core cms的实战课程吧！仍是那句话基础很重要，基础打好，后面才能事半功倍。谢谢你们。