在 EF 上下文中使用 appsettings.json 配置

Question

我应该指出我是 .NET 的新手...

我有以下 appsettings.json 文件：

{
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "ConnectionStrings": {
        "MyContext": "Host=localhost;Database=test;Username=user;Password=''"
    }
}

在 MyContext.cs 文件中，我想从 appsettings.json 配置中读取连接字符串：

using Microsoft.EntityFrameworkCore;
using System;
using System.Configuration;

namespace My.Models
{
  public partial class MyContext : DbContext
  {

  protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
  {
    Console.WriteLine(ConfigurationManager.ConnectionStrings.Count);
    if (!optionsBuilder.IsConfigured)
    {
  optionsBuilder.UseNpgsql(ConfigurationManager.ConnectionStrings["MyContext"].ConnectionString);
    }
  }
}

但是ConfigurationManager.ConnectionStrings["MyContext"].ConnectionString 为空，有什么想法吗？

我通过Configuration.GetConnectionString("MyContext") 在 Startup.cs 中成功使用了配置文件，但在这里我想从该配置中读取连接字符串以用于 ASP.NET 应用程序之外的情况（即在我想要执行的 EF 迁移中） using var db = new MyContext();)，但不知道为什么上面返回 null。

ConfigurationManager 没有从我的 appsettings.json 文件中读取数据吗？不知道如何判断，因为ConfigurationManager.ConnectionStrings.Count 返回 1，所以我很困惑。有什么明显的错误有人可以看到吗？

我正在使用 .NET Core 5 和 EF Core 版本 5

Answer 1

在ef core中定义连接字符串的常用方法是

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseNpgsql(@"Host=localhost;Database=test;Username=user;Password=password");
}

您可以手动访问 IConfiguration：

1. 将此包安装到 ef 项目中

Microsoft.Extensions.Configuration
Microsoft.Extensions.Configuration.Json

1. 构建 IConfiguration

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        IConfigurationRoot configuration = new ConfigurationBuilder()
            .SetBasePath(AppDomain.CurrentDomain.BaseDirectory)
            .AddJsonFile("appsettings.json")
            .Build();
        optionsBuilder.UseNpgsql(configuration.GetConnectionString("DefaultConnection"));
    }

如果你的 Ef 核心在一个特殊的项目中，你必须将 appsetings.json 复制到这个项目中

如果您在查找 appsetings 文件夹时遇到问题，您可以直接定义路径

// .SetBasePath(AppDomain.CurrentDomain.BaseDirectory)
   .AddJsonFile(@"C:\....\appsettings.json")

Answer 2

我假设您正在运行 API 或 Blazor/Razor 应用程序，因为您提到了 Startup.cs 文件:)

在这种情况下，建议 (official docs about this) 是使用 Entity Framework 自己的库在 Startup.ConfigureServices 中设置您的 MyContext。在那里，您可以访问应用程序的 IConfiguration 中的 ConnectionStrings 以及允许您使用特定连接字符串注册 DbContext 的扩展方法。

它可能看起来像这样，只需将我对 Sqlite 的调用调整为您正在使用的任何数据库驱动程序：

public class Startup 
{
  Startup(IConfiguration configuration)
  {
    _configuration = configuration;
  }

  void ConfigureServices(IServiceCollection services) 
  {
    // Other dependencies go here
    string connString = _configuration.GetConnectionString("MyContext");
    services.AddDbContext<MyContext>(opt => opt.UseSqlite(connString));
    // Other dependencies, et cetera
  }
}

这使您可以防止配置逻辑“泄漏”到您的“模型”命名空间中，因此您的MyContext 问题仅与数据的持久性有关，而不是访问系统文件和环境变量。

为了在控制器上使用 MyContext 的实例或由.NET 的依赖注入系统创建的任何其他东西，您需要做的就是在类的构造函数中请求它，比如：

public class MyAwesomeController : ControllerBase
{
  private readonly MyContext _context;

  // This tells .NET to inject an instance of MyContext into your controller
  public MyAwesomeController(MyContext context) 
  {
    _context = context ?? throw new ArgumentNullException();
  }

  // Now all you gotta do is actually use that instance - no matter where it's connecting to
  [HttpGet]
  public Task ListEverything() => _context.MySet.ToListAsync();
}