CODEWITHSUNDEEP
c#.netdependency-injectionasp.net-corequartz.net
donex93
donex93

Reputation: 533

.net Core Quartz Dependency Injection

How can I configure Quartz in .net core to use dependency injection? I using standard .net core Dependency mechanism. In constructor of class that implements IJob, I need inject some dependencies.

Upvotes: 35

Views: 39994

Answers (7)

dgzornoza
dgzornoza

Reputation: 658

In Quartz 3.9.0, you can use DI in job constructor as say in official page: https://www.quartz-scheduler.net/documentation/quartz-3.x/packages/microsoft-di-integration.html#job-instance-construction

public class SampleJob : IJob
{
    private readonly ILogger<AuditoriaHostedService> logger;
    private readonly AppConfigurationSettings appConfigurationSettings;

    public SampleJob(IOptions<AppConfigurationSettings> options, ILogger<AuditoriaHostedService> logger)
    {
        this.logger = logger;
        this.appConfigurationSettings = options.Value ?? throw new ArgumentNullException(nameof(options));
    }

    public Task Execute(IJobExecutionContext context)
    {
        Console.WriteLine($"Executing background job: {appConfigurationSettings.Url}");
        logger.LogInformation($"Executing background job: {appConfigurationSettings.Url}");

        return Task.CompletedTask;
    }
}

Upvotes: 0

laskau
laskau

Reputation: 1

Recently I encountered a problem of resolving job's dependencies without existing scope. I was having an exception inside job factory (implemented like in the correct answer) saying that "IServiceProvider was disposed" because the job is scheduled to be exectued after the response returns back to a client.

So, I slightly changed implementation of IJobFactory in @CodeZombie's answer and it worked. It is different in case of using IServiceScopeFactory instead of IServiceProvider - which ensures that every time a new scope is created.

public class CommonJobFactory : IJobFactory
    {
        private readonly ILogger<CommonJobFactory> _logger;
        private readonly IServiceScopeFactory _serviceScopeFactory;
        private readonly ConcurrentDictionary<IJob, IServiceScope> _scopes = new ConcurrentDictionary<IJob, IServiceScope>();

        public CommonJobFactory(
            IServiceScopeFactory scopeFactory, 
            ILogger<CommonJobFactory> logger)
        {
            _serviceScopeFactory = scopeFactory;
            _logger = logger;
        }

        public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
        {
            var newScope = _serviceScopeFactory.CreateScope();
            try
            {
                if (newScope.ServiceProvider.GetService(bundle.JobDetail.JobType) is IJob job && _scopes.TryAdd(job, newScope))
                   return job;

                throw new NullReferenceException("Unable to create new job from scope");
            }
            catch (Exception ex)
            {
                newScope.Dispose();
                _logger.LogError(ex, "Error while constructing {jobType} from scope", bundle.JobDetail.JobType);
                throw;
            }
        }

        public void ReturnJob(IJob job)
        {
            var disposableJob = job as IDisposable;
            disposableJob?.Dispose();

            if (_scopes.TryRemove(job, out var scope))
                scope.Dispose();
        }
    }

Upvotes: 0

Artem Illarionov
Artem Illarionov

Reputation: 248

