c# - 创建一个从用户 secret 获取连接字符串的 DbContextFactory

Question

使用 WebApi 处理 DotNetCore 解决方案项目和一个单独的Data包含 Entity Framework 实现的项目。我们一直在升级库，因为我们正在使用所有最新的核心内容。

在Data项目，我们创建了一个 ApplicationDbContextFactory为了创建迁移(需要一个无参数的构造函数)。由于添加迁移时的无参数构造函数约束，您无法注入(inject) IOptions<>轻松访问 appsettings.json值。我们最终使用了 ConfigurationBuilder拉入 WebApi的 appsettings.json文件。

我们最近更改了 ApplicationDbContextFactory也拉进来user-secrets .这允许每个开发人员使用自定义连接字符串，而不必忽略文件或记住不要提交某些内容。

进行此更改后，使用 dotnet ef migrations add MIGRATION_NAME在命令行中工作得很好。但是，使用 add-migration MIGRATION_NAME在 Visual Studio 的程序包管理器控制台中现在似乎因以下错误而中断:

add-migration : Exception calling “Substring” with “1" argument(s): “StartIndex cannot be less than zero. Parameter name: startIndex” At line:1 char:1 + add-migration TESTING + ~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [Add-Migration], MethodInvocationException + FullyQualifiedErrorId : ArgumentOutOfRangeException,Add-Migration

我尝试了该命令的几个变体以查看它是否需要指定上下文(以及其他内容)，但似乎无法解决此错误。它似乎永远不会通过 ApplicationDbContextFactory 中的构造函数.

这是我指的代码:

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Options;
using Models.Domain.Settings;
using System;
using System.Diagnostics;

namespace Data
{
    public class ApplicationDbContextFactory : IDbContextFactory<ApplicationDbContext>
    {
        private readonly SolutionSettings _settings;

        // In order to use 'add-migration' in Visual Studio, you have to have a parameterless constructor.
        // Otherwise you get "No parameterless constructor defined for this object." when creating a migration.
        public ApplicationDbContextFactory()
        {
        }

        public ApplicationDbContextFactory(IOptions<SolutionSettings> settings)
        {
            _settings = settings.Value;
        }

        public ApplicationDbContext Create(DbContextFactoryOptions options)
        {
            // If the IOptions signature was hit, we can just pull the dbconnection from settings
            if (_settings != null && _settings.DbConnection != null)
            {
                var optionsBuilder = new DbContextOptionsBuilder<ApplicationDbContext>()
                    .UseSqlServer(_settings.DbConnection, opts => {
                        opts.EnableRetryOnFailure();
                        opts.MigrationsAssembly("Data");
                    });

                return new ApplicationDbContext(optionsBuilder.Options);
            }
            else
            {
                // Otherwise, we have to get the settings manually...
                return Create(options.ContentRootPath, options.EnvironmentName);
            }
        }

        private ApplicationDbContext Create(string basePath, string environmentName)
        {
            // HACK: To pull from WebApi\appsettings.json
            basePath = basePath.Replace("Data", "WebApi");

            Console.Write($"PATH & ENV: {basePath}, {environmentName}" + Environment.NewLine);

            // Pull in the WebApi\appsettings.json files, apply user secrets
            var builder = new ConfigurationBuilder()
                .SetBasePath(basePath)
                .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
                .AddJsonFile($"appsettings.{environmentName.ToLower()}.json", optional: true, reloadOnChange: true)
                // This needs to match the UserSecretsId value in the WebApi.csproj
                // Also added a UserSecretsId key with the same value to Data.csproj to suppress a warning
                // Adding this was the only way it would actually override values with user-secret values
                .AddUserSecrets("USER_SECRETS_ID")
                .AddEnvironmentVariables();

            var config = builder.Build();
            var connectionString = config["SolutionSettings:DbConnection"];

            Console.Write($"CONNECTION STRING: {connectionString}" + Environment.NewLine);

            return Create(connectionString);
        }

        private ApplicationDbContext Create(string connectionString)
        {
            if (string.IsNullOrEmpty(connectionString))
                throw new ArgumentException(
                    $"{nameof(connectionString)} is null or empty.",
                    nameof(connectionString));

            var optionsBuilder = new DbContextOptionsBuilder<ApplicationDbContext>()
                .UseSqlServer(connectionString, options => {
                    options.EnableRetryOnFailure();
                    options.MigrationsAssembly("Data");
                });

            return new ApplicationDbContext(optionsBuilder.Options);
        }
    }
}

作为旁注；在对此进行故障排除时，我添加了 opts.EnableRetryOnFailure();和 opts.MigrationsAssembly("Data"); ，但我不知道它们在这种情况下有什么不同。

我的问题:

• 这最初是在 Core 的 RC 时代实现的，可能有点过时了。在创建迁移时是否有更好的方法来完成提取用户 secret 值？工厂这么用还是个东西吗？
• 有人知道为什么我们会在 Visual Studio 的包管理器控制台中收到该错误吗？

Answer 1

你发了好久了，但是我刚刚出现这个错误并找到了原因(尽管它没有意义)

问题出在行上

console.Write($"CONNECTION STRING: {connectionString}" + Environment.NewLine);

如果您在 CONNECTION STRING 之后移除冒号，它会起作用。我不知道为什么插值中的冒号会导致此错误