AI 助理
备案控制台
开发者社区 云计算 文章 正文

Quartz3定时任务学习之异步调度器

2022-03-11 927
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Quartz3定时任务学习之异步调度器Quartz3与Quartz2的主要区别有两点：1，Quartz3将它的资源类库拆的更细了，比如，想使用Quartz3开发，最少要引用Quartz，Quartz.Jobs，Quartz.Plugins这三个类库。2，Quartz3整体上使用的是异步创建实例，所以我们使用时就必须要async，await的语法。下面我们用Quartz3来做一个任务调度。

Quartz3定时任务学习之异步调度器

Quartz3与Quartz2的主要区别有两点：

1，Quartz3将它的资源类库拆的更细了，比如，想使用Quartz3开发，最少要引用Quartz，Quartz.Jobs，Quartz.Plugins这三个类库。

2，Quartz3整体上使用的是异步创建实例，所以我们使用时就必须要async，await的语法。

下面我们用Quartz3来做一个任务调度。

创建调度器管理类

首先创建Jops类库，然后在Nuget中搜索Quartz.Plugins；如下图：

18.png

因为Quartz.Plugins依赖于Quartz，所以引入Quartz.Plugins就会自动引入Quartz。

然后我们创建任务调度管理类—ScheduleControler。代码如下：

publicclassScheduleControler
{
privatestaticIScheduler scheduler;
privatestaticDictionary<IJobDetail, IReadOnlyCollection<ITrigger>> dicJop = newDictionary<IJobDetail, IReadOnlyCollection<ITrigger>>();
privatestaticint triggerId = 0;
privatestaticstring defaultGroupName = "默认组";
/// <summary>
/// 初始化调度器
/// </summary>
/// <returns></returns>
publicstaticasyncTaskInit()
{
try
{
//quartz.config配置文件里的键值对
//NameValueCollection props = new NameValueCollection
//{
//   { "quartz.serializer.type", "binary" }
//};
StdSchedulerFactory factory = newStdSchedulerFactory(); 
            scheduler = await factory.GetScheduler(); 
await scheduler.Start(); 
}
catch(SchedulerException se)
{
System.Console.WriteLine(se);
}
}
/// <summary>
/// 运行调度器任务
/// </summary>
/// <returns></returns>
publicstaticasyncTaskRun()
{
try
{
await scheduler.ScheduleJobs(dicJop, true);
}
catch(SchedulerException se)
{
System.Console.WriteLine(se);
}
}
/// <summary>
/// 关闭调度器
/// </summary>
/// <returns></returns>
publicstaticasyncTaskShutdown()
{
try
{ 
await scheduler.Shutdown(); 
}
catch(SchedulerException se)
{
System.Console.WriteLine(se);
}
}
/// <summary>
/// 添加任务
/// </summary>
/// <typeparam name="T">任务类型，继承Ijop</typeparam>
/// <param name="jopName">任务名</param>
/// <param name="Interval">运行间隔时间/秒**最小为1秒</param>
/// <param name="period">等待启动时间/秒**-1为马上启动</param>
/// <param name="repeatTime">重复次数**-1为永远运行</param>
/// <param name="endAt">在指定时间后结束/秒**0为不指定结束时间，默认值0</param>
publicstaticvoidPushJop<T>(string jopName, intInterval, int period=-1,int repeatTime=-1,int endAt=0)  where T:IJob
{
try
{
if(Interval<= 0)
{
Interval= 1;
}
if(period < -1)
{
                    period = -1;
}
if(repeatTime < -1)
{
                    repeatTime = -1;
} 
if(endAt < 0)
{
                    endAt = -1;
}
IJobDetail job = JobBuilder.Create<T>().WithIdentity(jopName, defaultGroupName).UsingJobData("Name", "IJobDetail").Build();
var triggerBuilder  = TriggerBuilder.Create().WithIdentity($"{jopName}.trigger{triggerId}", defaultGroupName);
if(period == -1)
{
                    triggerBuilder = triggerBuilder.StartNow();
}
else
{
DateTimeOffset dateTimeOffset = DateTimeOffset.Now.AddSeconds(period);
                    triggerBuilder = triggerBuilder.StartAt(dateTimeOffset);
}
if(endAt > 0)
{
                    triggerBuilder = triggerBuilder.EndAt(newDateTimeOffset(DateTime.Now.AddSeconds(endAt)));
}  
if(repeatTime == -1)
{
                    triggerBuilder = triggerBuilder.WithSimpleSchedule(x => x.WithIntervalInSeconds(Interval).RepeatForever());  
}
else
{
                    triggerBuilder = triggerBuilder.WithSimpleSchedule(x => x.WithRepeatCount(Interval).WithRepeatCount(repeatTime));
}
ITrigger trigger = triggerBuilder.UsingJobData("Name", "ITrigger")
.WithPriority(triggerId)//设置触发器优先级,当有多个触发器在相同时间出发时,优先级最高[数字最大]的优先
.Build(); 
                dicJop.Add(job, newHashSet<ITrigger>() { trigger }); 
                triggerId++; 
}
catch(SchedulerException se)
{
System.Console.WriteLine(se);
}
}
publicstaticvoidPushJop<T>(string jopName, string cronExpress) where T : IJob
{
try
{ 
IJobDetail job = JobBuilder.Create<T>().WithIdentity(jopName, defaultGroupName).UsingJobData("Name", "IJobDetail").Build(); 
ITrigger trigger = TriggerBuilder.Create()
.WithIdentity($"{jopName}.trigger{triggerId}", defaultGroupName)
.WithCronSchedule(cronExpress)
.ForJob(job)
.Build(); 
            dicJop.Add(job, newHashSet<ITrigger>() { trigger });
            triggerId++;
}
catch(SchedulerException se)
{
System.Console.WriteLine(se);
}
} 
}