UseMicrosoftDependencyInjectionJobFactory() allow to create jobs with DI

        services.AddQuartz(
            q =>
            {
                q.UseMicrosoftDependencyInjectionJobFactory();
                q.ScheduleJob<JobWithDI>(trigger => {});
            }

        services.AddQuartzHostedService();

Upvotes: 3

Daniel Stoyanoff
Daniel Stoyanoff

Reputation: 1564

I know it's an old question, but just wanted to add a 2020 answer:

https://www.quartz-scheduler.net/documentation/quartz-3.x/packages/microsoft-di-integration.html

https://www.quartz-scheduler.net/documentation/quartz-3.x/packages/aspnet-core-integration.html

I find it even easier than the approach that is not using the .NET Core DI. In the project I had to integrate it however, Autofac was using together with MS DI (can't tell you why) and it was complaining about some dependencies, so I had to add the following mapping as well:

services.AddSingleton<ITypeLoadHelper, SimpleTypeLoadHelper>();

The total solution for me looks like this:

services.AddTransient<UpcomingReleasesNotificationJob>();
services.AddSingleton<ITypeLoadHelper, SimpleTypeLoadHelper>();

var jobKey = new JobKey("notificationJob");
services.AddQuartz(q =>
{
   q.SchedulerId = "JobScheduler";
   q.SchedulerName = "Job Scheduler";
   q.UseMicrosoftDependencyInjectionScopedJobFactory();
   q.AddJob<UpcomingReleasesNotificationJob>(j => j.WithIdentity(jobKey));
   q.AddTrigger(t => t
      .WithIdentity("notificationJobTrigger")
      .ForJob(jobKey)
      .StartNow()
      .WithSchedule(CronScheduleBuilder.DailyAtHourAndMinute(14, 00))
   );
});

services.AddQuartzServer(options =>
{
   options.WaitForJobsToComplete = true;
});

Upvotes: 22

Jaron
Jaron

Reputation: 135

No idea if this will be helpful or not but I created my own DI extension for Quartz that you are more then welcome to try: https://github.com/JaronrH/Quartz.DependencyInjection

Short version is that you would use the AddQuartz() method to pass in the [optional] NaveValueCollection config and [required] Scrutor assembly searching you want (see https://andrewlock.net/using-scrutor-to-automatically-register-your-services-with-the-asp-net-core-di-container/). For example:

services.AddQuartz(s => s.FromAssemblyOf<Program>())

This call will:

  • Find and automatically register all IJob, IAddScheduledJob, IAddSchedulerListener, IAddTriggerListener, and IAddJobListener implementations found in the assemblies (Scrutor). So, yes, you can use DI in your IJob classes this way!
  • Setup a Singleton IScheduler in DI that uses the above DI resources.
  • Register an adapter to the IScheduler so that Microsoft's Logging is used for Quartz's logging.

You can then either use provider.StartQuartz() to start the Scheduler (which automatically looks for IApplicationLifetime and registers the Scheduler for Shutdown if available) or use conventional DI to get and start the services (provider.GetService().Start();).

Hope this helps!

Upvotes: 2

CodeZombie
CodeZombie

Reputation: 5377

Inspired by Rabbans great answer I created a complete implementation of a JobFactory for Microsoft.Extensions.DependencyInjection:

Implementation

using Microsoft.Extensions.DependencyInjection;
using Quartz;
using Quartz.Spi;
using System;
using System.Collections.Concurrent;

class JobFactory : IJobFactory
{
    protected readonly IServiceProvider _serviceProvider;

    protected readonly ConcurrentDictionary<IJob, IServiceScope> _scopes = new ConcurrentDictionary<IJob, IServiceScope>();

    public JobFactory(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
    {
        var scope = _serviceProvider.CreateScope();
        IJob job;

        try
        {
            job = scope.ServiceProvider.GetRequiredService(bundle.JobDetail.JobType) as IJob;
        }
        catch
        {
            // Failed to create the job -> ensure scope gets disposed
            scope.Dispose();
            throw;
        }

        // Add scope to dictionary so we can dispose it once the job finishes
        if (!_scopes.TryAdd(job, scope))
        {
            // Failed to track DI scope -> ensure scope gets disposed
            scope.Dispose();
            throw new Exception("Failed to track DI scope");
        }

        return job;
    }

    public void ReturnJob(IJob job)
    {
        if (_scopes.TryRemove(job, out var scope))
        {
            // The Dispose() method ends the scope lifetime.
            // Once Dispose is called, any scoped services that have been resolved from ServiceProvider will be disposed.
            scope.Dispose();
        }
    }
}

Usage

// Prepare the DI container
var services = new ServiceCollection();
// Register job
services.AddTransient<MyJob>();
// Register job dependencies
services.AddTransient<IFoo, Foo>();
var container = services.BuildServiceProvider();

// Create an instance of the job factory
var jobFactory = new JobFactory(container);

// Create a Quartz.NET scheduler
var schedulerFactory = new StdSchedulerFactory(properties);
var scheduler = schedulerFactory.GetScheduler();

// Tell the scheduler to use the custom job factory
scheduler.JobFactory = jobFactory;

The implementation has been tested in a .NET Core 2.1 console application with a single job and worked fine. Feel free to leave your feedback or improvement suggestions...

Upvotes: 25

Rabban
Rabban

Reputation: 2581

You can use the Quartz.Spi.IJobFactory interface and implement it. The Quartz documentations states:

When a trigger fires, the Job it is associated to is instantiated via the JobFactory configured on the Scheduler. The default JobFactory simply activates a new instance of the job class. You may want to create your own implementation of JobFactory to accomplish things such as having your application’s IoC or DI container produce/initialize the job instance. See the IJobFactory interface, and the associated Scheduler.SetJobFactory(fact) method.

ISchedulerFactory schedulerFactory = new StdSchedulerFactory(properties);
var scheduler = schedulerFactory.GetScheduler();

scheduler.JobFactory = jobFactory;

Edit

The implementation can look like this:

public class JobFactory : IJobFactory
{
    protected readonly IServiceProvider Container;

    public JobFactory(IServiceProvider container)
    {
        Container = container;
    }

    public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
    {
        return Container.GetService(bundle.JobDetail.JobType) as IJob;
    }

    public void ReturnJob(IJob job)
    {
        // i couldn't find a way to release services with your preferred DI, 
        // its up to you to google such things
    }
}

To use it with the Microsoft.Extensions.DependencyInjection create your container like this:

var services = new ServiceCollection();
services.AddTransient<IAuthorizable, AuthorizeService>();
var container = services.BuildServiceProvider();
var jobFactory = new JobFactory(container);

References

  1. Quartz documentation

  2. Api

Upvotes: 38

Related Questions