如何在 ASP.NET 中使用 Quartz.NET

時間  2021-01-02
標籤 html git github web 異步 async ide this .net 欄目 ASP 简体版
原文   原文鏈接

當咱們在web開發中，經常會遇到這麼一個需求，在後臺執行某一項具體的任務，具體的說就是這些任務必須在後臺定時執行。html

Quartz.NET 是一個開源的 JAVA 移植版，它有着悠久的歷史而且提供了強大的 Cron 表達式，這篇咱們就來討論如何在 ASP.NET Core 中使用 Quartz.NET 去執行一些後臺任務。git

安裝 Quartz.NET

要想使用 Quartz.NET，你可使用 Visual Studio 2019 中的 NuGet package manager 可視化界面進行安裝，或者經過 NuGet package manager console 命令行輸入以下命令：github

Install-Package Quartz

Quartz.NET 中的Job,triggers 和 Schedulers

Quartz.NET 裏有三個很是重要的概念：任務，觸發器 和 調度器，對應着 Job，Trigger 和 Schedulers，Job 表示一個你須要被執行的任務，任務中能夠寫上你的業務邏輯代碼，Job 就是一個實現了 IJob 接口的子類，以下代碼所示：web

class Job : IJob
    {
        public Task Execute(IJobExecutionContext context)
        {
            throw new NotImplementedException();
        }
    }

Trigger 一般用於指定一個 job 是如何被調度的？ 什麼意思呢？ 好比說：這個job是按天執行？ 仍是按小時執行？仍是按秒執行？值得注意的是由於支持了 Cron 表達式，還可以實現更加超級複雜的調度邏輯。異步

Scheduler 一般按照你預先設置的調度規則將 job 丟給它的任務隊列，並按照 trigger 規則輪詢而後執行任務。async

建立 Scheduler

在 Quartz.NET 中能夠建立多個 Scheduler，但爲了演示目的我就建立一個 Scheduler 啦，下面的代碼展現瞭如何去建立 Scheduler。ide

var scheduler = StdSchedulerFactory.GetDefaultScheduler().GetAwaiter().GetResult();

一旦使用上面的代碼建立好了 Scheduler，接下來就能夠將其做爲服務注入到 Asp.net Core 的 IOC 容器中，實現代碼以下：ui

public void ConfigureServices(IServiceCollection services)
        {
            var scheduler = StdSchedulerFactory.GetDefaultScheduler().GetAwaiter().GetResult();

            services.AddSingleton(scheduler);
            services.AddRazorPages();
        }

開啓和中止 scheduler

爲了方便實現 開啓 和 中止 功能，我準備封裝一個 hosting service 類，作法就是從 IHostingService 接口派生出一個 CustomQuartzHostedService 類，完整代碼以下：this

public class CustomQuartzHostedService : IHostedService
{
        private readonly IScheduler _scheduler;
        public CustomQuartzHostedService(IScheduler scheduler)
        {
            _scheduler = scheduler;
        }
        public async Task StartAsync(CancellationToken cancellationToken)
        {
            await _scheduler?.Start(cancellationToken);
        }
        public async Task StopAsync(CancellationToken cancellationToken)
        {
            await _scheduler?.Shutdown(cancellationToken);
        }
 }

有了這個自定義類，接下來把這個類也注入到 servcies collection 中，實現代碼以下：.net

public void ConfigureServices(IServiceCollection services)
        {
            var scheduler = StdSchedulerFactory.GetDefaultScheduler().GetAwaiter().GetResult();

            services.AddSingleton(scheduler);
            services.AddHostedService<CustomQuartzHostedService>();
            services.AddRazorPages();
        }

建立 job

正如以前說到的，job 是一個實現了 IJob 接口 而且實現了 Execute() 的類，這個 Execute() 方法接收一個 IJobExecutionContext 參數。

下面的代碼片斷展現了這個 Job 類包含了一個異步方式的 Execute() 方法，這個方法中包含的代碼就是你須要執行的業務邏輯。

[DisallowConcurrentExecution]
    public class NotificationJob : IJob
    {
        private readonly ILogger<NotificationJob> _logger;
        public NotificationJob(ILogger<NotificationJob> logger)
        {
            _logger = logger;
        }
        public Task Execute(IJobExecutionContext context)
        {
            _logger.LogInformation("Hello world!");
            return Task.CompletedTask;
        }
    }

建立 job 工廠

