一般来说,Asp .NetCore 应用从官方默认的appsetting.json文件中读取就好,而且利用option模式中的 IOptionsSnapSot<T>、IOptionsMonitor<T>可以动态加载配置,你可以直接修稿json文件来保证。但是这样也有一定的不方便之处:你的配置放在单个json文件,加入你的为服务项目有10个,如果因为项目需求变了,要更改配置,就要到10个json文件中修改,而如果这10个项目的配置都在一个数据库中,那么只需一个脚本就能改好了。
不过要从数据库动态同步加载需要做一些额外的工作,本节就先介绍静态加载数据库配置。
目录
2.3 配置ConfigureAppConfiguration
1.搭建基本框架
由于这里不是重点,因此只是简单的介绍关键步骤,如果有不懂的具体可以看此.NET 6.0 - Connect to MySQL Database with Entity Framework Core,有详细讲解。
a. 创建asp .netcore 项目
可以创建webApi项目也可以创建MVC项目。由于使用的是MySql和EFcore,因为项目要添加下面三个包:
Pomelo.EntityFrameworkCore.MySql
Microsoft.EntityFrameworkCore
Microsoft.EntityFrameworkCore.Tools
b.创建实体类,数据文上下文类
实体类保存我们要的配置信息,参考json文件,我们保存为Key-Value模式:
public class ConfigurationEntity
{
[Key]
public string Key { get; set; }
public string Value { get; set; }
}
然后创建数据库上下文类:
public class ConfigurationDbContext:DbContext
{
public ConfigurationDbContext(DbContextOptions options):base(options) { }
public DbSet<ConfigurationEntity>? configurationEntities { get; set; }
}
c.添加数据库连接信息
一般情况我们可以将数据库的链接配置放到appsettings.json文件中,不过有时候我们不想让用户修改,可以放到机密文件中,机密文件(secret.json)也是asp框架下默认的读取文件之一,其加载顺序在appsettings.json之后,也就是如果你在两个json中都配置了ConnectionString,根据后来居上的法则,secret.json会生效。具体操作如下:
在解决方案资源管理器窗口,在你当前项目上右键,弹出菜单中选择“管理用户机密”
选择之后就会弹出secrets.json 编辑页面,和appsettings.json同样配置即可:
然后就可以将我们的数据库上下文类(DbContex)配置到服务中:
builder.Services.AddDbContext<ConfigurationDbContext>(opts =>
opts.UseMySql(ConnectionString, ServerVersion.AutoDetect(ConnectionString)));
d.迁移、更新数据库
编译项目所在的整个解决方案,没有bug后(这点很重要,否则会迁移报错),先迁移数据,
“迁移”(migration)是指根据实体类,生成数据库表的操作,迁移在Code First(模型驱动开发)很常见,区别于早期的先在数据库建表的“数据驱动开发”(Database First).
EFCore迁移很简单:执行命令:
Add-Migration InitXXXXX
执行没问题后,执行更新数据库命令:
Update-Database
你就会在你链接的数据库上看到你新建的表,表名为你ConnectionStrings中定义。
2.编写自定义配置源
asp.net core官方不支持直接从数据库中读取配置,所以这里我们要自定义配置。而自定义配置都需要实现IConfigurationProvider接口,也就是真正将数据库的字段构建成Dictionary<>。一般我笨都直接集成ConfigurationProvider这个抽象类,ConfigurationProvider中最重要的方法就是Load,自定义配置提供者要实现Load方法来加载配置数据,返回的就是IDictionary<string,string>,这个字典保存在“Data”属性中,而且还遵循“多层级数据扁平化“规范,如果配置发生了改变,则需要调用ReLoad方法来通知监听配置改变的代码。
2.1 实现ConfigurationProvider类
public class EFConfigurationProvider:ConfigurationProvider
{
public Action<DbContextOptionsBuilder> _optionsAction;
public EFConfigurationProvider(Action<DbContextOptionsBuilder> optionsAction)
{
_optionsAction = optionsAction;
}
public override void Load()
{
var builder = new DbContextOptionsBuilder<ConfigurationDbContext>();
_optionsAction(builder);
using var dbContext = new ConfigurationDbContext(builder.Options);
dbContext.Database.EnsureCreated();
Data=!dbContext.configurationEntities!.Any()
?CreateAndSaveDefaultValues(dbContext):dbContext.configurationEntities?.ToDictionary(c=>c.Key,c=>c.Value);
}
private static IDictionary<string,string> CreateAndSaveDefaultValues(ConfigurationDbContext context)
{
var configValues = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
{
{ "Pages:HomePage:WelcomeMessage", "Welcome to the ProjectConfigurationDemo Home Page" },
{ "Pages:HomePage:ShowWelcomeMessage", "true" },
{ "Pages:HomePage:Color", "black" },
{ "Pages:HomePage:UseRandomTitleColor", "true" }
};
context.configurationEntities?.AddRange(configValues.Select(kvp => new ConfigurationEntity
{
Key = kvp.Key,
Value = kvp.Value
}).ToArray());
context.SaveChanges();
return configValues;
}
}
简单说一下,在构造函数中,需要传递一个Action<DbContextOptionsBuilder>对象,因为我们要在Load函数中链接数据库,所以需要提供连接数据的的信息,当然可以直接加载:
public class EFConfigurationProvider2 : ConfigurationProvider
{
private readonly IConfiguration _configuration;
public EFConfigurationProvider2(IConfiguration configuration)
{
_configuration = configuration;
}
public override void Load()
{
using var dbContext = new ConfigurationDbContext(CreateDbContextOptions());
dbContext.Database.EnsureCreated();
Data = !dbContext.configurationEntities!.Any()
? CreateAndSaveDefaultValues(dbContext) : dbContext.configurationEntities?.ToDictionary(c => c.Key, c => c.Value);
}
private DbContextOptions<ConfigurationDbContext> CreateDbContextOptions()
{
var connectionString = _configuration.GetConnectionString("MySql");
return new DbContextOptionsBuilder<ConfigurationDbContext>()
.UseMySql(connectionString, ServerVersion.AutoDetect(connectionString)).Options;
}
private static IDictionary<string, string> CreateAndSaveDefaultValues(ConfigurationDbContext context)
{
var configValues = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
{
{ "Pages:HomePage:WelcomeMessage", "Welcome to the ProjectConfigurationDemo Home Page" },
{ "Pages:HomePage:ShowWelcomeMessage", "true" },
{ "Pages:HomePage:Color", "black" },
{ "Pages:HomePage:UseRandomTitleColor", "true" }
};
context.configurationEntities?.AddRange(configValues.Select(kvp => new ConfigurationEntity
{
Key = kvp.Key,
Value = kvp.Value
}).ToArray());
context.SaveChanges();
return configValues;
}
}
本质就是,需要将数据库的链接信息传递到DbContextOptions<ConfigurationDbContext> ,以供
ConfigurationDbContext使用。
在Load函数中,我们会判断数据中是否有数据,如果没有,则添加一点默认数据,否则加载新的数据并转化为字典类型。
2.2 ConfigurationSource
有了配置提供者,我们就能编写配置源,服务加载不同的配置总是加载不同的配置源而不是配置提供者,IConfigurationSource中要实现Builder方法返回的就是IConfigurationProvider.
public class EFConfigurationSource : IConfigurationSource
{
private readonly Action<DbContextOptionsBuilder> _optionsAction;
public EFConfigurationSource(Action<DbContextOptionsBuilder> optionsAction)
{
_optionsAction = optionsAction;
}
public IConfigurationProvider Build(IConfigurationBuilder builder)
{
return new EFConfigurationProvider(_optionsAction);
}
}
2.3 配置ConfigureAppConfiguration
一切就绪,我们在ConfigureAppConfiguration配置,也就是将我们编写的配置源加载进去
var builder = WebApplication.CreateBuilder(args);
var ConnectionString = builder.Configuration.GetConnectionString("MySql");
builder.Host.ConfigureAppConfiguration((_, configBuilder) =>
{
var config = configBuilder.Build();
var configSource = new EFConfigurationSource(opts =>
opts.UseMySql(ConnectionString, ServerVersion.AutoDetect(ConnectionString)));
configBuilder.Add(configSource);
});
至此,在执行:
var app = builder.Build();
后,配置中就能使用读取了数据库的配置了,不过在这里,我们要删除下面的代码,因为已经不需要了:
//builder.Services.AddDbContext<ConfigurationDbContext>(opts =>
// opts.UseMySql(ConnectionString, ServerVersion.AutoDetect(ConnectionString)));
运行后就发现,数据库中多了一些我们在CreateAndSaveDefaultValues函数中提供的默认几组数据:
为了进一步验证读取,我们又加了两条数据,并根据配置扁平化处理,用“:”隔开,这样等价于appsettings.json中:
"Wang":{
"Age":23,
"Name":"xiao wang"
}
然后对应的实体类:
public class Student
{
public string? Name { get; set; }
public int Age { get; set; }
}
最后读取,并打印:
var app = builder.Build();
var wang = app.Services.GetRequiredService<IOptions<Student>>().Value;
Console.WriteLine($"{wang.Name}---{wang.Age}");
控制台上就有了我们要的数据。
至此从数据库加载数据的基本操作就完成了,其实从数据库中家在配置,在官方文档中有详细教程:Custom configuration provider,不过这个教程也没有实现动态更新配置,根据前面绿色背景的文字,倒是提供了思路,我在下一节将实现动态更新配置。