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

一、quartz.net介绍

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

二、快速搭建

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

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

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

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

 

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

5.安装搭建服务用的：topshelf 以及其所依赖的 topshelf.log4net

 

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

6.添加我们的测试程序文件：jobtest.cs，该文件实现quartz的ijob接口

 1 using system;
 2 using log4net;
 3 using quartz;
 4 
 5 namespace jobtest
 6 {
 7     public class testjob : ijob
 8     {
 9         private readonly ilog _logger = logmanager.getlogger(typeof(testjob));
10         public void execute(ijobexecutioncontext context)
11         {
12             _logger.infoformat("测试输出");
13         }
14     }
15 }

jobtest

7.添加用于topshelf调度的文件：servicerunner.cs

 1 using quartz;
 2 using quartz.impl;
 3 using topshelf;
 4 
 5 namespace jobtest
 6 {
 7     public sealed class servicerunner : servicecontrol, servicesuspend
 8     {
 9         private readonly ischeduler scheduler;
10 
11         public servicerunner()
12         {
13             scheduler = stdschedulerfactory.getdefaultscheduler();
14         }
15 
16         public bool start(hostcontrol hostcontrol)
17         {
18             scheduler.start();
19             return true;
20         }
21 
22         public bool stop(hostcontrol hostcontrol)
23         {
24             scheduler.shutdown(false);
25             return true;
26         }
27 
28         public bool continue(hostcontrol hostcontrol)
29         {
30             scheduler.resumeall();
31             return true;
32         }
33 
34         public bool pause(hostcontrol hostcontrol)
35         {
36             scheduler.pauseall();
37             return true;
38         }
39     }
40 }

servicerunner

8.添加程序的入口文件：program.cs

 1 using system;
 2 using system.collections.generic;
 3 using system.io;
 4 using system.linq;
 5 using system.text;
 6 using system.threading.tasks;
 7 using topshelf;
 8 
 9 namespace jobtest
10 {
11     class program
12     {
13         static void main(string[] args)
14         {
15             log4net.config.xmlconfigurator.configureandwatch(new fileinfo(appdomain.currentdomain.basedirectory + "log4net.config"));
16             hostfactory.run(x =>
17             {
18                 x.uselog4net();
19 
20                 x.service<servicerunner>();
21 
22                 x.setdescription("定时作业");
23                 x.setdisplayname("jobtest");
24                 x.setservicename("jobtest");
25 
26                 x.enablepauseandcontinue();
27             });
28         }
29     }
30 }

program.cs

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

 1 <?xml version="1.0" encoding="utf-8" ?>
 2 <configuration>
 3   <configsections>
 4     <section name="log4net" type="log4net.config.log4netconfigurationsectionhandler, log4net"/>
 5   </configsections>
 6 
 7   <log4net>
 8     <appender name="rollinglogfileappender" type="log4net.appender.rollingfileappender">
 9       <!--日志路径-->
10       <param name= "file" value= "d:\app_log\servicelog\jobtest\"/>
11       <!--是否是向文件中追加日志-->
12       <param name= "appendtofile" value= "true"/>
13       <!--log保留天数-->
14       <param name= "maxsizerollbackups" value= "10"/>
15       <!--日志文件名是否是固定不变的-->
16       <param name= "staticlogfilename" value= "false"/>
17       <!--日志文件名格式为:2008-08-31.log-->
18       <param name= "datepattern" value= "yyyy-mm-dd&quot;.read.log&quot;"/>
19       <!--日志根据日期滚动-->
20       <param name= "rollingstyle" value= "date"/>
21       <layout type="log4net.layout.patternlayout">
22         <param name="conversionpattern" value="%d [%t] %-5p %c - %m%n %loggername" />
23       </layout>
24     </appender>
25 
26     <!-- 控制台前台显示日志 -->
27     <appender name="coloredconsoleappender" type="log4net.appender.coloredconsoleappender">
28       <mapping>
29         <level value="error" />
30         <forecolor value="red, highintensity" />
31       </mapping>
32       <mapping>
33         <level value="info" />
34         <forecolor value="green" />
35       </mapping>
36       <layout type="log4net.layout.patternlayout">
37         <conversionpattern value="%n%date{hh:mm:ss,fff} [%-5level] %m" />
38       </layout>
39 
40       <filter type="log4net.filter.levelrangefilter">
41         <param name="levelmin" value="info" />
42         <param name="levelmax" value="fatal" />
43       </filter>
44     </appender>
45 
46     <root>
47       <!--(高) off > fatal > error > warn > info > debug > all (低) -->
48       <level value="all" />
49       <appender-ref ref="coloredconsoleappender"/>
50       <appender-ref ref="rollinglogfileappender"/>
51     </root>
52   </log4net>
53 </configuration>

log4net.config

10.添加配置文件：quartz.config

 1 # you can configure your scheduler in either <quartz> configuration section
 2 # or in quartz properties file
 3 # configuration section has precedence
 4 
 5 quartz.scheduler.instancename = quartztest
 6 
 7 # configure thread pool info
 8 quartz.threadpool.type = quartz.simpl.simplethreadpool, quartz
 9 quartz.threadpool.threadcount = 10
10 quartz.threadpool.threadpriority = normal
11 
12 # job initialization plugin handles our xml reading, without it defaults are used
13 quartz.plugin.xml.type = quartz.plugin.xml.xmlschedulingdataprocessorplugin, quartz
14 quartz.plugin.xml.filenames = ~/quartz_jobs.xml
15 
16 # export this server to remoting context
17 #quartz.scheduler.exporter.type = quartz.simpl.remotingschedulerexporter, quartz
18 #quartz.scheduler.exporter.port = 555
19 #quartz.scheduler.exporter.bindname = quartzscheduler
20 #quartz.scheduler.exporter.channeltype = tcp
21 #quartz.scheduler.exporter.channelname = httpquartz

quartz.config

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

 1 <?xml version="1.0" encoding="utf-8"?>
 2 
 3 <!-- this file contains job definitions in schema version 2.0 format -->
 4 
 5 <job-scheduling-data xmlns="http://quartznet.sourceforge.net/jobschedulingdata" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" version="2.0">
 6 
 7   <processing-directives>
 8     <overwrite-existing-data>true</overwrite-existing-data>
 9   </processing-directives>
10 
11   <schedule>
12 
13     <!--testjob测试 任务配置-->
14     <job>
15       <name>testjob</name>
16       <group>test</group>
17       <description>testjob测试</description>
18       <job-type>jobtest.testjob,jobtest</job-type>
19       <durable>true</durable>
20       <recover>false</recover>
21     </job>
22     <trigger>
23       <cron>
24         <name>testjobtrigger</name>
25         <group>test</group>
26         <job-name>testjob</job-name>
27         <job-group>test</job-group>
28         <start-time>2015-01-22t00:00:00+08:00</start-time>
29         <cron-expression>0/3 * * * * ?</cron-expression>
30       </cron>
31     </trigger>
32   </schedule>
33 </job-scheduling-data>

quartz_jobs.xml

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

 

逗号之前：jobtest.testjob

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

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

 

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

 

三、搭建服务

1.将项目的生成方式切换成release，至于release和debug的区别，可自行百度啦

然后重新生成项目

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

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

 

4.启动服务

 

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

 

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

7.最后，友情提示，将服务关闭并卸载服务（jobtest.exe uninstall）：

 

四、总结

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

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

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

 

最后，尽情体验quartz.net给你带来的实现定时作业的快感吧！๑乛◡乛๑