伟德betvictot手机版 26

作业调度框架,自建定时任务

在我们平时项目中经常会遇到定时任务,比如定时同步数据,定时备份数据,定时统计数据等,定时任务我们都知道使用Quartz.net,此系列写的也是Quartz,但是在此之前,我们先用其他方式做个简单的定时任务进行入门。

注:目前网上诸多介绍Quartz.net的文章,甚至Quartz.net官网上的Tutorial都是1.0版本的,而这个项目在2.0版本对项目进行了比较大规模的修改,使得原有的很多例子都不能运行,故写此文。由于本人是边学边用,加之技术写作水平皆有限,错误自然难免,望轻拍,我将不定时更新完善此贴,希望能为需要的朋友提供帮助。

我们通常在一些情况下需要软件具有一个自动执行某些任务的功能,但是又不希望直接启动软件,或者每次都要手动的来启动软件,这时我们可可以考虑到windows服务了。

首先呢,我们现在自己先写一个简单的定时循环任务,话不多说,直接上代码:

1. 项目介绍

首先创建一个windows服务项目(详细信息请参阅:C#创建Windows
Service(Windows
服务)基础教程

第一步:创建项目,新建一个类库:我们命名为TaskBase

    
现今的系统,业务数据是越来越大,传统的同步处理方式有时候已经不能满足用户需求,定时后台服务这种异步数据处理形式则逐渐被大家接受。相信大家在平时的工作中也经常遇到数据同步,或是定时邮件,短信提醒等需求,Quartz.net(官网
)可以很好满足对多个windows服务的管理及监控,同时在保证开发简单的情况下不失灵活,是非常优秀的作业调度框架。

    伟德betvictot手机版 1

第二部:添加一个抽象基础类BaseMonitor:

和其他绝大多数开源项目一样Quartz.net也包含了其他几个优秀的开源项目:

在创建好的项目中点击“单击此处切换到代码视图”切换到代码

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace TaskBase
{
    /// <summary>
    /// 监测基础抽象类
    /// </summary>
    public abstract class BaseMonitor
    {

        protected System.Threading.Thread _thread;
        /// <summary>
        /// 监控时间间隔(毫秒)
        /// </summary>
        public virtual int Interval { get; set; }

        public virtual string Name { get; set; }
        /// <summary>
        /// 监控器状态
        /// </summary>
        public virtual TaskState State { get; set; }
        public BaseMonitor(string name)
        {
            Name = name;
            _thread = new System.Threading.Thread(BaseRun);
            _thread.IsBackground = true;//获取或设置一个值,该值指示某个线程是否为后台线程
            _thread.Start();
            State = TaskState.运行;
        }
        private void BaseRun()
        {          
            while (State==TaskState.运行)
            {
                try
                {
                    Run();
                    System.Threading.Thread.Sleep(Interval);
                }
                catch (Exception ex)
                {
                    State = TaskState.异常;
                    PCore.Log.LogTextHelper.WriteErrorLog(this.GetType().Name + "监控出现错误,此监视器已暂停!", ex);
                }
            }
        }
        protected virtual void Run()
        { }
    }
}

核心   —-Common.Logging(通用日志接口)

我们主要关注一下两个方法:

(代码中PCore.Log.LogTextHelper.WriteErrorLog
是一个写文本日志的方法,可自行写个此方法。)

         —-C5(泛型集合类)

  • OnStart – 控制服务启动
伟德betvictot手机版,  • OnStop – 控制服务停止

 注:此定时任务基础类 是用 System.Threading.Thread
实现,其中 TaskState为一个枚举来表示任务的状态:

示例程序

  例:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace TaskBase
{
   public enum TaskState
    {
        未开始=0,
        运行=1,
        暂停=2,
        异常=3
    }
}

         —-log4net(日志记录-通用日志接口实现)

伟德betvictot手机版 2伟德betvictot手机版 3

第三部:添加一个继承BaseMonitor的TestMontior类,代码如下:

         —-topshelf(跨平台服务宿主程序)

 1     public partial class Service1 : ServiceBase
 2     {
 3         public Service1()
 4         {
 5             InitializeComponent();
 6         }
 7 
 8         protected override void OnStart(string[] args)
 9         {
10             //todo:这里是服务启动所执行的代码
11         }
12 
13         protected override void OnStop()
14         {
15             //todo:这里是服务停止所执行的代码
16         }
17     }
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace TaskBase
{
   public class TestMontior:BaseMonitor
    {
        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="name">检测器名称</param>
        public TestMontior(string name) : base(name)
        {
        }
        /// <summary>
        /// 监控时间间隔(毫秒)
        /// </summary>
        public override int Interval
        {
            get
            {
              return  GlobalConfig.TestMonitorInterval;
            }          
        }
        public override string Name
        {
            get
            {
                return base.Name;
            }

            set
            {
                base.Name = value;
            }
        }

        public override TaskState State
        {
            get
            {
                return base.State;
            }

            set
            {
                base.State = value;
            }
        }
        protected override void Run()
        {          
            PCore.Log.LogTextHelper.WriteLog("TestMontitor监测器正在监测");
        }
    }
}

  Quartz.net使用的许可是Apache
License,商业友好,使用者可以修改源码用于开源或商业项目,只需包含许可及修改说明。

View Code

注:TestMontior
相当于我们的Job,代码中 GlobalConfig是我定义的一个全局参数类:

2. Quartz.net开发思路

 下面我们可以写一个定时任务的功能了:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace TaskBase
{
   public static class GlobalConfig
    {
        public static int TestMonitorInterval
        {
            get { return 100 * 10; }
        }

        public static List<BaseMonitor> Monitor = new List<BaseMonitor>();
    }
}

 

  

创建完成之后就是这个样子:

  我们来了解下Quartz.net中常用的几个概念:

 1      private void StartDoSomething()
 2         {
 3             System.Timers.Timer timer = new System.Timers.Timer(10000); //间隔10秒
 4             timer.AutoReset = true;
 5             timer.Enabled = false;  //执行一次
 6             timer.Elapsed += new ElapsedEventHandler(ExecutionCode);
 7             timer.Start();
 8         }
 9 
10         private void ExecutionCode(object source, System.Timers.ElapsedEventArgs e)
11         {
12             string dtNow = DateTime.Now.ToString("HH:mm");
13             if (dtNow == "12:00")
14             {
15                 File.WriteAllText("D:/ExecutionService.txt", "服务执行了一次任务", Encoding.UTF8);
16             }
17         }

伟德betvictot手机版 4

  Scheduler  ———主调度程序 ——— Quartz核心

然后在OnStart的方法中调用上面的StartDoSomething的方法

定时任务的基础类库已经创建完毕,下面我们来看怎么使用它。

  Job        ———作业  ——— 服务要做的(业务操作)

1         protected override void OnStart(string[] args)
2         {
3             StartDoSomething();
4         }    

 第四部:在WEB中使用:创建一个WEB 
MVC项目,引用TaskBase,然后在Global.asax中添加以下代码:

  Trigger     ———触发器  ——— 服务执行条件(何时执行操作)

以上就可以算是一个简单的定时执行任务的windows服务了,这里我们还可以使用Quartz.Net来实现更加强大的任务调度功能。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;

namespace WebTaskTest
{
    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);


           TaskBase.GlobalConfig.Monitor.Add(new TaskBase.TestMontior("测试监控器Test"));//注册定时任务


        }
    }
}

  Listener    ———事件监听器  ——— 执行期事件(Job执行前后/
Scheduler启动终止暂停时应该做什么,可以挂一些特定事件)

 

