浅谈Quartz.Net 从无到有创建实例

时间:2023-03-09 00:57:05
浅谈Quartz.Net 从无到有创建实例

一、Quartz.Net介绍

  Quartz.NET是一个开源的作业调度框架,非常适合在平时的工作中,定时轮询数据库同步,定时邮件通知,定时处理数据等。 Quartz.NET允许开发人员根据时间间隔(或天)来调度作业。它实现了作业和触发器的多对多关系,还能把多个作业与不同的触发器关联。整合了 Quartz.NET的应用程序可以重用来自不同事件的作业,还可以为一个事件组合多个作业。在我平时的工作中对于Quartz的使用比较频繁,正好利用空闲时间把这个做一个记录。

二、快速搭建

1.利用VS创建一个控制台的项目

浅谈Quartz.Net 从无到有创建实例

2.利用NuGet工具包安装所需要的依赖包

浅谈Quartz.Net 从无到有创建实例

3.首先安装:Quartz,这里选择我的项目一直在用的2.6的版本,目前为止最新的已经到了3.x

浅谈Quartz.Net 从无到有创建实例

安装完成之后在引用里面会多了一些新的引用

浅谈Quartz.Net 从无到有创建实例

4.安装我们的日志依赖包:log4net

浅谈Quartz.Net 从无到有创建实例

5.安装搭建服务用的:Topshelf 以及其所依赖的 Topshelf.Log4Net

浅谈Quartz.Net 从无到有创建实例

浅谈Quartz.Net 从无到有创建实例

至此,所用到的包基本已经安装完毕,下面是添加三个程序文件和三个配置文件。

6.添加我们的测试程序文件:JobTest.cs,该文件实现Quartz的IJob接口

 using System;
using log4net;
using Quartz; namespace JobTest
{
public class TestJob : IJob
{
private readonly ILog _logger = LogManager.GetLogger(typeof(TestJob));
public void Execute(IJobExecutionContext context)
{
_logger.InfoFormat("测试输出");
}
}
}

JobTest

7.添加用于Topshelf调度的文件:ServiceRunner.cs

 using Quartz;
using Quartz.Impl;
using Topshelf; namespace JobTest
{
public sealed class ServiceRunner : ServiceControl, ServiceSuspend
{
private readonly IScheduler scheduler; public ServiceRunner()
{
scheduler = StdSchedulerFactory.GetDefaultScheduler();
} public bool Start(HostControl hostControl)
{
scheduler.Start();
return true;
} public bool Stop(HostControl hostControl)
{
scheduler.Shutdown(false);
return true;
} public bool Continue(HostControl hostControl)
{
scheduler.ResumeAll();
return true;
} public bool Pause(HostControl hostControl)
{
scheduler.PauseAll();
return true;
}
}
}

ServiceRunner

8.添加程序的入口文件:Program.cs

 using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Topshelf; namespace JobTest
{
class Program
{
static void Main(string[] args)
{
log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo(AppDomain.CurrentDomain.BaseDirectory + "log4net.config"));
HostFactory.Run(x =>
{
x.UseLog4Net(); x.Service<ServiceRunner>(); x.SetDescription("定时作业");
x.SetDisplayName("JobTest");
x.SetServiceName("JobTest"); x.EnablePauseAndContinue();
});
}
}
}

Program.cs

9.添加配置文件:log4net.config

 <?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
</configSections> <log4net>
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
<!--日志路径-->
<param name= "File" value= "D:\App_Log\servicelog\JobTest\"/>
<!--是否是向文件中追加日志-->
<param name= "AppendToFile" value= "true"/>
<!--log保留天数-->
<param name= "MaxSizeRollBackups" value= ""/>
<!--日志文件名是否是固定不变的-->
<param name= "StaticLogFileName" value= "false"/>
<!--日志文件名格式为:--.log-->
<param name= "DatePattern" value= "yyyy-MM-dd&quot;.read.log&quot;"/>
<!--日志根据日期滚动-->
<param name= "RollingStyle" value= "Date"/>
<layout type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n %loggername" />
</layout>
</appender> <!-- 控制台前台显示日志 -->
<appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
<mapping>
<level value="ERROR" />
<foreColor value="Red, HighIntensity" />
</mapping>
<mapping>
<level value="Info" />
<foreColor value="Green" />
</mapping>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%n%date{HH:mm:ss,fff} [%-5level] %m" />
</layout> <filter type="log4net.Filter.LevelRangeFilter">
<param name="LevelMin" value="Info" />
<param name="LevelMax" value="Fatal" />
</filter>
</appender> <root>
<!--(高) OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL (低) -->
<level value="all" />
<appender-ref ref="ColoredConsoleAppender"/>
<appender-ref ref="RollingLogFileAppender"/>
</root>
</log4net>
</configuration>

