.NET Core源码解析配置文件及依赖注入的示例分析
创始人
2024-11-27 15:22:47
0次
ASP.NET Core启动源码解析

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

.NET Core源码解析配置文件及依赖注入的示例分析

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

/// 
 /// Main方法,程序的入口方法
 /// 
 /// 
 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();// 为Web Host指定了Startup类

3.可以看到asp.net core程序实际上就是一个控制台程序,运行一个webhost对象从而启动一个一直运行的监听http请求的任务。所以我们的重点就是分析一下这个WebHost创建的过程:

创建IWebHostBuilder-》创建IWebHost-》然后运行创建的IWebHost。

4.这里我们从IWebHostBuilder的Build分析下创建的过程,有兴趣的朋友可以看下,没兴趣的朋友可以直接跳到下一个步骤继续阅读。

                1.首先到aspnetcore的github开源地址https://github.com/aspnet/AspNetCore/tree/release/2.1 上去下载源码(我们使用的是2.1)。然后使用vscode打开解压后的文件夹。至于vscode如何加载文件,你可以看我这篇文章使用Visual Studio Code开发.NET Core看这篇就够了 。

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

.NET Core源码解析配置文件及依赖注入的示例分析

                3.通过上面的代码我们可以看到首先是通过BuildCommonServices来构建一个ServiceCollection。为什么说这么说呢,先让我们我们跳转到BuidCommonServices方法中看下吧。

.NET Core源码解析配置文件及依赖注入的示例分析

可以看到,var services = new ServiceCollection();首先new一个ServiceCollection然后往services里面注入很多内容,比如:WebHostOptions ,IHostingEnvironment ,IHttpContextFactory ,IMiddlewareFactory 等等(其实这里已经设计到依赖注入的概念了,先思考下吧),然后我们在后续就可以使用了!最后这个BuildCommonServices就返回了这个services对象。

                4.在上面的依赖注入中有一个方法,不知道大家注意到没有,因为我们在步骤2贴出的代码里面有一个UseStartup() 其实在上面的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中,都做了什么事情吧。

.NET Core源码解析配置文件及依赖注入的示例分析

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

.NET Core源码解析配置文件及依赖注入的示例分析

                7.我们继续导航查看这个方法的内容如下:就是拿到Startup 对象,然后把_applicationServiceCollection 中的对象注入进去。

.NET Core源码解析配置文件及依赖注入的示例分析

                8.至此我们build中注册的对象以及StartUp中注册的对象都已经加入到依赖注入容器中了,接下来就是Run起来了。这个run的代码在src\Hosting\Hosting\src\WebHostExtensions.cs中,代码如下:

.NET Core源码解析配置文件及依赖注入的示例分析

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(Configuration.GetSection("Content"));//注册TOption实例对象

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

6.修改下ContentController这个控制器代码如下:

private readonly Content contents;
 public ContentController(IOptions option)
 {
  contents = option.Value;
 }
 /// 
 /// 首页显示
 /// 
 /// 
 public IActionResult Index()
 {

  return View(new ContentViewModel { Contents=new List { contents} });
 }

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

.NET Core源码解析配置文件及依赖注入的示例分析

8.我们回过头来看我们的Main方法,发现里面有一个CreateDefaultBuilder方法,就是这个方法里面为我们做了一些默认的设置,然后加载我们的配置文件的!

.NET Core源码解析配置文件及依赖注入的示例分析

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

.NET Core源码解析配置文件及依赖注入的示例分析

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。按如下代码进行改造:

/// 
 /// Main方法,程序的入口方法
 /// 
 /// 
 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();// 为Web Host指定了Startup类

.NET Core源码解析配置文件及依赖注入的示例分析

13.然后Startup里面ConfigureServices中的代码修改如下:

.NET Core源码解析配置文件及依赖注入的示例分析

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

.NET Core源码解析配置文件及依赖注入的示例分析

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

.NET Core源码解析配置文件及依赖注入的示例分析

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

依赖注入与控制反转

如果大家仔细阅读文章的话,相信已经看出来了,我上面提到过好几次依赖注入的概念。那么究竟什么是依赖注入呢?下面我们就拿我们上面的ContentController来好好的来理解下。

依赖注入:当一个对象ContentController需要另一个对象Content来协同完成任务的时候,那么这个ContentController就对这个Content对象产生了依赖关系。那么在这个ContentController中,是怎么注入的呢?就是从控制器中注入的了,如下图所示:

.NET Core源码解析配置文件及依赖注入的示例分析

从asp.net 转过来的你是不是想起了之前的千篇一律的new对象啊。没对象自己new(要是女朋友也能new多好啊……)当然除了单例对象,静态哈。

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

那么什么是控制反转呢?你上面看到没有,你自己new对象就是正转,因为你自己创建自己所要使用的对象,。那么这种不需要你自己new对象,而是直接传进来就是控制反转了。(不知道比喻的恰不恰当哈)

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

什么是容器呢?

这里创建IOptions option 这个对象的东西就是容器。还记得上面我们分析源码的时候,IServiceCollection 里面注入了很多东西吗?其实就是往IServiceCollection 这个容器里面注入方法,这样其他地方使用的时候就能自动注入了。

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

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

  • Transient: 每一次访问都会创建一个新的实例

  • Scoped: 在同一个Scope内只初始化一个实例 ,可以理解为( 每一个request级别只创建一个实例,同一个http request会在一个 scope内)

  • Singleton :整个应用程序生命周期以内只创建一个实例

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素,包括空调的型号、功率、使用环境和维护情况等。一般来说,空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异,但一般来说,除湿...
格力空调多长时间加一次氟利昂 1、一般情况下,空调对氟利昂的使用量是非常小的,所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时,空调才需要加氟。1、空调的室内机和室外机各有两个接口,当接...
格调生活·C标思享荟:卡萨帝在... 9月12日的郑州龙湖金融岛,夜风轻拂,灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日,“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新,需要考虑多个因素,以下是一些建议:1. 维修成本:如果维修费用较低,比如 ...
空调开多久需要休息多长时间 问题:空调开多久需要休息多长时间回答:1、在使用空调的过程中,一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可,空调开机中间时段再清洗一次,空调关机时清洗一次,这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度,很多人的观点认为氟利昂必须一年放一次,其实这个观点是错误的,理解上面有点偏差,...