Injecting Env Conn String в .NET Core 2.0 w/EF Core DbContext в разных классах lib, чем Startup prj и реализация IDesignTimeDbContextFactory

Я, честно говоря, не могу поверить, насколько это сложно... Прежде всего, требования, к которым я иду:

Я хотел бы использовать шаблон IOptions, поэтому я создал этот класс:

А затем попытался изменить мою реализацию IDesignTimeDbContextFactory<AppContext> на:

К сожалению, это не работает, потому что Ioptions<AppSettings> аргумент public DesignTimeDbContextFactory(IOptions<AppSettings> appSettings) конструктор не вводили. Я предполагаю, что это потому, что реализации IDesignTimeDbContextFactory<AppContext> вызываются во время разработки, а внедрение зависимостей просто не "готово" в приложениях .NET Core во время разработки?

Мне кажется странным, что так сложно внедрить строку подключения для конкретной среды, используя шаблон Entity Framework Core 2.0 для реализации IDesignTimeDbContextFactory, а также не нужно копировать и загружать файлы настроек, такие как appsettings.json более одного раза.

Ответы

Ответ 1

Если вы ищете решение для получения строки подключения к базе данных из вашего класса пользовательских настроек, инициализированного из файла appsettings.json, - вот как вы можете это сделать. К сожалению, вы не можете внедрить IOptions через DI в свой IDesignTimeDbContextFactory реализации IDesignTimeDbContextFactory.

public class DesignTimeDbContextFactory : IDesignTimeDbContextFactory<AppContext>
{
   public AppContext CreateDbContext(string[] args)
   {
       // IDesignTimeDbContextFactory is used usually when you execute EF Core commands like Add-Migration, Update-Database, and so on
       // So it is usually your local development machine environment
       var envName = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");

       // Prepare configuration builder
       var configuration = new ConfigurationBuilder()
           .SetBasePath(Path.Combine(Directory.GetCurrentDirectory()))
           .AddJsonFile("appsettings.json", optional: false)
           .AddJsonFile($"appsettings.{envName}.json", optional: false)
           .Build();

       // Bind your custom settings class instance to values from appsettings.json
       var settingsSection = configuration.GetSection("Settings");
       var appSettings = new AppSettings();
       settingsSection.Bind(appSettings);

       // Create DB context with connection from your AppSettings 
       var optionsBuilder = new DbContextOptionsBuilder<AppContext>()
           .UseMySql(appSettings.DefaultConnection);

       return new AppContext(optionsBuilder.Options);
   }
}

Конечно, в вашем классе AppSettings и appsettings.json вас может быть еще более изощренная логика построения строки соединения. Например, вот так:

public class AppSettings
{
   public bool UseInMemory { get; set; }

   public string Server { get; set; }
   public string Port { get; set; }
   public string Database { get; set; }
   public string User { get; set; }
   public string Password { get; set; }

   public string BuildConnectionString()
   {
       if(UseInMemory) return null;

       // You can set environment variable name which stores your real value, or use as value if not configured as environment variable
       var server = Environment.GetEnvironmentVariable(Host) ?? Host;
       var port = Environment.GetEnvironmentVariable(Port) ?? Port;
       var database = Environment.GetEnvironmentVariable(Database) ?? Database;
       var user = Environment.GetEnvironmentVariable(User) ?? User;
       var password = Environment.GetEnvironmentVariable(Password) ?? Password;

       var connectionString = $"Server={server};Port={port};Database={database};Uid={user};Pwd={password}";

       return connectionString;
   }
}

Только значения хранятся в appsettings.json:

{
  "Settings": {
    "UseInMemory": false,
    "Server": "myserver",
    "Port": "1234",
    "Database": "mydatabase",
    "User": "dbuser",
    "Password": "dbpassw0rd"
  }
}

С паролем и пользователем, хранящимся в переменных среды:

{
  "Settings": {
    "UseInMemory": false,
    "Server": "myserver",
    "Port": "1234",
    "Database": "mydatabase",
    "User": "MY-DB-UID-ENV-VAR",
    "Password": "MY-DB-PWD-ENV-VAR"
  }
}

В этом случае вы должны использовать это так:

// Create DB context with connection from your AppSettings 
var optionsBuilder = new DbContextOptionsBuilder<AppContext>();
if(appSettings.UseInMemory) {
optionsBuilder = appSettings.UseInMemory
   ? optionsBuilder.UseInMemoryDatabase("MyInMemoryDB")
   : optionsBuilder.UseMySql(appSettings.BuildConnectionString());

return new AppContext(optionsBuilder.Options);

Ответ 2

Я немного запутался с вашим вопросом. Используете ли вы инъекцию зависимостей для DbContext или вы пытаетесь инициализировать и конструировать контекст ad hoc?

Я делаю то, что вы описали в одном из моих решений. Вот моя структура решения:

Corp.ApplicationName.Data
Corp.ApplicationName.Web

Startup.cs

public Startup(IHostingEnvironment env)
{
    IConfigurationBuilder builder = new ConfigurationBuilder()
        .SetBasePath(env.ContentRootPath)
        .AddJsonFile("appsettings.json", false, true)
        .AddJsonFile($"appsettings.{env.EnvironmentName}.json")
        .AddEnvironmentVariables();
    // ...
}

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddDbContext<MyDbContext>(
        options => options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"),
        sqlOptions => sqlOptions.EnableRetryOnFailure()));

    // SQL configuration for non-injected dbcontext
    DbContextOptionsBuilder<MyDbContext> builder = new DbContextOptionsBuilder<MyDbContext>();
    builder.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"));
    services.AddSingleton(builder.Options);

    // ...
}

MyDbContext.cs

public class MyDbContext : IdentityDbContext<ApplicationUser>
{
    public MyDbContext(DbContextOptions options) : base(options) { }
}

Если вы не используете внедрение зависимостей для передачи DbContext, вы можете получить доступ к свойствам SQL, DbContextOptions<MyDbContext> вместо этого DbContextOptions<MyDbContext>.

В этом примере файл appsettings выполняется только каждый раз, и все просто работает.