若是要定義一個 Job 工廠，則必需要實現 IJobFactory 接口中的 NewJob() 和 ReturnJob() 方法，下面的代碼片斷展現瞭如何去 建立 和 返回 job 的 factory 類。

public class CustomQuartzJobFactory : IJobFactory
    {
        private readonly IServiceProvider _serviceProvider;
        public CustomQuartzJobFactory(IServiceProvider serviceProvider)
        {
            _serviceProvider = serviceProvider;
        }
        public IJob NewJob(TriggerFiredBundle triggerFiredBundle,
        IScheduler scheduler)
        {
            var jobDetail = triggerFiredBundle.JobDetail;
            return (IJob)_serviceProvider.GetService(jobDetail.JobType);
        }
        public void ReturnJob(IJob job) { }
    }

值得注意的是，這裏我並無實現 job 池，若是你想實現這個功能，你須要修改如下 NewJob() 方法 而且重寫 ReturnJob() 方法。

建立 JobMetadata 存儲你的 job 元數據

我準備定義一個 JobMetadata 類去存儲和job 相關聯的元數據，好比說：job的id，job的name 等等，下面的代碼展現瞭如何定義這麼一個類。

public class JobMetadata
    {
        public Guid JobId { get; set; }
        public Type JobType { get; }
        public string JobName { get; }
        public string CronExpression { get; }
        public JobMetadata(Guid Id, Type jobType, string jobName,
        string cronExpression)
        {
            JobId = Id;
            JobType = jobType;
            JobName = jobName;
            CronExpression = cronExpression;
        }
    }

使用 hosted service 封裝 Scheduler 的start和stop

接下來，我須要豐富一下 CustomQuartzHostedService 類，完整的代碼清單以下。

public class CustomQuartzHostedService : IHostedService
    {
        private readonly ISchedulerFactory schedulerFactory;
        private readonly IJobFactory jobFactory;
        private readonly JobMetadata jobMetadata;
        public CustomQuartzHostedService(ISchedulerFactory schedulerFactory,JobMetadata jobMetadata,IJobFactory jobFactory)
        {
            this.schedulerFactory = schedulerFactory;
            this.jobMetadata = jobMetadata;
            this.jobFactory = jobFactory;
        }
        public IScheduler Scheduler { get; set; }
        public async Task StartAsync(CancellationToken cancellationToken)
        {
            Scheduler = await schedulerFactory.GetScheduler();
            Scheduler.JobFactory = jobFactory;
            var job = CreateJob(jobMetadata);
            var trigger = CreateTrigger(jobMetadata);
            await Scheduler.ScheduleJob(job, trigger, cancellationToken);
            await Scheduler.Start(cancellationToken);
        }
        public async Task StopAsync(CancellationToken cancellationToken)
        {
            await Scheduler?.Shutdown(cancellationToken);
        }
        private ITrigger CreateTrigger(JobMetadata jobMetadata)
        {
            return TriggerBuilder.Create()
                                 .WithIdentity(jobMetadata.JobId.ToString())
                                 .WithCronSchedule(jobMetadata.CronExpression)
                                 .WithDescription($"{jobMetadata.JobName}")
                                 .Build();
        }
        private IJobDetail CreateJob(JobMetadata jobMetadata)
        {
            return JobBuilder
            .Create(jobMetadata.JobType)
            .WithIdentity(jobMetadata.JobId.ToString())
            .WithDescription($"{jobMetadata.JobName}")
            .Build();
        }
    }

接下來再看一下 Startup.ConfigureServices 方法下的完整代碼。

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages();
    services.AddSingleton<IJobFactory, CustomQuartzJobFactory>();
    services.AddSingleton<ISchedulerFactory, StdSchedulerFactory>();
    services.AddSingleton<NotificationJob>();
    services.AddSingleton(new JobMetadata(Guid.NewGuid(), typeof(NotificationJob),"Notification Job", "0/10 * * * * ?"));
    services.AddHostedService<CustomQuartzHostedService>();
}

這就是全部要作的事情，接下來運行應用程序，你會觀察到 NotificationJob 的 Execute() 方法會每 10s 執行一次。

如何你的應用程序中須要有任務調用的功能，如今開始能夠不須要使用Timer了，採用強大的 Quartz.NET 便可，並且還有一個🐂👃的功能就是：你能夠把 job 持久化到 SQL Server, PostgreSQL, SQLite 中，太強大了。

譯文連接： https://www.infoworld.com/art...

更多高質量乾貨：參見個人 GitHub: dotnetfly

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程