如何将Excel VSTO Ribbon与Quartz调度器集成实现后台定时任务？

嘿，你已经选对了Quartz来实现VSTO Excel的后台定时任务！不过要搞定「所有用户点击按钮后后台稳定运行调度器」这个需求，还有几个关键细节要注意，我帮你补全代码并梳理核心要点：

1. 先搞定调度器的全局单例 #

每次点击按钮都新建调度器会导致资源冲突，所以要在Ribbon类里维护一个静态的单例调度器实例：

private static IScheduler _scheduler;

2. 补全按钮点击事件的完整逻辑 #

这里要处理调度器初始化、任务创建、触发器配置，还要避免重复调度：

private void myButton_Click(object sender, RibbonControlEventArgs e)
{
    // 初始化单例调度器（确保只启动一次）
    if (_scheduler == null || !_scheduler.IsStarted)
    {
        _scheduler = StdSchedulerFactory.GetDefaultScheduler().Result;
        _scheduler.Start();
    }

    // 检查是否已存在同名任务，避免重复添加
    var jobKey = new JobKey("ExcelBackgroundJob", "ExcelJobGroup");
    var existingJob = _scheduler.GetJobDetail(jobKey).Result;
    if (existingJob != null)
    {
        MessageBox.Show("后台调度任务已在运行中！", "提示", MessageBoxButtons.OK, MessageBoxIcon.Information);
        return;
    }

    // 创建自定义任务实例
    IJobDetail job = JobBuilder.Create<myJob>()
        .WithIdentity(jobKey)
        .Build();

    // 配置触发器（示例：每天上午10点执行，可按需修改）
    ITrigger trigger = TriggerBuilder.Create()
        .WithIdentity("ExcelJobTrigger", "ExcelJobGroup")
        .WithDailyTimeIntervalSchedule(schedule =>
            schedule.WithIntervalInHours(24)
                   .OnEveryDay()
                   .StartingDailyAt(TimeOfDay.HourAndMinuteOfDay(10, 0)))
        .Build();

    // 绑定任务与触发器到调度器
    _scheduler.ScheduleJob(job, trigger);

    MessageBox.Show("后台调度任务已启动，将在指定时间自动执行！", "调度器状态", MessageBoxButtons.OK, MessageBoxIcon.Information);
}

3. 实现你的自定义Job类 #

需要继承IJob接口，在Execute方法里写具体的预设操作，注意Excel对象模型的线程安全问题：

public class myJob : IJob
{
    public Task Execute(IJobExecutionContext context)
    {
        // Quartz任务在后台线程执行，必须切换到Excel主线程操作对象模型
        Globals.ThisAddIn.Application.Invoke(() =>
        {
            Excel.Workbook activeWorkbook = Globals.ThisAddIn.Application.ActiveWorkbook;
            if (activeWorkbook != null)
            {
                Excel.Worksheet targetSheet = activeWorkbook.Worksheets["任务日志"] ?? activeWorkbook.Worksheets.Add();
                targetSheet.Name = "任务日志";
                
                // 示例：在日志表追加执行记录
                var lastRow = targetSheet.Cells[targetSheet.Rows.Count, "A"].End[Excel.XlDirection.xlUp].Row + 1;
                targetSheet.Cells[lastRow, "A"].Value = $"任务执行时间：{DateTime.Now:yyyy-MM-dd HH:mm:ss}";
            }
        });

        return Task.CompletedTask;
    }
}

4. 收尾：Excel退出时清理调度器 #

在AddIn的Shutdown事件里关闭调度器，避免Excel退出后进程残留：

private void ThisAddIn_Shutdown(object sender, EventArgs e)
{
    if (_scheduler != null && _scheduler.IsStarted)
    {
        _scheduler.Shutdown().Wait();
    }
}

几个必看的注意事项 #

• Excel信任中心设置：确保用户的Excel允许VSTO插件运行，否则调度器会被拦截。
• 线程安全：所有操作Excel对象的代码必须通过Invoke切换到主线程，否则会抛出异常。
• 任务持久化：如果需要重启Excel后保留任务，可以配置Quartz的持久化存储（比如SQLite），不过对于VSTO场景，一般临时调度足够。

内容的提问来源于stack exchange，提问作者Zeruno