WebAPI启动时一次性执行默认用户初始化的实现方案问询

方案概述 #

将初始化逻辑抽离到独立类中，利用IServiceScopeFactory在类内部创建作用域来使用Scoped服务，最后在Program.cs中仅保留简洁的调用代码，确保初始化仅在启动时执行一次。

步骤1：创建独立的初始化类 #

新建专门处理默认用户初始化的类，注入单例的IServiceScopeFactory来创建Scoped作用域，从而获取DbContext等Scoped服务：

public class DefaultUserInitializer
{
    private readonly IServiceScopeFactory _scopeFactory;

    public DefaultUserInitializer(IServiceScopeFactory scopeFactory)
    {
        _scopeFactory = scopeFactory;
    }

    // 异步初始化方法（推荐，避免阻塞启动线程）
    public async Task InitializeAsync()
    {
        using var scope = _scopeFactory.CreateScope();
        var dbContext = scope.ServiceProvider.GetRequiredService<WeatherDbContext>();

        // 检查默认用户是否存在
        var defaultUser = await dbContext.Users
            .FirstOrDefaultAsync(u => u.UserName.Equals("admin", StringComparison.OrdinalIgnoreCase));

        if (defaultUser == null)
        {
            // 创建默认用户（注意：密码需用加密算法处理，例如ASP.NET Core Identity的PasswordHasher）
            var newUser = new User
            {
                UserName = "admin",
                Email = "admin@example.com",
                PasswordHash = new PasswordHasher<User>().HashPassword(null, "YourStrongPassword123!")
            };

            dbContext.Users.Add(newUser);
            await dbContext.SaveChangesAsync();
        }
    }

    // 同步版本（无需异步操作时使用）
    public void Initialize()
    {
        using var scope = _scopeFactory.CreateScope();
        var dbContext = scope.ServiceProvider.GetRequiredService<WeatherDbContext>();

        var defaultUser = dbContext.Users
            .FirstOrDefault(u => u.UserName.Equals("admin", StringComparison.OrdinalIgnoreCase));

        if (defaultUser == null)
        {
            var newUser = new User
            {
                UserName = "admin",
                Email = "admin@example.com",
                PasswordHash = new PasswordHasher<User>().HashPassword(null, "YourStrongPassword123!")
            };

            dbContext.Users.Add(newUser);
            dbContext.SaveChanges();
        }
    }
}

步骤2：注册初始化类到服务容器 #

在Program.cs的服务注册阶段，将DefaultUserInitializer注册为单例服务（仅依赖单例的IServiceScopeFactory，无需多次实例化）：

var builder = WebApplication.CreateBuilder(args);

// 注册DbContext等其他服务
builder.Services.AddDbContext<WeatherDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));

// 注册初始化类为单例
builder.Services.AddSingleton<DefaultUserInitializer>();

// 其他服务注册...

步骤3：在Program.cs中调用初始化逻辑 #

在应用构建完成后、启动之前，获取初始化类实例并执行初始化方法（确保初始化完成后再处理请求）：

var app = builder.Build();

// 配置中间件（路由、授权、Swagger等）
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

// 执行默认用户初始化
var initializer = app.Services.GetRequiredService<DefaultUserInitializer>();
await initializer.InitializeAsync(); // 同步场景调用initializer.Initialize();

app.Run();

可选：用扩展方法进一步简化调用 #

若想让Program.cs代码更简洁，可创建扩展方法封装初始化逻辑：

public static class ApplicationInitializerExtensions
{
    public static async Task InitializeDefaultUserAsync(this IApplicationBuilder app)
    {
        using var scope = app.ApplicationServices.CreateScope();
        var initializer = scope.ServiceProvider.GetRequiredService<DefaultUserInitializer>();
        await initializer.InitializeAsync();
    }

    // 同步扩展方法
    public static void InitializeDefaultUser(this IApplicationBuilder app)
    {
        using var scope = app.ApplicationServices.CreateScope();
        var initializer = scope.ServiceProvider.GetRequiredService<DefaultUserInitializer>();
        initializer.Initialize();
    }
}

之后在Program.cs中只需一行调用：

await app.InitializeDefaultUserAsync();
// 同步场景：app.InitializeDefaultUser();

为什么不使用IHostedService？ #

IHostedService是单例服务，其StartAsync方法在后台线程执行，可能出现应用已开始处理请求但初始化尚未完成的情况。而直接在Program.cs中调用初始化方法，会同步等待初始化完成后再启动应用，确保默认用户存在后才对外提供服务，更符合此类初始化场景的需求。

内容的提问来源于stack exchange，提问作者Serhii Obidin