您好，登录后才能下订单哦！
密码登录
登录注册
点击 登录注册 即表示同意《亿速云用户服务条款》
# .NET Core开发Windows服务之怎么使用Quartz执行定时任务
## 前言
在现代企业级应用开发中，定时任务是一个不可或缺的功能模块。无论是数据同步、报表生成、系统维护还是消息推送，都需要依赖可靠的定时任务调度系统。在.NET Core生态中，Quartz.NET作为最受欢迎的作业调度框架之一，为开发者提供了强大的定时任务管理能力。
本文将深入探讨如何在.NET Core环境下开发Windows服务，并集成Quartz.NET来实现复杂的定时任务调度。我们将从基础概念讲起，逐步深入到高级应用场景，最后还会分享性能优化和最佳实践。
## 一、Windows服务与定时任务基础
### 1.1 Windows服务概述
Windows服务（Windows Service）是在Windows操作系统后台运行的程序，具有以下特点：
- 无需用户交互界面
- 随系统启动而自动运行
- 在后台持续执行特定功能
- 可通过服务管理器控制启动/停止
### 1.2 .NET Core对Windows服务的支持
从.NET Core 3.0开始，微软正式引入了对Windows服务开发的原生支持。主要涉及以下核心组件：
```csharp
Microsoft.Extensions.Hosting.WindowsServices
这个包提供了将通用主机（Generic Host）配置为Windows服务的能力。
在.NET生态中，实现定时任务主要有以下几种方式：
| 方式 | 优点 | 缺点 |
|---|---|---|
| Timer类 | 简单易用 | 功能有限，缺乏任务管理 |
| Hangfire | 开源，支持持久化 | 需要额外存储 |
| Quartz.NET | 功能强大，支持复杂调度 | 学习曲线较陡 |
| Azure Functions | 无服务器架构 | 依赖云平台 |
Quartz.NET是一个功能丰富的开源作业调度库，其核心架构包含以下几个关键组件：
与2.x版本相比，3.x版本带来了重大改进： - 完全支持.NET Standard 2.0 - 异步API支持 - 改进的依赖注入集成 - 性能优化 - 更简洁的API设计
使用命令行创建项目：
dotnet new worker -n MyWindowsService
cd MyWindowsService
dotnet add package Quartz
dotnet add package Microsoft.Extensions.Hosting.WindowsServices
或者通过Visual Studio创建Worker Service项目。
建议采用以下项目结构：
MyWindowsService/
├── Services/ # 服务层
│ ├── QuartzService.cs # Quartz服务封装
├── Jobs/ # 作业定义
│ ├── SampleJob.cs # 示例作业
├── Models/ # 数据模型
├── appsettings.json # 配置文件
└── Program.cs # 程序入口
修改Program.cs文件：
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
IHost host = Host.CreateDefaultBuilder(args)
.UseWindowsService(options =>
{
options.ServiceName = "My Quartz Service";
})
.ConfigureServices(services =>
{
services.AddQuartz(q =>
{
q.UseMicrosoftDependencyInjectionJobFactory();
});
services.AddQuartzHostedService(q => q.WaitForJobsToComplete = true);
})
.Build();
await host.RunAsync();
在Jobs文件夹下创建SampleJob.cs：
using Quartz;
using System.Threading.Tasks;
public class SampleJob : IJob
{
private readonly ILogger<SampleJob> _logger;
public SampleJob(ILogger<SampleJob> logger)
{
_logger = logger;
}
public Task Execute(IJobExecutionContext context)
{
_logger.LogInformation($"SampleJob executed at {DateTime.Now}");
return Task.CompletedTask;
}
}
修改服务配置部分：
services.AddQuartz(q =>
{
q.UseMicrosoftDependencyInjectionJobFactory();
var jobKey = new JobKey("SampleJob");
q.AddJob<SampleJob>(opts => opts.WithIdentity(jobKey));
q.AddTrigger(opts => opts
.ForJob(jobKey)
.WithIdentity("SampleJob-trigger")
.WithCronSchedule("0/5 * * * * ?")); // 每5秒执行一次
});
Quartz支持完整的cron表达式语法，以下是一些常用示例：
| 表达式 | 说明 |
|---|---|
0 0 12 * * ? |
每天中午12点执行 |
0 15 10 ? * MON-FRI |
工作日早上10:15执行 |
0 0/5 14,18 * * ? |
每天14点和18点，每隔5分钟执行 |
0 0-5 14 * * ? |
每天14:00到14:05每分钟执行 |
可以通过JobDataMap在调度时传递数据：
// 添加作业时传递数据
q.AddJob<SampleJob>(opts => opts
.WithIdentity(jobKey)
.UsingJobData("param1", "value1")
.UsingJobData("param2", 123));
// 在作业中获取数据
public Task Execute(IJobExecutionContext context)
{
var data = context.JobDetail.JobDataMap;
string param1 = data.GetString("param1");
int param2 = data.GetInt("param2");
// ...
}
默认情况下，Quartz允许作业并发执行。如需禁止并发，可以使用[DisallowConcurrentExecution]特性：
[DisallowConcurrentExecution]
public class SampleJob : IJob
{
// ...
}
Quartz提供了多种监听器用于监控作业执行：
// 创建作业监听器
public class SampleJobListener : IJobListener
{
public string Name => "SampleJobListener";
public Task JobToBeExecuted(IJobExecutionContext context,
CancellationToken cancellationToken = default)
{
// 作业即将执行
return Task.CompletedTask;
}
// 其他方法实现...
}
// 注册监听器
q.AddJobListener<SampleJobListener>();
services.AddSingleton<SampleJobListener>();
dotnet add package Quartz.Serialization.Json
dotnet add package Quartz.Plugins.TimeZoneConverter
{
"Quartz": {
"jobStore": {
"type": "Quartz.Impl.AdoJobStore.JobStoreTX, Quartz",
"driverDelegateType": "Quartz.Impl.AdoJobStore.SqlServerDelegate, Quartz",
"tablePrefix": "QRTZ_",
"dataSource": "default",
"useProperties": "true"
},
"dataSource": {
"default": {
"connectionString": "Server=.;Database=QuartzNet;Integrated Security=true;",
"provider": "SqlServer"
}
}
}
}
services.AddQuartz(q =>
{
q.UsePersistentStore(s =>
{
s.UseSqlServer("Server=.;Database=QuartzNet;Integrated Security=true;");
s.UseJsonSerializer();
s.UseClustering();
});
});
在集群环境中，需要确保： 1. 所有节点使用相同的数据库 2. 配置唯一的实例ID 3. 设置适当的检查间隔
q.UsePersistentStore(s =>
{
s.UseSqlServer(connectionString);
s.UseClustering(c =>
{
c.CheckinInterval = TimeSpan.FromSeconds(10);
c.CheckinMisfireThreshold = TimeSpan.FromSeconds(15);
});
s.InstanceId = Environment.MachineName + DateTime.Now.Ticks;
});
public class SampleJob : IJob
{
public async Task Execute(IJobExecutionContext context)
{
try
{
// 业务逻辑
}
catch (Exception ex)
{
// 记录错误
context.Scheduler.Context.Put("LastError", ex);
// 可以重新抛出以触发监听器
throw new JobExecutionException(ex, false);
}
}
}
创建自定义的作业工厂：
public class CustomJobFactory : MicrosoftDependencyInjectionJobFactory
{
private readonly ILogger<CustomJobFactory> _logger;
public CustomJobFactory(IServiceProvider serviceProvider,
ILogger<CustomJobFactory> logger) : base(serviceProvider)
{
_logger = logger;
}
public override IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
{
try
{
return base.NewJob(bundle, scheduler);
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to create job instance");
throw;
}
}
}
Quartz内置了LibLog库，可以与常见的日志框架集成。例如与Serilog集成：
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Information()
.Enrich.FromLogContext()
.WriteTo.Console()
.WriteTo.File("logs\\quartz-service-.txt", rollingInterval: RollingInterval.Day)
.CreateLogger();
services.AddLogging(builder =>
{
builder.AddSerilog(dispose: true);
});
dotnet publish -c Release -o ./publish
sc create "MyQuartzService" binPath="C:\path\to\publish\MyWindowsService.exe"
sc start MyQuartzService
sc stop MyQuartzService
sc delete MyQuartzService
可以通过修改注册表配置服务失败时的恢复策略：
sc failure "MyQuartzService" reset= 60 actions= restart/10000/restart/10000/restart/10000
建议监控以下关键指标： - 作业执行时间 - 作业执行频率 - 作业失败率 - 调度器负载
可以使用Application Insights或Prometheus等工具进行监控。
假设我们需要开发一个数据同步服务，具有以下功能： - 每天凌晨2点从API获取数据 - 每小时检查一次增量更新 - 失败后自动重试3次 - 支持手动触发同步
[DisallowConcurrentExecution]
[PersistJobDataAfterExecution]
public class DataSyncJob : IJob
{
private readonly IDataService _dataService;
private readonly ILogger<DataSyncJob> _logger;
public DataSyncJob(IDataService dataService, ILogger<DataSyncJob> logger)
{
_dataService = dataService;
_logger = logger;
}
public async Task Execute(IJobExecutionContext context)
{
var retryCount = context.JobDetail.JobDataMap.GetInt("RetryCount");
try
{
await _dataService.SyncDataAsync();
context.JobDetail.JobDataMap.Put("RetryCount", 0);
}
catch (Exception ex)
{
if (retryCount >= 3)
{
_logger.LogError(ex, "Data sync failed after 3 retries");
throw new JobExecutionException(ex, false);
}
var delay = TimeSpan.FromMinutes(Math.Pow(2, retryCount));
context.JobDetail.JobDataMap.Put("RetryCount", ++retryCount);
_logger.LogWarning(ex, $"Data sync failed, will retry in {delay.TotalMinutes} minutes");
throw new JobExecutionException(ex) {
RefireImmediately = false,
UnscheduleAllTriggers = false,
UnscheduleFiringTrigger = true
};
}
}
}
services.AddQuartz(q =>
{
var jobKey = new JobKey("DataSyncJob");
q.AddJob<DataSyncJob>(opts => opts
.WithIdentity(jobKey)
.StoreDurably()
.UsingJobData("RetryCount", 0));
// 每日全量同步
q.AddTrigger(opts => opts
.ForJob(jobKey)
.WithIdentity("DataSyncJob-Daily")
.WithDailyTimeIntervalSchedule(s =>
s.OnEveryDay()
.StartingDailyAt(TimeOfDay.HourAndMinuteOfDay(2, 0))));
// 每小时增量同步
q.AddTrigger(opts => opts
.ForJob(jobKey)
.WithIdentity("DataSyncJob-Hourly")
.WithSimpleSchedule(s =>
s.WithIntervalInHours(1)
.RepeatForever()));
});
作业设计原则：
线程池配置：
q.UseThreadPool(tp =>
{
tp.MaxConcurrency = Environment.ProcessorCount * 2;
tp.MaxConcurrency = 10; // 根据实际情况调整
});
q.UseDefaultThreadPool(tp =>
{
tp.MaxConcurrency = 10;
});
q.ScheduleJobs = async scheduler =>
{
// 仅当需要时调度作业
};
作业幂等性：
配置管理：
健康检查：
services.AddHealthChecks()
.AddCheck<QuartzHealthCheck>("quartz");
app.MapHealthChecks("/health");
通过本文的详细介绍，我们学习了如何在.NET Core Windows服务中集成Quartz.NET来实现强大的定时任务功能。从基础配置到高级特性，从单机部署到集群环境，Quartz.NET提供了企业级应用所需的各种调度功能。
在实际项目中，建议根据具体需求选择合适的配置方案，并遵循本文提到的最佳实践。Quartz.NET虽然功能强大，但也需要合理使用才能发挥最大价值。
希望本文能帮助你在.NET Core项目中实现可靠、高效的定时任务调度系统。如有任何问题或建议，欢迎交流讨论。
本文完整示例代码可在GitHub获取：示例仓库链接 “`
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。