使用 Topshelf 組件一步一步創建 Windows 服務 (2) 使用Quartz.net 調度

上一篇說了如何使用 Topshelf 組件快速創建Windows服務，接下來介紹如何使用 Quartz.net

關於Quartz.net的好處，網上搜索都是一大把一大把的，我就不再多介紹。

先介紹需要用到的插件：

Quartz版本我用的 2.6.2的， 沒有用3.0以上的，因為你用了就會知道，會打印出一大堆坑爹的日志文件，

我是沒有找到如何屏蔽的辦法，如果你們誰有，歡迎分享出來，我也學習一下，哈哈。

整個項目結構如下：

AppConfigHelper 文件需要改動一下，增加如下屬性

        /// <summary>
        /// 程序標識
        /// </summary>
        [ConfigurationProperty("AppKey", IsRequired = true)]
        public string AppKey
        {
            get { return base["AppKey"].ToString(); }
            internal set { base["AppKey"] = value; }
        }

        /// <summary>
        /// 程序集信息
        /// </summary>
        [ConfigurationProperty("TypeInfo", IsRequired = true)]
        public string TypeInfo
        {
            get { return base["TypeInfo"].ToString(); }
            internal set { base["TypeInfo"] = value; }
        }

AppConfig文件也做稍微改動

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <!--該節點一定要放在最上邊-->
  <configSections>
    <section name="AppConfigHelper" type="Quartz.WinService.AppConfigHelper,Quartz.WinService"/>
  </configSections>

  <!--TopSelf服務配置文件 -->
  <AppConfigHelper
    ServiceName="ProcessPrintLogService"
    Desc="日志打印服務"
    AppKey="ProcessPrintLogService"
    TypeInfo="ProcessService.ProcessPrintLogService,ProcessService"
  />

  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
  </startup>
</configuration>

ProcessPrintLogService 就是Windows服務要執行的邏輯程序文件，可以執行任何你想要的功能

ProcessService.ProcessPrintLogService,ProcessService 是 命名空間.類名,類名  的格式，用於后邊反射程序集用

假如你要執行其他業務邏輯程序，只需要更換這里的配置就行，

ProcessPrintLogService 業務邏輯內容如下：這就是我們要執行的業務邏輯，定時打印一段日志內容，可以創建一個類庫，里邊專門存放你要執行的業務邏輯

namespace ProcessService
{
    /// <summary>
    /// 日志打印服務
    /// </summary>
    public class ProcessPrintLogService
    {
        private Logger log = LogManager.GetCurrentClassLogger();
        /// <summary>
        /// 服務入口
        /// </summary>
        public void DoWork()
        {
            //log.Info("******************排行榜服務開始執行******************");
            try
            {
                PrintLogMethod();
            }
            catch (Exception ex)
            {
                log.Error(string.Format("排行榜服務異常，原因：{0}", ex));
            }
            finally
            {
                //log.Info("******************排行榜服務結束執行******************");
            }
        }


        private void PrintLogMethod()
        {
            log.Trace(string.Format("我是日志:{0}號", Thread.CurrentThread.ManagedThreadId));
        }
    }
}

然后需要新增加兩個文件：quartz.config  和  quartz_jobs.xml

quartz.config文件內容如下：

# You can configure your scheduler in either <quartz> configuration section
# or in quartz properties file
# Configuration section has precedence

quartz.scheduler.instanceName = ServiceQuartzScheduler

# 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
quartz.plugin.xml.fileNames = ~/quartz_jobs.xml

# 3.0以上用以下配置
# quartz.plugin.xml.type = Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz.Plugins
# 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 = 555
# quartz.scheduler.exporter.bindName = QuartzScheduler
# quartz.scheduler.exporter.channelType = tcp
# quartz.scheduler.exporter.channelName = httpQuartz

quartz.scheduler.instanceName = ServiceQuartzScheduler 是調度的實例名稱，可以隨意自定義命名
其他的都是固定的，不需要修改

quartz_jobs.xml 文件內容如下：

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

<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>
    <!--調度配置-->
    <job>
      <name>ProcessPrintLogService</name>
      <group>ProcessPrintLogServiceGroup</group>
      <description>日志打印服務</description>
      <job-type>Quartz.WinService.QuartzWork,Quartz.WinService</job-type>
      <durable>true</durable>
      <recover>false</recover>
    </job>
    <trigger>
      <cron>
        <name>ProcessPrintLogServiceTrigger</name>
        <group>ProcessPrintLogServiceTriggerGroup</group>
        <job-name>ProcessPrintLogService</job-name>
        <job-group>ProcessPrintLogServiceGroup</job-group>
        <misfire-instruction>SmartPolicy</misfire-instruction>
        <cron-expression>0/3 * * * * ? </cron-expression>
      </cron>
    </trigger>
  </schedule>