运行WEB站点,查看日志如下:

  了解了这些概念之后,我们就可以组合这些概念并整理出开发的思路:

首先来介绍一下Quartz.Net这个框架:

伟德betvictot手机版 5

 
先利用SchedulerFactory构建一个Scheduler,启动Scheduler,之后构建Job和Trigger,若有作业监听需求,在Listener上添加相应的处理程序,再将Job和Trigger关联后放入Scheduler

  简介:Quartz.Net是一个开源的任务调度框架,非常强大,能够通过简单的配置帮助我们定时具体的操作。相对于我们用的线程里面while(true)然后sleep来执行某个操作,应该算的上是高端,大气,上档次了。目前最新版本是2.2,新的版本里面有些方法名发生了变化,从之前的版本用过来的人应该会有体会.这里我使用最常用,也是最稳定的方式–Windows服务里面使用Quartz.net,并且使用配置的方式来设置触发器。(以上内容摘自网络)

可以看到一秒钟执行一次
,因为我们在GlobalConfig.TestMonitorInterval设置的就是一秒钟。

3. Quartz.net的简单使用

  简单的理解就是它能够帮我们定时的做事,相当于闹钟能够叫我们起床一样。

下面我们看如何在windows
server中如何使用:

               1. 新建一个控制台程序,引用Quartz.dll和Common.Logging.dll

  目前最新的版本是Quartz.NET
2.2.3 大家可以在这里下载

创建一个WindowsServerTest类库,引用TaskBse,添加一个windows服务:

              
2. 新建一个类,命名为SampleJob,继承并实现接口Quartz.IJob         

 

using Quartz;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Diagnostics;
using System.Linq;
using System.ServiceProcess;
using System.Text;
using System.Threading.Tasks;

namespace WindowsServerTest
{
    partial class TestService : ServiceBase
    {
        public TestService()
        {
            InitializeComponent();
        }

