ASP.NET Core 3.x启动时运行异步任务

引言

在ASP.NET Core 3.x中，可以通过自定义启动时运行的任务来完成一些初始化的工作。这些任务可以在应用程序启动时运行，以确保在接收到任何请求之前完成。

本文将介绍如何在ASP.NET Core 3.x应用程序中配置并运行异步任务，并提供一些实际应用场景。

配置启动任务

要配置启动时运行的任务，我们需要在Program.cs文件中进行一些简单的设置。首先，我们需要在CreateHostBuilder方法中启用UseStartup：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

然后，在Startup类中，我们可以通过实现IHostedService接口来定义任务：

public class Startup : IStartup
{
    public void Configure(IApplicationBuilder app)
    {
        // 在这里配置应用程序的请求处理中间件
    }

    public void ConfigureServices(IServiceCollection services)
    {
        // 在这里配置应用程序的依赖注入
    }
}

public class MyBackgroundService : BackgroundService
{
    private readonly ILogger<MyBackgroundService> _logger;

    public MyBackgroundService(ILogger<MyBackgroundService> logger)
    {
        _logger = logger;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            // 这里编写需要定时执行的任务逻辑

            _logger.LogInformation("Task is running...");

            await Task.Delay(TimeSpan.FromMinutes(1), stoppingToken);
        }
    }
}

在上述代码中，我们创建了一个名为MyBackgroundService的后台服务类，继承自BackgroundService，该类实现了IHostedService接口。通过重写ExecuteAsync方法，我们可以编写需要定时执行的任务逻辑。

注册启动任务

在ConfigureServices方法中，我们可以将任务注册为应用程序的服务：

public void ConfigureServices(IServiceCollection services)
{
    services.AddHostedService<MyBackgroundService>();
}

这样，每当应用程序启动时，该任务都会自动开始执行。

实际应用场景

启动任务可以应用于各种实际场景，例如：

数据库迁移

在应用程序启动时，可以运行数据库迁移任务来自动更新数据库结构。可以使用Entity Framework Core的MigrateAsync方法完成数据库迁移：

public class MigrateDatabaseHostedService : IHostedService
{
    private readonly ILogger<MigrateDatabaseHostedService> _logger;
    private readonly IServiceProvider _serviceProvider;

    public MigrateDatabaseHostedService(
        ILogger<MigrateDatabaseHostedService> logger,
        IServiceProvider serviceProvider)
    {
        _logger = logger;
        _serviceProvider = serviceProvider;
    }

    public async Task StartAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Migrating database...");

        using (var scope = _serviceProvider.CreateScope())
        {
            var dbContext = scope.ServiceProvider.GetRequiredService<MyDbContext>();
            await dbContext.Database.MigrateAsync();
        }

        _logger.LogInformation("Database migration completed.");
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

在上述代码中，我们通过CreateScope方法获取MyDbContext实例，并调用MigrateAsync方法进行数据库迁移。

缓存预热

在应用程序启动时，可以进行缓存预热，以提高后续请求的响应时间。可以通过在后台服务中调用相关方法来实现缓存预热：

public class CachePreheatHostedService : IHostedService
{
    private readonly ILogger<CachePreheatHostedService> _logger;
    private readonly ICacheService _cacheService;

    public CachePreheatHostedService(
        ILogger<CachePreheatHostedService> logger,
        ICacheService cacheService)
    {
        _logger = logger;
        _cacheService = cacheService;
    }

    public async Task StartAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Preheating cache...");

        await _cacheService.PreheatAsync();

        _logger.LogInformation("Cache preheating completed.");
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

在上述代码中，我们注入了ICacheSerivce接口，并在StartAsync方法中调用了PreheatAsync方法，该方法完成缓存的预热。

结语

通过自定义启动任务，我们可以在ASP.NET Core 3.x应用程序启动时执行一些初始化工作。本文介绍了配置和注册启动任务的步骤，并提供了两个实际应用场景的示例，希望对您有所帮助。

在下一篇博客中，将继续介绍如何在ASP.NET Core 3.x应用程序中运行异步任务，敬请期待。

本文来自极简博客，作者：热血战士喵，转载请注明原文链接：ASP.NET Core 3.x启动时运行异步任务