.NET Core中Quartz.NET的依赖注入
目录介绍项目概况创建配置文件使用构造函数注入使用选项模式结论介绍Quartz.NET是一个方便的库,允许您通过实现IJob接口来安排重复任务。然而,它的局限性在于,默认情况下,它仅支持无参数构造函数,这使得在其内部注入外部服务变得复杂,即,用于实现存储库模式。在本文中,我们将了解如何使用标准.NET Core DI容器解决此问题。本文中提到的整个项目在以下Git...
目录
介绍
Quartz.NET是一个方便的库,允许您通过实现IJob接口来安排重复任务。然而,它的局限性在于,默认情况下,它仅支持无参数构造函数,这使得在其内部注入外部服务变得复杂,即,用于实现存储库模式。在本文中,我们将了解如何使用标准.NET Core DI容器解决此问题。
本文中提到的整个项目在以下Github存储库中提供。为了更好地遵循文章中的代码,您可能需要查看它。
项目概况
我们来看看最初的解决方案结构。
项目QuartzDI.Demo.External.DemoService代表了一些我们无法控制的外部依赖。为了简单起见,它的工作非常简单。
项目QuartzDI.Demo是我们的工作项目,包含简单的Quartz.NET作业。
public class DemoJob : IJob
{
private const string Url = "https://i.ua";
public static IDemoService DemoService { get; set; }
public Task Execute(IJobExecutionContext context)
{
DemoService.DoTask(Url);
return Task.CompletedTask;
}
}
这是以直接的方式设置的:
var props = new NameValueCollection
{
{ "quartz.serializer.type", "binary" }
};
var factory = new StdSchedulerFactory(props);
var sched = await factory.GetScheduler();
await sched.Start();
var job = JobBuilder.Create<DemoJob>()
.WithIdentity("myJob", "group1")
.Build();
var trigger = TriggerBuilder.Create()
.WithIdentity("myTrigger", "group1")
.StartNow()
.WithSimpleSchedule(x => x
.WithIntervalInSeconds(5)
.RepeatForever())
.Build();
await sched.ScheduleJob(job, trigger);
我们通过作业的static属性提供外部服务
DemoJob.DemoService = new DemoService();
由于该项目是一个控制台应用程序,在本文的课程中,我们必须手动安装所有需要的基础架构,并能够更全面地了解.NET Core实际上为我们带来了什么。
此时,我们的项目正在运行。最重要的是它很简单,很棒。但是,如果我们想把它作为一个小工具,那么我们就会为这种简单性付出代价。但这通常不是生产系统的情况。所以让我们稍微调整一下以使其更灵活。
创建配置文件
其中一个缺点是我们硬编码调用到DemoJob中的URL 。理想情况下,我们希望更改它,并根据我们的环境进行更改。.NET Core附带了appsettings.json机制。
为了开始使用.NET Core配置机制,我们必须安装几个Nuget包:
Microsoft.Extensions.Configuration
Microsoft.Extensions.Configuration.FileExtensions
Microsoft.Extensions.Configuration.Json
让我们创建一个具有这样名称的文件并在那里提取我们的URL:
{
"connection": {
"Url": "http://i.ua"
}
}
现在我们可以从配置文件中提取我们的值,如下所示:
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json", true, true);
var configuration = builder.Build();
var connectionSection = configuration.GetSection("connection");
DemoJob.Url = connectionSection["Url"];
请注意,要实现它,我们必须将Url从常量更改为属性。
public static string Url { get; set; }
使用构造函数注入
通过static属性注入服务对于一个简单的项目来说很好,但是对于一个更大的项目,它可能带来一些缺点:例如可能在没有服务的情况下调用作业,因此失败或在对象运行时期间改变依赖性,这使得更难以推理对象。要解决这些问题,我们应该使用构造函数注入。
虽然纯依赖注入没有任何问题,但是有些人认为你应该在本文中努力实现它,我们将使用Nuget包附带的内置.NET Core DI容器Microsoft.Extensions.DependencyInjection。
现在我们指定我们依赖于构造函数参数的服务:
private readonly IDemoService _demoService;
public DemoJob(IDemoService demoService)
{
_demoService = demoService;
}
为了调用作业的参数构造函数,Quartz.NET提供了IJobFactory接口。这是我们的实现:
public class DemoJobFactory : IJobFactory
{
private readonly IServiceProvider _serviceProvider;
public DemoJobFactory(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}
public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
{
return _serviceProvider.GetService<DemoJob>();
}
public void ReturnJob(IJob job)
{
var disposable = job as IDisposable;
disposable?.Dispose();
}
}
让我们注册我们的依赖项:
var serviceCollection = new ServiceCollection();
serviceCollection.AddScoped<DemoJob>();
serviceCollection.AddScoped<IDemoService, DemoService>();
var serviceProvider = serviceCollection.BuildServiceProvider();
拼图的最后一块是让Quartz.NET使用我们的工厂。IScheduler有属性JobFactory只是为了这件事。
sched.JobFactory = new DemoJobFactory(serviceProvider);
使用选项模式
现在我们可以使用配置选项来实现相同的技巧。同样,我们的例子以Nuget包开始。这一次是Microsoft.Extensions.Options。
让我们为配置选项创建一个强类型定义:
public class DemoJobOptions
{
public string Url { get; set; }
}
现在我们按如下方式填充它们:
serviceCollection.AddOptions();
serviceCollection.Configure<DemoJobOptions>(options =>
{
options.Url = connectionSection["Url"];
});
并将它们注入构造函数中。不是我们直接注入IOptions<T>,不是options实例。
public DemoJob(IDemoService demoService, IOptions<DemoJobOptions> options)
{
_demoService = demoService;
_options = options.Value;
}
结论
在本文中,我们已经了解了如何利用.NET Core功能使Quartz.NET的使用更加灵活。
原文地址:https://www.codeproject.com/Articles/1277745/Dependency-Injection-for-Quartz-NET-in-NET-Core
更多推荐
所有评论(0)