        protected override void OnStart(string[] args)
        {
            try
            {
                // TODO: 在此处添加代码以启动服务。
                PCore.Log.LogTextHelper.WriteLog("OnStart:Test服务开始...");

               TaskBase.GlobalConfig.Monitor.Add(new TaskBase.TestMontior("测试监控器Test"));//注册监视器




            }
            catch (Exception ex)
            {
                PCore.Log.LogTextHelper.WriteErrorLog("出错了",ex);
            }
        }

        protected override void OnStop()
        {

            // TODO: 在此处添加代码以执行停止服务所需的关闭操作。
            PCore.Log.LogTextHelper.WriteLog("OnStop:Test服务结束...");
        }
        protected override void OnPause()
        {
            PCore.Log.LogTextHelper.WriteLog("OnPause:Test服务暂停...");
        }
        protected override void OnContinue()
        {
            PCore.Log.LogTextHelper.WriteLog("OnContinue:Test服务继续...");
        }
    }
}

伟德betvictot手机版 6伟德betvictot手机版 7View Code

  现在我们需要在刚刚创建的服务项目中引用如下文件:

关于windows服务的安装卸载可自行百度,再此不多哔哔了。

public class SampleJob : IJob
    {
        public void Execute(IJobExecutionContext context)
        {
            File.AppendAllText("C:\Quartz.txt", "SampleJob Is Run");
            File.AppendAllText("C:\Quartz.txt", Environment.NewLine);  
        }
    }

    伟德betvictot手机版 8

安装好服务开始后,我们查看下日志如下:

             
3.在Program.cs的main方法中写如下代码后运行这个控制台会程序会发现已经SampleJob中的Execute方法已经执行

  在配置文件中写好自己的配置(本例子演示定时访问指定网站)

 伟德betvictot手机版 9

 

伟德betvictot手机版 10伟德betvictot手机版 11

 

伟德betvictot手机版 12伟德betvictot手机版 13View Code

 1 <?xml version="1.0"?>
 2 <configuration>
 3   <configSections>
 4     <sectionGroup name="JobList">
 5       <section name="Job" type="MyService1101.MyConfigHandler,MyService1101"/>
 6     </sectionGroup>
 7   </configSections>
 8   <startup>
 9     <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
10   </startup>
11   <JobList>
12     <Job>   <!--这里是一个任务节点-->
13       <add key="Url" value="http://www.baidu.com" />  <!--需要访问的Url-->
14       <add key="Hour" value="10" />   <!--开始时间小时,注意:这里的小时为0-23,如果是1点的话就是1,而不是01-->
15       <add key="Minute" value="30"/>    <!--开始时间分钟,注意:同上0-59-->
16     </Job>
17   </JobList>
18 </configuration>

此节中我们简单做了一个定时任务,下章我们将进行Quartz.net任务框架的介绍。(源代码会跟随后面的例子一并上传),请继续关注以后章节。

  ISchedulerFactory  factory = new StdSchedulerFactory();
            IScheduler scheduler = factory.GetScheduler();
            scheduler.Start();
            IJobDetail job = JobBuilder.Create<SampleJob>().WithIdentity("SampleJob", "JobGroup1").Build();
            ITrigger trigger = TriggerBuilder.Create().StartNow().Build();
            scheduler.ScheduleJob(job, trigger);

View Code

 

4. 使用topshelf创建WINDOWS服务

 

      注:此部分张善友同学已经写过
),此节为保证思路连贯,简单介绍并引用部分代码**  

  新建一个MyConfigHandler.cs类来读取自定义配置节点

 
也许有的网友会疑问,以控制台程序作为服务宿主还没有意义的,这时轮到Topshelf出场了,
使用它可以很方便的构建跨平台服务寄主,而在调试时直接以控制台的形式运行即可,非常方便。
我们引入topshelf.dll及
log4net.dll(topshelf需要),将之前main中代码放到服务类里,把main方法变为Host构建

伟德betvictot手机版 14伟德betvictot手机版 15

             服务类代码:

 1 public class MyConfigHandler : IConfigurationSectionHandler
 2     {
 3         public MyConfigHandler()
 4         {
 5         }
 6 
 7         public object Create(object parent, object configContext, System.Xml.XmlNode section)
 8         {
 9             NameValueCollection configs;
10             NameValueSectionHandler baseHandler = new NameValueSectionHandler();
11             configs = (NameValueCollection)baseHandler.Create(parent, configContext, section);
12             return configs;
13         }
14     }

伟德betvictot手机版 16伟德betvictot手机版 17View Code