可以看到调度器管理类中包含四个主要函数，如下：

运行调度器任务(Run)

初始化调度器(Init)

关闭调度器(Shutdown)

添加任务(PushJop)

应用程序通过这四个函数的调用，就可以使用Quartz了。

添加配置文件

quartz.config

quartz.config是调度器工厂StdSchedulerFactory的配置文件，我们可以在初始化调度器时配置，但显然在配置文件里设置更易于修改。

quartz.config内容如下：

# You can configure your scheduler in either <quartz> configuration section
# or in quartz properties file
# Configuration section has precedence
quartz.scheduler.instanceName = QuartzTest
# configure thread pool info
quartz.threadPool.type = Quartz.Simpl.SimpleThreadPool, Quartz
quartz.threadPool.threadCount = 10
quartz.threadPool.threadPriority = Normal
# job initialization plugin handles our xml reading, without it defaults are used
quartz.plugin.xml.type = Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz.Plugins
#指定quartz_jobs.xml路径
#quartz.plugin.xml.fileNames = ~/quartz_jobs.xml
# export this server to remoting context 使用CrystalQuartz 放开如下注释
quartz.scheduler.exporter.type = Quartz.Simpl.RemotingSchedulerExporter, Quartz
quartz.scheduler.exporter.port = 555
quartz.scheduler.exporter.bindName = QuartzScheduler
quartz.scheduler.exporter.channelType = tcp
quartz.scheduler.exporter.channelName = httpQuartz

如果在初始化时配置，参考如下代码：

NameValueCollection props = newNameValueCollection
{
{ "quartz.serializer.type", "binary"}
};
StdSchedulerFactory factory = newStdSchedulerFactory(props);

quartz_jobs.xml

quartzjobs.xml是任务配置文件，用于配置任务的。不过本文的调度器管理类已经通过的PushJop函数对任务进行了配置，所以就不需要在quartzjobs.xml文件中配置了，不过为了测试方便，我们还是添加一个quartzjobs.xml文件，因为quartz.config文件中指定配置了quartzjobs.xml，所以没有它会异常。

这里我们添加一个空的quartz_jobs.xml文件，如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- This file contains job definitions in schema version 2.0 format -->
<job-scheduling-dataxmlns="http://quartznet.sourceforge.net/JobSchedulingData"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"version="2.0">
<processing-directives>
<overwrite-existing-data>true</overwrite-existing-data>
</processing-directives>
<schedule>
</schedule>
</job-scheduling-data>

创建任务

创建一个任务类(Jop)用于处理业务操作，任务类需继承IJop接口，代码如下。

publicclassHelloJob: IJob
{
publicasyncTaskExecute(IJobExecutionContext context)
{
Task task = newTask(() => {
LogicMethod(context);
});
         task.Start();
await task;
}
publicvoidLogicMethod(IJobExecutionContext context)
{
Console.Out.WriteLine($"HelloJob DateTime:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}  Key:{context.JobDetail.Key} ");
} 
}

测试Quartz

创建一个新控制台项目—QuartzNetTest，引入Jops类库和Quartz.Plugins。

然后修改Main函数，配置HelloJob任务每三秒运行一次，如下：

staticvoidMain(string[] args)
{
ScheduleControler.Init().GetAwaiter().GetResult();
ScheduleControler.PushJop<HelloJob>("HelloWord", 3);
ScheduleControler.Run().GetAwaiter().GetResult();
var info = Console.ReadKey();
if(info.Key== ConsoleKey.Enter)
{
ScheduleControler.Shutdown().GetAwaiter().GetResult();
Console.WriteLine("结束");
}
Console.Read();
}

