我想弄个网站,手机网站模板 php,嵌入式培训心得,企业网站建设方案平台当我们在web开发中#xff0c;常常会遇到这么一个需求#xff0c;在后台执行某一项具体的任务#xff0c;具体的说就是这些任务必须在后台定时执行。Quartz.NET 是一个开源的 JAVA 移植版#xff0c;它有着悠久的历史并且提供了强大的 Cron 表达式#xff0c;这篇我们就来… 当我们在web开发中常常会遇到这么一个需求在后台执行某一项具体的任务具体的说就是这些任务必须在后台定时执行。Quartz.NET 是一个开源的 JAVA 移植版它有着悠久的历史并且提供了强大的 Cron 表达式这篇我们就来讨论如何在 ASP.NET Core 中使用 Quartz.NET 去执行一些后台任务。安装 Quartz.NET 要想使用 Quartz.NET你可以使用 Visual Studio 2019 中的 NuGet package manager 可视化界面进行安装或者通过 NuGet package manager console 命令行输入如下命令
Install-Package QuartzQuartz.NET 中的Job,triggers 和 Schedulers Quartz.NET 里有三个非常重要的概念任务触发器 和 调度器对应着 JobTrigger 和 SchedulersJob 表示一个你需要被执行的任务任务中可以写上你的业务逻辑代码Job 就是一个实现了 IJob 接口的子类如下代码所示class Job : IJob{public Task Execute(IJobExecutionContext context){throw new NotImplementedException();}}Trigger 通常用于指定一个 job 是如何被调度的什么意思呢比如说这个job是按天执行还是按小时执行还是按秒执行值得注意的是因为支持了 Cron 表达式还能够实现更加超级复杂的调度逻辑。Scheduler 通常按照你预先设置的调度规则将 job 丢给它的任务队列并按照 trigger 规则轮询然后执行任务。创建 Scheduler 在 Quartz.NET 中可以创建多个 Scheduler但为了演示目的我就创建一个 Scheduler 啦下面的代码展示了如何去创建 Scheduler。
var scheduler StdSchedulerFactory.GetDefaultScheduler().GetAwaiter().GetResult();一旦使用上面的代码创建好了 Scheduler接下来就可以将其作为服务注入到 Asp.net Core 的 IOC 容器中实现代码如下public void ConfigureServices(IServiceCollection services){var scheduler StdSchedulerFactory.GetDefaultScheduler().GetAwaiter().GetResult();services.AddSingleton(scheduler);services.AddRazorPages();}开启和停止 scheduler 为了方便实现 开启 和 停止 功能我准备封装一个 hosting service 类做法就是从 IHostingService 接口派生出一个 CustomQuartzHostedService 类完整代码如下
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 中实现代码如下public void ConfigureServices(IServiceCollection services){var scheduler StdSchedulerFactory.GetDefaultScheduler().GetAwaiter().GetResult();services.AddSingleton(scheduler);services.AddHostedServiceCustomQuartzHostedService();services.AddRazorPages();}创建 job 正如之前说到的job 是一个实现了 IJob 接口 并且实现了 Execute() 的类这个 Execute() 方法接收一个 IJobExecutionContext 参数。下面的代码片段展示了这个 Job 类包含了一个异步方式的 Execute() 方法这个方法中包含的代码就是你需要执行的业务逻辑。[DisallowConcurrentExecution]public class NotificationJob : IJob{private readonly ILoggerNotificationJob _logger;public NotificationJob(ILoggerNotificationJob 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的idjob的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.AddSingletonIJobFactory, CustomQuartzJobFactory();services.AddSingletonISchedulerFactory, StdSchedulerFactory();services.AddSingletonNotificationJob();services.AddSingleton(new JobMetadata(Guid.NewGuid(), typeof(NotificationJob),Notification Job, 0/10 * * * * ?));services.AddHostedServiceCustomQuartzHostedService();
} 这就是所有要做的事情接下来运行应用程序你会观察到 NotificationJob 的 Execute() 方法会每 10s 执行一次。如何你的应用程序中需要有任务调用的功能现在开始可以不需要使用Timer了采用强大的 Quartz.NET 即可而且还有一个????????的功能就是你可以把 job 持久化到 SQL Server, PostgreSQL, SQLite 中太强大了。译文链接https://www.infoworld.com/article/3529418/how-to-schedule-jobs-using-quartznet-in-aspnet-core.html