log4net.config

10.添加配置文件: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 =
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
quartz.plugin.xml.fileNames = ~/quartz_jobs.xml # export this server to remoting context
#quartz.scheduler.exporter.type = Quartz.Simpl.RemotingSchedulerExporter, Quartz
#quartz.scheduler.exporter.port =
#quartz.scheduler.exporter.bindName = QuartzScheduler
#quartz.scheduler.exporter.channelType = tcp
#quartz.scheduler.exporter.channelName = httpQuartz

quartz.config

11.添加配置文件:quartz_jobs.xml

 <?xml version="1.0" encoding="UTF-8"?>

 <!-- This file contains job definitions in schema version 2.0 format -->

 <job-scheduling-data xmlns="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> <!--TestJob测试 任务配置-->
<job>
<name>TestJob</name>
<group>Test</group>
<description>TestJob测试</description>
<job-type>JobTest.TestJob,JobTest</job-type>
<durable>true</durable>
<recover>false</recover>
</job>
<trigger>
<cron>
<name>TestJobTrigger</name>
<group>Test</group>
<job-name>TestJob</job-name>
<job-group>Test</job-group>
<start-time>--22T00::+:</start-time>
<cron-expression>/ * * * * ?</cron-expression>
</cron>
</trigger>
</schedule>
</job-scheduling-data>

quartz_jobs.xml

注意:在这个xml文件中,job-type节点的配置容易出错,我总结了一下,逗号之前的是我们将要运行的程序命名空间的地址

逗号之前:JobTest.TestJob

浅谈Quartz.Net 从无到有创建实例

逗号之后是整个项目的命名空间,我们这里就是这个    JobTest

12.需要将三个配置文件的属性设置为始终复制,或者如果较新则复制,应该也是没问题的

浅谈Quartz.Net 从无到有创建实例

浅谈Quartz.Net 从无到有创建实例

13.启动项目,就可以看到如下效果

浅谈Quartz.Net 从无到有创建实例

三、搭建服务

1.将项目的生成方式切换成Release,至于Release和Debug的区别,可自行百度啦

浅谈Quartz.Net 从无到有创建实例

然后重新生成项目

2.找到项目生成的文件夹,此时会发现一个JobTest.exe的文件,也是我们搭建服务所用的主文件

浅谈Quartz.Net 从无到有创建实例

3.以管理员的身份运行cmd,并切换到上面程序生成的路径,之后输入JobTest.exe install 安装服务:

浅谈Quartz.Net 从无到有创建实例

4.启动服务

浅谈Quartz.Net 从无到有创建实例

5.此时,在我们的服务里就已经能看到我们创建的JobTest的服务了,并且已经启动了:

浅谈Quartz.Net 从无到有创建实例

6.此时,在我们之前的配置文件log4net.config中找到服务生成的日志文件的路径,并切换到该路径就可以看到生成的日志文件:

浅谈Quartz.Net 从无到有创建实例

浅谈Quartz.Net 从无到有创建实例

浅谈Quartz.Net 从无到有创建实例

7.最后,友情提示,将服务关闭并卸载服务(JobTest.exe uninstall):

浅谈Quartz.Net 从无到有创建实例

四、总结

  一个简单的Quartz项目已经创建完成并生成了服务,可以定时去完成你指定的任何作业了。但是Quartz中还有一些问题非常重要。

  首先就是quartz_jobs.xml文件中cron-expression节点的配置,该节点的配置内容决定了服务的定时循环作业的频率,详情可见博客:https://blog.csdn.net/lu_wei_wei/article/details/51251337

  其次就是每次服务启动,程序都会去运行一次,然后才会根据你设置的时间定时去运行,这样很多时候是会有一些问题在里面的,具体的会在项目里面,遇到,到时候就需要用一些这种的方法去解决这些问题。

最后,尽情体验Quartz.Net给你带来的实现定时作业的快感吧!๑乛◡乛๑