CronScheduler.AspNetCore 使用教程

1. 项目介绍

CronScheduler.AspNetCore 是一个轻量级的 Cron 调度器，专为 .NET Core IHost 或 IWebHost 设计。它遵循 KISS（Keep It Simple, Stupid）原则，旨在简化任务调度，提供一个比 Quartz Scheduler 更简便的替代方案。CronScheduler 支持使用 Cron 语法轻松调度任务，并且可以在任何 .NET Core GenericHost IHost 中运行，使得设置和配置变得非常简单。此外，它还引入了 IStartupJob，支持异步初始化关键进程，确保应用程序在复杂的 Kubernetes 环境中也能顺利启动。

2. 项目快速启动

安装

首先，使用 .NET CLI 安装 CronScheduler.AspNetCore 包：

dotnet add package CronScheduler.AspNetCore

配置

在 Program.cs 文件中配置 CronScheduler：

using CronScheduler.AspNetCore;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);

// 添加 CronScheduler 服务
builder.Services.AddScheduler(builder =>
{
    builder.AddJob<TestJob>();
});

var app = builder.Build();

// 配置 HTTP 请求管道
if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseExceptionHandler("/Home/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.MapControllers();
app.MapDefaultControllerRoute();

await app.RunAsync();

定义任务

创建一个实现 IScheduledJob 接口的任务类：

public class TestJob : IScheduledJob
{
    public string Name => nameof(TestJob);

    public async Task ExecuteAsync(CancellationToken cancellationToken)
    {
        // 任务执行逻辑
        Console.WriteLine("TestJob is running...");
        await Task.Delay(1000, cancellationToken);
    }
}

3. 应用案例和最佳实践

应用案例

CronScheduler 适用于需要定时执行任务的场景，例如：

• 数据备份：定期备份数据库或文件系统。
• 日志清理：定期清理过期的日志文件。
• 定时报告：生成并发送定时报告。

最佳实践

• 任务命名：确保任务名称唯一且有意义，便于管理和调试。
• 错误处理：在任务执行过程中添加适当的错误处理机制，避免任务失败影响整个应用。
• 日志记录：记录任务的执行情况，便于后续分析和排查问题。

4. 典型生态项目

CronScheduler 可以与其他 .NET Core 生态项目结合使用，例如：

• Hangfire：另一个流行的任务调度库，可以与 CronScheduler 结合使用，提供更丰富的调度功能。
• Kubernetes：在 Kubernetes 环境中部署应用时，CronScheduler 可以与 Kubernetes 的 CronJob 结合使用，实现更复杂的调度需求。
• Docker：使用 Docker 容器化部署应用时，CronScheduler 可以轻松集成到 Docker 环境中，实现容器内的任务调度。

通过以上步骤，您可以快速上手并使用 CronScheduler.AspNetCore 进行任务调度。希望本教程对您有所帮助！