Quartz.NET 作业调度(二):Job

JobBuilder

Create

通过 JobBuilder 的 Create 方法,指定一个作业任务(一个实现了 IJob 接口的 Job 类)。IJob 接口只有一个 Execute 方法,我们需要在 Execute 方法中完善我们要执行的业务代码。

1
2
IJobDetail job = JobBuilder.Create<HelloJob>()
.Build();
1
2
3
4
5
6
7
public class HelloJob : IJob
{
public async Task Execute(IJobExecutionContext context)
{
await Console.Out.WriteLineAsync("Hi,everybody");
}
}

Execute 方法中的 context 参数包含作业执行的所有上下文信息,我们可以通过 context 中的一些属性获取需要的数据。如:

context.Scheduler 调度器信息
context.Trigger 触发器信息
context.JobDetail 作业信息
context.ScheduledFireTimeUtc 当前触发时间
context.NextFireTimeUtc 下一次将被触发时间
……

Identity

Job 注册到 Quartz 调度器的时候需要设置一个标识的 name,同时可以为 name 设置一个组,方便我们对 Job 分类,在同一个组内的 name 必须是唯一的。如果没有指定,name会自动生成,group 为 DEFAULT。

1
2
3
IJobDetail job = JobBuilder.Create<HelloJob>()
.WithIdentity("job1", "jobGroup1");
.Build();

UsingJobData

通过 JobBuilder 的 UsingJobData 方法我们可以为这个 Job 设置一些附属信息,当 Job 被执行的时候,我们在 Execute 方法中通过 context.JobDetail.JobDataMap 获取这些信息以供业务代码使用,也可以通过定义同名的属性,它将会自动注入到属性值。

1
2
3
4
5
6
7
var jobDataMap = new JobDataMap();
jobDataMap.Add("name", "beck");

IJobDetail job = JobBuilder.Create<HelloJob>()
.WithIdentity("job1", "jobGroup1");
.UsingJobData(jobDataMap)
.Build();
1
2
3
4
5
6
7
8
9
10
public class HelloJob : IJob
{
// 映射JobDetail.JobDataMap的name
public string Name { get; set; }
public async Task Execute(IJobExecutionContext context)
{
//var name = context.JobDetail.JobDataMap["name"].ToString();
await Console.Out.WriteLineAsync($"Hi {Name}");
}
}

注意:Job 和 Trigger 中都可以通过 UsingJobData 来设置附属信息,在 Execute 方法中,context.MergedJobDataMap 属性中既包含 Job 的 DataMap,也包含 Trigger 的 DataMap。当存在同名的参数时,Trigger 会覆盖 Job 的参数值。

StoreDurably

默认情况下,当 Job 没有对应的 Trigger 时,Job 是不能直接被加入调度器中的,或者在 Trigger 过期之后, 没有关联 Trigger 的 Job 也会被删除。我们可以通过 JobBuilder 的 StoreDurably 使 Job 独立存储于调度器中。

1
2
3
4
5
IJobDetail job = JobBuilder.Create<HelloJob>()
.WithIdentity("job1", "jobGroup1")
.UsingJobData(jobDataMap)
.StoreDurably()
.Build();

Job

State

Job 默认是无状态的,每次执行 Job ,context.JobDetail 获取到值都是原始数据,对其的任何修改都不会生效。
如:我们试图修改 JobDataMap 中的 times 属性,希望每次执行后都加1。

1
2
var jobDataMap = new JobDataMap();
jobDataMap.Add("times", 1);

1
2
3
4
5
6
7
8
9
public class HelloJob : IJob
{
public int Times { get; set; }
public async Task Execute(IJobExecutionContext context)
{
context.JobDetail.JobDataMap["times"] = Times + 1;
await Console.Out.WriteLineAsync($"execute {Times} times");
}
}

无状态的结果

实际并不会有效,Job 注册之后,调度器内保存了这个对象,默认情况下是每次通过反射new一个新实例来执行的,所以每次修改必然不会有效。但我们可以通过在 Job 类上加上 PersistJobDataAfterExecution Attribute,就可以非常简单的把 Job 变成有状态。

1
2
3
4
5
[PersistJobDataAfterExecution]
public class HelloJob : IJob
{
// ...
}

有状态的结果

Concurrency

当多个 Trigger 同时触发一个 Job 或者 一个 Job 执行较长,Trigger 条件已经被多次触发,这种情况下,Job 就出现了并发问题。在并发情况下,数据的准确性必然会有影响。

我们设置 Trigger 触发周期为1s一次,在 Job 的 Exceute 方法中加入代码:

1
Thread.Sleep(2000);

并发的结果

很明显结果的错误的,但这时我们可以通过在 Job 类上加上 DisallowConcurrentExecution Attribute,就可以完美解决并发问题。

1
2
3
4
5
[DisallowConcurrentExecution]
public class HelloJob : IJob
{
// ...
}

无并发的结果

参考链接:

如果对你有帮助就好