</job-scheduling-data>

這個xml配置文件很重要! 需要重點說下

首先 job節點 和 trigger節點 都可以定義多個，也就是一個服務可以跑多個不同的業務邏輯程序

先說 job節點

• name(必填) 任務名稱，多個job的name不能相同，這里一般使用業務邏輯程序的名稱就行了
• group(選填) 任務所屬分組，用於標識任務所屬分組，一般用業務邏輯程序的名稱+Group后綴   如:<group>sampleGroup</group>
• description(選填) 任務描述，用於描述任務具體內容，如:<description>打印日志服務</description>
• job-type(必填) 任務類型，任務的具體類型及所屬程序集，格式：實現了IJob接口的包含完整命名空間的類名,程序集名稱，如:<job-type>Quartz.Server.SampleJob, Quartz.Server</job-type>
• durable(選填) 具體作用不知，官方示例中默認為true，如:<durable>true</durable>
• recover(選填) 具體作用不知，官方示例中默認為false，如:<recover>false</recover>

這里的 job-type 節點調用的任務類型需要說下，這里設置的就是上邊項目結構中的 QuartzWork 類，具體內容如下：

namespace Quartz.WinService
{
    public class QuartzWork : IJob
    {
        private Logger log = LogManager.GetCurrentClassLogger();
        //ConcurrentDictionary是線程安全的字典集
        private readonly ConcurrentDictionary<string, Lazy<Delegate>> _dynamicCache = new ConcurrentDictionary<string, Lazy<Delegate>>();

        //記錄當前工作接口是否已經工作
        private static readonly Dictionary<string, bool> WorkingNow = new Dictionary<string, bool>();

        /// <summary>
        /// 任務調度執行入口
        /// 實現IJob的Execute方法,在Execute方法里編寫要處理的業務邏輯，系統就會按照Quartz的配置，定時處理
        /// 當Job的trigger觸發的時候, Execute(..) 方法就會在scheduler的工作線程中執行
        /// </summary>
        /// <param name="context"></param>
        public void Execute(IJobExecutionContext context)
        {
            try
            {
                Task.Factory.StartNew(() =>
                {
                    var service = AppConfigHelper.Initity();
                    WorkNow(service);
                });
            }
            catch (Exception ex)
            {
                log.Fatal($"執行Quartz調度異常，信息：{ex.Message}");
            }
            //return Task.FromResult(true);  //返回一個bool類型的Task, Quartz 3.0版本以上需要用到
        }

        private void WorkNow(AppConfigHelper service)
        {
            string key = service.AppKey;  //key值
            lock (this)
            {
                if (!WorkingNow.ContainsKey(key))
                {
                    WorkingNow.Add(key, false);
                }
                //如果執行則跳出
                if (WorkingNow[key])
                {
                    log.Trace($"服務key:{key} 正在運行,此次服務忽略");
                    return;
                }
                //並且設置為執行狀態
                WorkingNow[key] = true;
            }
            try
            {
                var type = Type.GetType(service.TypeInfo);  //這里通過App.config文件設置
                if (type != null)
                {
                    //創建指定類型的實例,相當於通過反射new了一個對象實例
                    var provider = Activator.CreateInstance(type);
                    Dynamic(provider, "DoWork", key);
                }
                else
                {
                    log.Error($"任務:{key} 實例化失敗");
                }
            }
            catch (Exception ex)
            {
                log.Fatal($"任務:{key} 實例化異常：{ex.Message}");
            }
            finally
            {
                WorkingNow[key] = false;
            }
        }

        //Delegate.CreateDelegate 官方定義:用來動態創建指定類型的委托，該委托可以對指定的類實例調用的指定的方法。
        //簡單來說:就是可以調用指定類里邊指定的方法,前提是,使用時需要實例化該類
        //GetOrAdd函數會根據指定key判斷是否存在對應內容,存在則返回
        //DynamicInvoke 動態調用委托方法
        //obj參數就是指定類的實例化對象,methodName指定類中的方法名
        private void Dynamic(object obj, string methodName, string key)
        {
            var dmc = _dynamicCache.GetOrAdd(key, t => new Lazy<Delegate>(() => Delegate.CreateDelegate(typeof(Action), obj, methodName)));
            dmc.Value.DynamicInvoke();   //動態調用委托方法
        }

    }
}

接下來說 trigger  節點

trigger 任務觸發器，用於定義使用何種方式出發任務(job)，同一個job可以定義多個trigger ，多個trigger 各自獨立的執行調度，

每個trigger 中必須且只能定義一種觸發器類型(calendar-interval、simple、cron)

