FluentScheduler 技术文档

1. 安装指南

FluentScheduler 是一个面向 .NET 平台的自动化作业调度器，具有流畅的接口设计。下面是安装步骤：

• 首先，确保你的开发环境已经安装了 .NET 开发工具。

• 使用 NuGet 包管理器安装 FluentScheduler 包。在 Visual Studio 中，你可以通过 NuGet 包管理器控制台执行以下命令：

  Install-Package FluentScheduler
  

或者在项目的 .csproj 文件中添加以下依赖项：

<PackageReference Include="FluentScheduler" Version="最新版本号" />

确保将 "最新版本号" 替换为实际的最新版本号。

2. 项目的使用说明

FluentScheduler 通过 JobManager 类来管理作业。下面是基本的使用步骤：

// 初始化作业管理器
JobManager.Initialize();

// 添加作业
JobManager.AddJob(
    () => Console.WriteLine("5 minutes just passed."), // 作业执行的代码
    s => s.ToRunEvery(5).Minutes()                      // 作业调度的设置
);

在这个例子中，我们添加了一个作业，该作业会在控制台打印一条消息，并且每5分钟执行一次。

调度设置

调度设置允许你定义作业的执行频率。以下是可用的调度方法：

• ToRunEvery(int interval)：设置作业执行的时间间隔。
• Minutes()、Hours()、Days()：设置时间单位。
• At(int hour, int minute)：在指定的小时和分钟执行作业。
• Between(int startHour, int startMinute, int endHour, int endMinute)：在指定的时间范围内执行作业。

3. 项目API使用文档

FluentScheduler 的 API 设计为链式调用，易于理解和使用。以下是一些主要类的简要说明：

• JobManager：管理作业的主要类。它包含用于添加作业、开始和停止调度器的方法。
• Job：表示一个作业，它包含作业要执行的动作以及调度规则。

以下是 JobManager 的主要方法：

• Initialize()：初始化作业管理器。
• AddJob(Action action, Func<Schedule, Schedule> scheduleBuilder)：添加一个作业及其调度设置。
• Start()：开始执行作业调度。
• Stop()：停止执行作业调度。

4. 项目安装方式

项目的安装方式已在 "安装指南" 部分详细说明，这里简要概括如下：

• 通过 NuGet 包管理器在 Visual Studio 中安装。
• 手动在 .csproj 文件中添加包引用。
• 直接从 NuGet.org 下载包并手动添加到项目中。

请按照以上步骤操作，以成功安装 FluentScheduler 并开始使用。