View Code

  public class SampleService
    {
        ISchedulerFactory factory;
        IScheduler scheduler;
        public void Start()
        {
            File.AppendAllText("C:\Quartz.txt", "SampleService Is Run");
            File.AppendAllText("C:\Quartz.txt", Environment.NewLine);
            factory = new StdSchedulerFactory();
            scheduler = factory.GetScheduler();
            scheduler.Start();
            IJobDetail job = JobBuilder.Create<SampleJob>().WithIdentity("SampleJob", "JobGroup1").Build();
            ITrigger trigger = TriggerBuilder.Create().StartNow().Build();          
            scheduler.ScheduleJob(job, trigger);
        }
        public void Stop()
        {
            scheduler.Clear();
            File.AppendAllText("C:\Quartz.txt", "SampleService Is Stop");
            File.AppendAllText("C:\Quartz.txt", Environment.NewLine);
        }
    }

 

 

  然后新建一个SystemScheduler类来创建调度程序

            修改后的Main代码

伟德betvictot手机版 18伟德betvictot手机版 19

伟德betvictot手机版 20伟德betvictot手机版 21View Code

 1     public class SystemScheduler
 2     {
 3         private SystemScheduler()
 4         {
 5         }
 6 
 7         public static SystemScheduler CreateInstance()
 8         {
 9             return new SystemScheduler();
10         }
11 
12         private IScheduler _scheduler;
13 
14         public void StartScheduler()
15         {
16             //这里读取配置文件中的任务开始时间
17             int hour = int.Parse(((NameValueCollection)ConfigurationSettings.GetConfig("JobList/Job"))["Hour"]);
18             int minute = int.Parse(((NameValueCollection)ConfigurationSettings.GetConfig("JobList/Job"))["Minute"]);
19 
20             ISchedulerFactory schedulerFactory = new StdSchedulerFactory();//内存调度
21             _scheduler = schedulerFactory.GetScheduler();
22 
23             //创建一个Job来执行特定的任务
24             IJobDetail synchronousData = new JobDetailImpl("SynchronousData", typeof(SynchronousData));
25             //创建并定义触发器的规则(每天执行一次时间为:时:分)
26             ITrigger trigger =
27                 TriggerBuilder.Create()
28                     .WithDailyTimeIntervalSchedule(
29                         a => a.WithIntervalInHours(24).OnEveryDay().StartingDailyAt(TimeOfDay.HourAndMinuteOfDay(hour, minute))).Build();
30             //将创建好的任务和触发规则加入到Quartz中
31             _scheduler.ScheduleJob(synchronousData, trigger);
32             //开始
33             _scheduler.Start();
34         }
35 
36         public void StopScheduler()
37         {
38             _scheduler.Shutdown();
39         }
40     }
        static void Main(string[] args)
        {
            var host = HostFactory.New(x =>
            {
                x.EnableDashboard(); x.Service<SampleService>(s =>
{
    s.SetServiceName("SampleService"); s.ConstructUsing(name => new SampleService());
    s.WhenStarted(tc => { tc.Start(); });
    s.WhenStopped(tc => tc.Stop());
});
                x.RunAsLocalSystem();
                x.SetDescription("SampleService Description");
                x.SetDisplayName("SampleService");
                x.SetServiceName("SampleService");
            });
            host.Run();

        }

View Code

 

 

            编译后,cmd进到exe所在目录,并执行”项目名.exe
install/uninstall” 完成服务的安装与卸载

  新建一个SynchronousData类,让其实现IJob接口来实现SystemScheduler中自定义的任务

 

伟德betvictot手机版 22伟德betvictot手机版 23

 1     public class SynchronousData : IJob
 2     {
 3         public void Execute(IJobExecutionContext context)
 4            {
 5             string Url = ((NameValueCollection)ConfigurationSettings.GetConfig("JobList/Job"))["Url"];
 6             WebClient wc = new WebClient();
 7             WebRequest wr = WebRequest.Create(new Uri(Url));
 8             using (StreamWriter sw = File.AppendText(@"d:SchedulerService.txt"))
 9             {
10                 sw.WriteLine("------------------" + "MyService服务在:" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") + "     执行了一次任务" + "------------------");
11                 sw.Flush();
12             }
13         }
14     }

View Code

 

  最后在OnStart中添加对这个调度程序的应用

1         protected override void OnStart(string[] args)
2         {
3             SystemScheduler _systemScheduler = SystemScheduler.CreateInstance();
4             _systemScheduler.StartScheduler();
5         }   

 

  程序生成后我们可以通过指令安装它

伟德betvictot手机版 24

  安装完成后在服务中会有一个新的服务项

  伟德betvictot手机版 25

  程序运行过后会在D:盘生成一个SchedulerService.txt文件

  伟德betvictot手机版 26

 

  本程序源码:下载

伟德betvictot手机版 27

伟德betvictot手机版 28

发表评论