netcore2.1 在后台運行一個任務

在 ASP.NET Core 2.1中， 提供了一個名為BackgroundService的類,在 Microsoft.Extensions.Hosting命名空間中,其代碼為

namespace Microsoft.Extensions.Hosting
{
    //
    // 摘要:
    //     Base class for implementing a long running Microsoft.Extensions.Hosting.IHostedService.
    public abstract class BackgroundService : IHostedService, IDisposable
    {
        protected BackgroundService();

        public virtual void Dispose();
        //
        // 摘要:
        //     Triggered when the application host is ready to start the service.
        //
        // 參數:
        //   cancellationToken:
        //     Indicates that the start process has been aborted.
        public virtual Task StartAsync(CancellationToken cancellationToken);
        //
        // 摘要:
        //     Triggered when the application host is performing a graceful shutdown.
        //
        // 參數:
        //   cancellationToken:
        //     Indicates that the shutdown process should no longer be graceful.
        [AsyncStateMachine(typeof(<StopAsync>d__4))]
        public virtual Task StopAsync(CancellationToken cancellationToken);
        //
        // 摘要:
        //     This method is called when the Microsoft.Extensions.Hosting.IHostedService starts.
        //     The implementation should return a task that represents the lifetime of the long
        //     running operation(s) being performed.
        //
        // 參數:
        //   stoppingToken:
        //     Triggered when Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken)
        //     is called.
        //
        // 返回結果:
        //     A System.Threading.Tasks.Task that represents the long running operations.
        protected abstract Task ExecuteAsync(CancellationToken stoppingToken);
    }
}

可以看出它是繼承自 IHostedService, IDisposable ，  而我們只需要繼承並實現它的 ExecuteAsync 即可。

也就是說，我們只需在這個方法內寫下這個服務需要做的事，

internal class TokenRefreshService : BackgroundService
    {
        private readonly ILogger _logger;

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

        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            _logger.LogInformation("Service starting");

            while (!stoppingToken.IsCancellationRequested)
            {
                _logger.LogInformation(DateTime.Now.ToLongTimeString() + ": Refresh Token!");//在此寫需要執行的任務
                await Task.Delay(5000, stoppingToken);
            }

            _logger.LogInformation("Service stopping");
        }
    }

然后在Startup中注冊服務。

 // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.Configure<CookiePolicyOptions>(options =>
            {
                // This lambda determines whether user consent for non-essential cookies is needed for a given request.
                options.CheckConsentNeeded = context => true;
                options.MinimumSameSitePolicy = SameSiteMode.None;
            });


            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);


            services.AddSingleton<Microsoft.Extensions.Hosting.IHostedService, TokenRefreshService>();



        }

 

注意 注意 注意 

　   1. 當IIS上部署的項目啟動后，后台任務隨之啟動，任務執行相應的log正常輸出。

　　2. 手動回收對應的應用程序池，任務執行相應的log輸出停止。

　　3. 重新請求該網站，后台任務隨之啟動，任務執行相應的log重新開始輸出。

所以不建議在這樣的后台任務中做一些需要固定定時執行的業務處理類的操作，但對於緩存刷新類的操作還是可以的，因為當應用程序池回收后再次運行的時候，后台任務會隨着啟動。