說白些就是，假如你要一個服務分別在 上午 8:00~18:00   和  凌晨 00:00 ~ 6:00  這兩個時間段執行任務，那么你可以設置兩個 trigger 觸發器，

分別設置為這兩個時間段即可實現你要的結果，怎么樣，很牛X吧

• name(必填) 觸發器名稱，一般以 業務邏輯類+Trigger結尾， 如果需要設置多個 trigger節點，該名稱不能相同
• group(選填) 觸發器組  一般以 業務邏輯類+TriggerGroup結尾，多個 trigger節點，該名稱可以相同
• job-name(必填) 要調度的任務名稱，該job-name必須和對應job節點中的name名稱完全相同
• job-group(選填) 調度任務(job)所屬分組，該值必須和job節點中的group名稱完全相同
• misfire-instruction 不知道干啥用,這么寫就行  <misfire-instruction>SmartPolicy</misfire-instruction>
• cron-expression(必填) cron表達式，如:<cron-expression>0/10 * * * * ?</cron-expression>每10秒執行一次

需要注意的是修改了quartz_jobs.xml文件后，quartz服務默認不會重新加載該文件，若要讓修改后的文件生效需要重啟下服務才行。

另外，quartz.config文件 和 quartz_jobs.xml文件 都需要在項目中設置，右鍵-->屬性-->復制到輸出目錄-->始終復制

 

服務注冊文件 RegistService 增加了自動重啟功能，完整內容如下：

namespace Quartz.WinService
{
    public class RegistService
    {
        /// <summary>
        /// 注冊入口
        /// </summary>
        /// <param name="config">配置文件</param>
        /// <param name="isreg">是否注冊</param>
        public static void Regist(AppConfigHelper config, bool isreg = false)
        {
            //這里也可以使用HostFactory.Run()代替HostFactory.New()
            var host = HostFactory.New(x =>
            {
                x.Service<QuartzHost>(s =>
                {
                    //通過 new QuartzHost() 構建一個服務實例 
                    s.ConstructUsing(name => new QuartzHost());
                    //當服務啟動后執行什么
                    s.WhenStarted(tc => tc.Start());
                    //當服務停止后執行什么
                    s.WhenStopped(tc => tc.Stop());
                    //當服務暫停后執行什么
                    s.WhenPaused(w => w.Stop());
                    //當服務繼續后執行什么
                    s.WhenContinued(w => w.Start());
                });

                if (!isreg) return; //false表示不注冊

                //服務用本地系統賬號來運行
                x.RunAsLocalSystem();

                //啟用自動重啟服務
                x.EnableServiceRecovery(v =>
                {
                    v.RestartService(2);  //2分鍾后重啟
                });

                //服務的描述信息
                x.SetDescription(config.Description);
                //服務的顯示名稱
                x.SetDisplayName(config.ServiceName);
                //服務的名稱（最好不要包含空格或者有空格屬性的字符）Windows 服務名稱不能重復。
                x.SetServiceName(config.ServiceName);
            }).Run();   //啟動服務  如果使用HostFactory.Run()則不需要該方法
        }
    }
}

服務注冊中調用的 QuartzHost 類內容如下：

namespace Quartz.WinService
{
    public class QuartzHost
    {
        private Logger log = LogManager.GetCurrentClassLogger();
        private readonly IScheduler scheduler;
        public QuartzHost()
        {
            //初始化調度服務
            //scheduler = StdSchedulerFactory.GetDefaultScheduler().Result;  //3.0以上寫法
            scheduler = StdSchedulerFactory.GetDefaultScheduler();
        }

        /// <summary>
        /// 調度開始
        /// </summary>
        public void Start()
        {
            try
            {
                scheduler.Start();
                log.Info("Quartz調度服務開始工作");
            }
            catch (Exception ex)
            {
                log.Fatal(string.Format("Quartz調度服務開始異常！錯誤信息：{0}", ex));
                throw;
            }
        }

        /// <summary>
        /// 調度停止
        /// </summary>
        public void Stop()
        {
            try
            {
                if (scheduler != null)
                {
                    scheduler.Shutdown(true);
                }
                log.Info("Quartz調度服務結束工作");
            }
            catch (Exception ex)
            {
                log.Fatal(string.Format("Quartz調度服務停止異常！錯誤信息：{0}", ex));
                throw;
            }
        }
    }
}

項目文件地址：https://gitee.com/gitee_zhang/Quartz.WinService.git


參考文檔：

https://blog.csdn.net/clb929/article/details/90341485

https://blog.csdn.net/weixin_33948416/article/details/92989386

https://www.cnblogs.com/lzrabbit/archive/2012/04/14/2446942.html