运行项目，如下图：

19.png

Quartz运行成功。

Quartz任务管理器

QuartzNet除了定时运行任务，还提供了任务管理器。下面我们一起新建一个Quartz的任务管理。

创建一个空的Web项目——QuartzNetWebManager。

20.png


添加依赖类库

Nuget搜索CrystalQuartz.Remote安装。

21.png

再搜索Quartz安装，注意这里安装的Quartz不是Quartz.Plugins。


22.png


这样Quartz的任务管理就创建完成了。

然后我们打开WebConfig，可以看到configuration下多了一个crystalQuartz节点，webServer下多了一个handlers，阅读配置文件，发现Quartz的任务管理器指定了网页CrystalQuartzPanel.axd为访问地址，。

WebConfig如下：

<crystalQuartz>
<provider>
<addproperty="Type"value="CrystalQuartz.Core.SchedulerProviders.RemoteSchedulerProvider, CrystalQuartz.Core"/>
<!-- Edit scheduler host value below =================================== -->
<addproperty="SchedulerHost"value="tcp://localhost:555/QuartzScheduler"/>
<!--                                 =================================== -->
</provider>
</crystalQuartz>
<system.webServer>
<handlers>
<addname="CrystalQuartzPanel"verb="*"path="CrystalQuartzPanel.axd"type="CrystalQuartz.Web.PagesHandler, CrystalQuartz.Web"/>
</handlers>
</system.webServer>

访问网址https://localhost:44302/CrystalQuartzPanel.axd，管理界面如下：

23.png


可以看到管理器中除了显示当前运行的任务，还提供删除任务，马上执行等等功能；非常方便。

当然，Quartz还有很多功能，我们可以去官网学习。

QuartzNet官网：https://www.quartz-scheduler.net/

------------------------------------------------------

代码已经传到Github上了，欢迎大家下载。

Github地址：https://github.com/kiba518/QuartzTest

本文作者：kiba518，全栈.Net软件工程师

声明：本文为 脚本之家专栏作者 投稿，未经允许请勿转载。

文章标签：
调度
游客bpby77s4lannm
目录
相关文章
葛淼罡
|
5月前
|
监控 安全 Java
任务调度和异步执行相关的功能
任务调度和异步执行相关的功能
葛淼罡
25 0
宁在春
|
6月前
|
消息中间件 安全 Java
一起来探究@Schedule定时任务在分布式产生的问题
一起来探究@Schedule定时任务在分布式产生的问题
宁在春
393 0
ice*wind
|
Java API 调度
ThreadPoolTaskScheduler轻量级多线程定时任务框架
面对一些小的功能需求点，如果需要非常灵活的进行处理定时任务处理，但是又因为你的需求需要使用到页面进行定时任务配置，显然使用Spring注解定时任务，无法满足你，这时你想到了xxl-job 或者 quezy等定时任务框架，但是过于繁琐，可能成本较大。那么本文将要解决你的问题
ice*wind
2228 0
yangnk42
|
存储 开发框架 Java
分布式定时任务框架Quartz总结和实践（1）
Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目，它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或 EJBs。
yangnk42
188 0
爱编程的大李子
|
Java 调度 Maven
定时任务组件Quartz
定时任务组件Quartz
爱编程的大李子
129 0
定时任务组件Quartz
游客kbuanlzoibg3i
|
存储 运维 Java
分布式定时任务-Quartz
分布式定时任务-Quartz
游客kbuanlzoibg3i
446 0
分布式定时任务-Quartz
游客kbuanlzoibg3i
|
存储 运维 Java
分布式定时任务-QuartzJava编程
分布式定时任务-QuartzJava编程
游客kbuanlzoibg3i
194 0
分布式定时任务-QuartzJava编程
琦彦
|
存储 Java 数据库连接
Quartz：任务调度实现原理
Quartz：任务调度实现原理
琦彦
1282 0
Quartz：任务调度实现原理
爱余星痕
quartz获取定时任务下次执行的时间
quartz很多人都会用，但需要配置cronExpression. 这个cronExpression很多技术人员都要配置，但很多情况，我们要知道这个cronExpression下次执行的时间是啥，让非技术人员很直观的看到下一个定时任务的执行时间。
爱余星痕
3155 0
尘光掠影
|
关系型数据库 Java 数据库连接
spring框架使用Quartz执行定时任务实例详解
版权声明：本文为博主原创文章，如需转载，请标明出处。 https://blog.csdn.net/alan_liuyue/article/details/80382324 Quartz简介 　　１．Quartz，是一个完全由java编写的开源作业调度框架。
尘光掠影
1197 0