项目总是很忙,忙里偷闲还是要总结一下,前一段时间,由于项目中需要,我们需要很多定时汇总数据的情况,项目初期主要使用sql server 计划任务实现对数据的汇总与统计,但是开发到一定时间内,需求提出了很多自动任务的功能,很多不是能够在SQL Server中进行解决的,例如订单关闭前多少分钟内发短信与邮箱告诉用户,程序层面每天汇总错误日志发送至运维邮箱等,针对目前情况,简单上网查了一下,决定使用TopShelf + Quartz 进行自动服务与任务调度,关于这两项的介绍也很多了,废话不多说,直接上代码:
项目结构图如下:
任务调度与任务实现实质是两个完全不同的东西,所以自动服务于Job执行是应该分开的,所以任务创建时应该吧Job加载到任务调度工程,最后告诉调度工厂,可以开始执行任务之后,调度工厂会进行扫描Job,加载到内存中挨个执行。
IAutoService: 主要是声明自动服务的接口模式,标记了服务的名称,启动时的加载等,统一由抽象类AutoServcieBase实现。
public interface IAutoService
{
/// <summary>
/// 服务名称
/// </summary>
string ServiceName { get; } /// <summary>
/// 启动方法
/// </summary>
void Start(); /// <summary>
/// 是否启用
/// </summary>
bool IsEnable { get; }
}
AutoServiceBase: 抽象类实现接口原则,规范自动任务的可选参数,统一封装调用,定义抽象方法与属性,子类重写。
public abstract class AutoServiceBase : IAutoService
{
public IQuartzConfiguration QuartzConfiguration { get; set; } public IQuartzScheduleJobManager QuartzScheduleJobManager { get; set; } public const string ServiceGroupName = "AutoService.Groups"; /// <summary>
/// 服务名称
/// </summary>
public virtual string ServiceName { get { return "服务启动..."; } } /// <summary>
/// 任务调度
/// </summary>
public virtual Action<TriggerBuilder> ConfigureTrigger { get; } public virtual bool IsEnable { get { return true; } } /// <summary>
/// 获取服务方法名称
/// </summary>
/// <returns></returns>
public abstract string GetServiceIdentiy(); /// <summary>
/// 启动任务
/// </summary>
public abstract void Start(); }
定义好基础服务后,接下来我们就要使用TopShelf搭建一个属于我们自己的windows service了,代码如下:
class Program
{
static void Main(string[] args)
{
HostFactory.Run(x =>
{
x.Service<Service>(s =>
{
s.ConstructUsing(name => new Service());
s.WhenStarted(tc => tc.Start());
s.WhenStopped(tc => tc.Stop());
s.WhenShutdown(tc => tc.Shutdown());
});
x.RunAsLocalSystem();
x.SetDescription("服务集合,包含自动化消息,响应队列的领域事件");
x.SetDisplayName("Test.Services");
x.SetServiceName("Test.Services");
});
}
}
topshelf是一个很简单就能创建service的工具,它开源在GitHub TopShelf上,是一款快速搭建mono与windows service ,在编写好我们的服务代码,只需简单地启动代码,就能创建一个持久化的服务,不过想要兼容在Mono上也是非常简单,只需加入如下一句代码即可。
x.UseLinuxIfAvailable();
在我们的项目中windows service不仅仅是任务调度的寄宿形式,同时也是我们Event Store,对DDD感兴趣的同学可以了解CQRS中SAGA模式中事件消费的形式,这个不在本文讨论。
创建好我们的基础服务后,接下来就是对任务调度工厂的设置,任务调度简单来看,我们往往要使用事件监听,任务总调度工厂等等,这里Quartz很好的集成了这些,我们只需进行简单的改造就能够实现如上功能。
QuartzScheduleJobManager:实现任务调度管理,在这里可以对总任务调度工厂进行启动,停止,加载Job等
public interface IQuartzScheduleJobManager
{
/// <summary>
/// 增加任务与任务调度到任务工厂
/// </summary>
/// <typeparam name="TJob"></typeparam>
/// <param name="configureJob">任务</param>
/// <param name="configureTrigger">任务调度</param>
/// <returns></returns>
Task ScheduleAsync<TJob>(Action<JobBuilder> configureJob, Action<TriggerBuilder> configureTrigger) where TJob : IJob; /// <summary>
/// 启动任务
/// </summary>
void Start(); /// <summary>
/// 等待任务完成并停止任务
/// </summary>
void ShutDown();
} public class QuartzScheduleJobManager : IQuartzScheduleJobManager
{
private readonly IQuartzConfiguration _quartzConfiguration; public QuartzScheduleJobManager(
IQuartzConfiguration quartzConfiguration)
{
_quartzConfiguration = quartzConfiguration;
} /// <summary>
/// 增加任务与任务调度到任务工厂
/// </summary>
/// <typeparam name="TJob"></typeparam>
/// <param name="configureJob">任务</param>
/// <param name="configureTrigger">任务调度</param>
/// <returns></returns>
public Task ScheduleAsync<TJob>(Action<JobBuilder> configureJob, Action<TriggerBuilder> configureTrigger)
where TJob : IJob
{
var jobToBuild = JobBuilder.Create<TJob>();
configureJob(jobToBuild);
var job = jobToBuild.Build(); var triggerToBuild = TriggerBuilder.Create();
configureTrigger(triggerToBuild);
var trigger = triggerToBuild.Build(); _quartzConfiguration.Scheduler.ScheduleJob(job, trigger); return Task.FromResult();
} /// <summary>
/// 启动任务
/// </summary>
public void Start()
{
//启动任务调度框架
if (!_quartzConfiguration.Scheduler.IsStarted)
{
_quartzConfiguration.Scheduler.Start();
}
} /// <summary>
/// 等待任务完成并停止任务
/// </summary>
public void ShutDown()
{
if (_quartzConfiguration.Scheduler.IsStarted && !_quartzConfiguration.Scheduler.IsShutdown)
{
_quartzConfiguration.Scheduler.Shutdown();
}
}
}
IQuartzConfiguration是对IScheduler的一个简单封装,创建默认的调度程序:
public class QuartzConfiguration : IQuartzConfiguration
{
public IScheduler Scheduler => StdSchedulerFactory.GetDefaultScheduler();
}
接下来就是任务监听,Quartz提供了一个很好的扩展,我们只需实现IJobListener接口即可,包含如下多个方法体:
- JobExecutionVetoed
- JobToBeExecuted
- JobWasExecuted
查看字面意思,我们就能很好理解就是对每一个job在执行中的阶段所对应的事件,方法体内给出IJobExecutionContext当前执行的上下文,通过上下文我们可以输出许多我们想要的东西,例如当前执行Job的Name,执行时间,等等,也提供了JobExecutionException等异常信息,可以监控Job执行过程中发生的错误,很方便。
好了在我们的寄宿服务,与基础服务搭建完毕后,接下来就是要实现在业务系统中我们自身的逻辑结构了,核心程序类Servcie.cs,在service中我们需要将我们如上的配置进行加载,并同时扫描我们业务系统中的定时服务类,挨个进行启动,代码如下:
public class Service
{
/// <summary>
/// 任务调度框架
/// </summary>
private IQuartzScheduleJobManager QuartzScheduleJobManager
{
get
{
return IocManager.Instance.Resolve<IQuartzScheduleJobManager>();
}
} /// <summary>
/// 任务调度配置
/// </summary>
public IQuartzConfiguration QuartzConfiguration
{
get
{
return IocManager.Instance.Resolve<IQuartzConfiguration>();
}
} public Service()
{
try
{
//注册我们的任务调度程序配置
IocManager.Register<IQuartzConfiguration, QuartzConfiguration>();
//注册任务监听程序到Ioc
IocManager.Register<IJobListener, QuartzJobListener>();
//声明一个接口可以被多个实例实现
IocManager.IocContainer.Kernel.Resolver.AddSubResolver(new ArrayResolver(TongTongMallBootstrapper.IocManager.IocContainer.Kernel, true));
}
catch (Exception ex)
{
LogHelper.LogException(ex);
}
}
//设置我们的配置项
public void QuartzConfigurationInitialize()
{
//Job映射工厂
QuartzConfiguration.Scheduler.JobFactory = new QuartzJobFactory(IocManager.Instance);
//Job 监听配置
QuartzConfiguration.Scheduler.ListenerManager.AddJobListener(IocManager.Instance.Resolve<IJobListener>());
} /// <summary>
/// 基础类服务
/// </summary>
public void Start()
{
//订阅各项自动服务
IocManager.Instance.IocContainer.Register(Classes.FromThisAssembly().BasedOn<IAutoService>().WithService.Base()); QuartzConfigurationInitialize(); RegisterService();
} /// <summary>
/// 停止自动服务
/// </summary>
public void Stop()
{
QuartzScheduleJobManager.ShutDown();
} /// <summary>
/// 结束自动服务
/// </summary>
public void Shutdown()
{
TongTongMallBootstrapper.Dispose();
QuartzScheduleJobManager.ShutDown();
} /// <summary>
/// 注册服务
/// </summary>
/// <param name="args"></param>
public void RegisterService()
{
foreach (var service in IocManager.Instance.IocContainer.ResolveAll<IAutoService>())
{
if (service.IsEnable)
{
LogHelper.Logger.Debug($"{service.ServiceName}服务正在启动中...");
service.Start();
}
}
LogHelper.Logger.Debug($"任务总调度工厂启动!");
QuartzScheduleJobManager.Start();
}
}
在系统中我们主要使用了IOC进行了一个服务的自动扫描与切入,在服务配置完毕后,接下来我们只需定义业务相关的自动服务即可,通过继承我们的抽象类AutoServiceBase,接下来就很方便的打造每一个自动任务调度了,而关于Quartz的任务调度形式与时间配置,不是本文的重点介绍内容,就不在详说,不过在任务调度中我们也可以实现很多自定义的时间调度模式,例如自定义的节假日,或者每周一执行任务调度都可以,这个需要进行进一步编码实现。
由于公司方面,代码就不在给连接资源下载了,代码给出只是思路,当然在这里面还可以有更多的扩展,而本文只是方便快速上手为第一原则,文章有写的不当的地方,请及时指出,如本文对您有所帮助,也请点个推荐,您的肯定也是是我最大的动力。thanks