CronNET 使用详解

1. 安装指南

CronNET 的安装非常简便，首先确保您的开发环境已经配置了.NET环境。然后，通过NuGet包管理器来安装CronNET。

在您的项目文件中，添加以下代码来引入CronNET：

<PackageReference Include="Iminetsoft.CronNET" Version="8.0.2" />

或者在NuGet包管理器控制台中执行以下命令：

Install-Package Iminetsoft.CronNET -Version 8.0.2

确保选择正确的项目，然后等待NuGet包安装完成。

2. 项目的使用说明

CronNET 是一个简单的C#库，用于基于cron计划执行任务。CronNET支持大多数cron计划格式。具体支持的格式如下：

• * * * * *: 每分钟。
• 0 * * * *: 每小时的开始。
• 0,1,2 * * * *: 每小时的第0、1和2分钟。
• */2 * * * *: 每2分钟。
• 1-55 * * * *: 从第1分钟到第55分钟。
• * 1,10,20 * * *: 每月的第1、10和20小时。

使用CronNET，您可以创建定时任务，如以下示例所示：

控制台应用程序示例

using System.Threading;
using CronNET;

namespace CronNETExample.Console
{
    class Program
    {
        private static readonly CronDaemon cron_daemon = new CronDaemon();            

        static void Main(string[] args)
        {
            cron_daemon.add_job(new CronJob("* * * * *", task));
            cron_daemon.start();

            // 无限等待，让cron守护程序运行。
            while(true) Thread.Sleep(6000);
        }

        static void task()
        {
            Console.WriteLine("Hello, world.");
        }
    }
}

Windows服务应用程序示例

using System.Threading;
using CronNET;

namespace CronNETExample.WindowsService
{
    public partial class Service : ServiceBase
    {
        private readonly CronDaemon cron_daemon = new CronDaemon();

        public Service()
        {
            InitializeComponent();
        }

        protected override void OnStart(string[] args)
        {
            cron_daemon.add_job(new CronJob("*/2 * * * *", task));
            cron_daemon.start();
        }

        protected override void OnStop()
        {
            cron_daemon.stop();
        }

        private void task()
        {
            Console.WriteLine("Hello, world.");
        }
    }
}

3. 项目API使用文档

CronNET 的API相对简单，主要包括以下类和方法：

• CronDaemon: 用于管理cron任务的主类。

  • add_job(CronJob job): 添加一个新的cron任务。
  • start(): 开始执行cron任务。
  • stop(): 停止执行cron任务。

• CronJob: 表示一个cron任务。

  • 构造函数 CronJob(string cronExpression, Action task): 使用cron表达式和要执行的任务初始化。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，通过NuGet包管理器进行安装是最简单和推荐的方法。