Using scoped services with QuartzJobRunner

Author: andrewlock

QuartzWithScopedServices/QuartzWithScopedServices.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.28803.352
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuartzWithScopedServices", "QuartzWithScopedServices\QuartzWithScopedServices.csproj", "{9949A250-8B59-49FF-9258-4279280977DD}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{9949A250-8B59-49FF-9258-4279280977DD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9949A250-8B59-49FF-9258-4279280977DD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9949A250-8B59-49FF-9258-4279280977DD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9949A250-8B59-49FF-9258-4279280977DD}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {765EAF8C-DC2A-4137-A0BA-3720AD03DFD5}
+	EndGlobalSection
+EndGlobal

QuartzWithScopedServices/QuartzWithScopedServices/HelloWorldJob.cs

@@ -0,0 +1,25 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Quartz;
+using System;
+using System.Threading.Tasks;
+
+namespace QuartzWithScopedServices
+{
+
+    public class HelloWorldJob : IJob
+    {
+        private readonly ILogger<HelloWorldJob> _logger;
+
+        public HelloWorldJob(ILogger<HelloWorldJob> logger)
+        {
+            _logger = logger;
+        }
+
+        public Task Execute(IJobExecutionContext context)
+        {
+            _logger.LogInformation("Hello world!");
+            return Task.CompletedTask;
+        }
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/JobFactory.cs

@@ -0,0 +1,27 @@
+using Microsoft.Extensions.DependencyInjection;
+using Quartz;
+using Quartz.Spi;
+using System;
+
+namespace QuartzWithScopedServices
+{
+    public class JobFactory : IJobFactory
+    {
+        private readonly IServiceProvider _serviceProvider;
+
+        public JobFactory(IServiceProvider serviceProvider)
+        {
+            _serviceProvider = serviceProvider;
+        }
+
+        public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
+        {
+            return _serviceProvider.GetRequiredService<QuartzJobRunner>();
+        }
+
+        public void ReturnJob(IJob job)
+        {
+            // we let the DI container handler this
+        }
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/JobSchedule.cs

@@ -0,0 +1,16 @@
+using System;
+
+namespace QuartzWithScopedServices
+{
+    public class JobSchedule
+    {
+        public JobSchedule(Type jobType, string cronExpression)
+        {
+            JobType = jobType;
+            CronExpression = cronExpression;
+        }
+
+        public Type JobType { get; }
+        public string CronExpression { get; }
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/PrintGuidJob.cs

@@ -0,0 +1,26 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Quartz;
+using System;
+using System.Threading.Tasks;
+
+namespace QuartzWithScopedServices
+{
+    public class PrintGuidJob : IJob
+    {
+        private readonly ILogger<PrintGuidJob> _logger;
+        private readonly Guid _guid;
+
+        public PrintGuidJob(ILogger<PrintGuidJob> logger)
+        {
+            _logger = logger;
+            _guid = Guid.NewGuid();
+        }
+
+        public Task Execute(IJobExecutionContext context)
+        {
+            _logger.LogInformation("The job GUID is: " + _guid);
+            return Task.CompletedTask;
+        }
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/Program.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+
+namespace QuartzWithScopedServices
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateWebHostBuilder(args).Build().Run();
+        }
+
+        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
+            WebHost.CreateDefaultBuilder(args)
+                .UseStartup<Startup>();
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/Properties/launchSettings.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false, 
+    "anonymousAuthentication": true, 
+    "iisExpress": {
+      "applicationUrl": "http://localhost:55846",
+      "sslPort": 0
+    }
+  },
+  "profiles": {
+    "QuartzWithScopedServices": {
+      "commandName": "Project",
+      "launchBrowser": false,
+      "launchUrl": "api/values",
+      "applicationUrl": "http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

QuartzWithScopedServices/QuartzWithScopedServices/QuartzHostedService.cs

@@ -0,0 +1,69 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Hosting;
+using Quartz;
+using Quartz.Spi;
+
+namespace QuartzWithScopedServices
+{
+    public class QuartzHostedService : IHostedService
+    {
+        private readonly ISchedulerFactory _schedulerFactory;
+        private readonly IJobFactory _jobFactory;
+        private readonly IEnumerable<JobSchedule> _jobSchedules;
+        private IScheduler _scheduler;
+
+        public QuartzHostedService(
+            ISchedulerFactory schedulerFactory,
+            IEnumerable<JobSchedule> jobSchedules,
+            IJobFactory jobFactory)
+        {
+            _schedulerFactory = schedulerFactory;
+            _jobSchedules = jobSchedules;
+            _jobFactory = jobFactory;
+        }
+
+        public async Task StartAsync(CancellationToken cancellationToken)
+        {
+            _scheduler = await _schedulerFactory.GetScheduler(cancellationToken);
+            _scheduler.JobFactory = _jobFactory;
+
+            foreach (var jobSchedule in _jobSchedules)
+            {
+                var job = CreateJob(jobSchedule);
+                var trigger = CreateTrigger(jobSchedule);
+
+                await _scheduler.ScheduleJob(job, trigger, cancellationToken);
+            }
+
+            await _scheduler.Start(cancellationToken);
+        }
+
+        public async Task StopAsync(CancellationToken cancellationToken)
+        {
+            await _scheduler.Shutdown(cancellationToken);
+        }
+
+        private static ITrigger CreateTrigger(JobSchedule schedule)
+        {
+            return TriggerBuilder
+                .Create()
+                .WithIdentity($"{schedule.JobType.FullName}.trigger")
+                .WithCronSchedule(schedule.CronExpression)
+                .WithDescription(schedule.CronExpression)
+                .Build();
+        }
+
+        private static IJobDetail CreateJob(JobSchedule schedule)
+        {
+            var jobType = schedule.JobType;
+            return JobBuilder
+                .Create(jobType)
+                .WithIdentity(jobType.FullName)
+                .WithDescription(jobType.Name)
+                .Build();
+        }
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/QuartzJobRunner.cs

@@ -0,0 +1,29 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Quartz;
+using System;
+using System.Threading.Tasks;
+
+namespace QuartzWithScopedServices
+{
+    [DisallowConcurrentExecution]
+    public class QuartzJobRunner : IJob
+    {
+        private readonly IServiceProvider _serviceProvider;
+
+        public QuartzJobRunner(IServiceProvider serviceProvider)
+        {
+            _serviceProvider = serviceProvider;
+        }
+
+        public async Task Execute(IJobExecutionContext context)
+        {
+            using (var scope = _serviceProvider.CreateScope())
+            {
+                var job = scope.ServiceProvider.GetRequiredService(context.JobDetail.JobType) as IJob;
+
+                await job.Execute(context);
+            }
+        }
+    }
+}

QuartzWithScopedServices/QuartzWithScopedServices/QuartzWithScopedServices.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.2</TargetFramework>
+    <AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.App" />
+    <PackageReference Include="Quartz" Version="3.0.7" />
+  </ItemGroup>
+
+</Project>