ASP.NET Core利用选项方式读取配置

第一步 ：新建ASP.NET Core webapi项目

第二步：安装Microsoft.Extensions.Options和Microsoft.Extensions.Configuration.Binder

第三步：修改appsettings.json，内容如下：

1. {
2.   "Logging": {
3.     "LogLevel": {
4.       "Default": "Information",
5.       "Microsoft.AspNetCore": "Warning"
6.     }
7.   },
8.   "DB": {
9.     "DbType": "SQLServer",
10.     "Connection": "Data Source = .Catalog=DemoDB; Integrated Security = true"
11.   },
12.   "Smtp": {
13.     "Server": "smtp.youzack.com",
14.     "UserName": "zack",
15.     "Password": "hello888",
16.   },
17.     "AllowedHosts": "*"
18.   }

复制代码

第四步：由于我们只读取配置系统中“DB”和“Smtp”这两部分，建立对应的模型类，代码如下：

1. public class DbSettings
2. {
3.     public string? DbType { get; set; }
4.     public string? ConnectionString { get; set; }
6. }

复制代码

1. public class SmtpSettings
2. {
3.      public string? Server { get; set; }
4.      public string? UserName { get; set; }
5.      public string? Password { get; set; }
6. }

复制代码

由于利用选项方式读取配置的时间，需要和依赖注入一起利用，因此我们需要创建一个类用于获取注入的选项值。声明接收选项注入的对象的范例不能直接利用DbSettings、SmtpSettings，而要利用IOptions、IOptionsMonitor、IOptionsSnapshot等泛型接口范例，由于它们可以帮我们处理容器生命周期、配置刷新等。它们的区别在于，IOptions在配置改变后，我们不能读到新的值，必须重启程序才可以读到新的值；IOptionsMonitor在配置改变后，我们能读到新的值；IOptionsSnapshot也是在配置改变后，我们能读到新的值，和IOptionsMonitor不同的是，在同一个范围内IOptionsMonitor会保持划一性。

编写读取配置的Demo代码 如下：

1. public class Demo
2. {
3.      private readonly IOptionsSnapshot<DbSettings> optDbsettings;
4.      private readonly IOptionsSnapshot<SmtpSettings> optSmtpSettings;
6.      public Demo(IOptionsSnapshot<DbSettings> optDbsettings, IOptionsSnapshot<SmtpSettings> optSmtpSettings)
7.      {
8.          this.optDbsettings = optDbsettings;
9.          this.optSmtpSettings = optSmtpSettings;
10.      }
13.      public void Test()
14.      {
15.          var db = optDbsettings.Value;
16.          Console.WriteLine($"数据库：{db.DbType},{db.ConnectionString}");
17.          var smtp = optSmtpSettings.Value;
18.          Console.WriteLine($"smtp:{smtp.Server},{smtp.UserName},{smtp.Password}");
19.      }
21. }

复制代码

注册服务到容器

1. var configurationBuilder = new ConfigurationBuilder();
2. configurationBuilder.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);
3. IConfigurationRoot config = configurationBuilder.Build();
4. ServiceCollection services = new ServiceCollection();
5. services.AddOptions().Configure<DbSettings>(e => config.GetSection("DB").Bind(e))
6.      .Configure<SmtpSettings>(e => config.GetSection("Smtp").Bind(e));
7. services.AddTransient<Demo>();
8. using (var sp = services.BuildServiceProvider())
9. {
10.      while (true)
11.      {
12.          using (var scope = sp.CreateScope())
13.          {
14.              var spScope = scope.ServiceProvider;
15.              var demo = spScope.GetRequiredService<Demo>();
16.              demo.Test();
17.          }
18.          Console.WriteLine("可以修改配置了");
19.          Console.ReadKey();
20.      }
21. }

复制代码

运行exe
![[assets/ASP.NET Core利用选项方式读取配置/file-20250308123308971.png]]
修改配置文件保存
![[assets/ASP.NET Core利用选项方式读取配置/file-20250308123433037.png]]

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。