从控制器手动触发 Quartz.net 作业

Posted 2023-03-31

【中文标题】从控制器手动触发 Quartz.net 作业

【英文标题】：Trigger Quartz.net job manually from controller

【发布时间】：2021-12-30 06:40:12

【问题描述】：

我在 VS2019 中构建了一个示例 .NET 5 Web API 应用程序，我有默认模板（带有WeatherForecastController）。 我已将 Quartz.net（版本 3.3.3）添加到项目中，并在 Startup 类中添加：

public void ConfigureServices(IServiceCollection services)

    services.AddQuartz(q =>
    
        q.UseMicrosoftDependencyInjectionJobFactory();
        q.AddJobAndTrigger<HelloWorldJob>(Configuration);
    );

    // ASP.NET Core hosting
    services.AddQuartzServer(options =>
    
        // when shutting down we want jobs to complete gracefully
        options.WaitForJobsToComplete = true;
    );

    services.AddControllers();
    services.AddSwaggerGen(c =>
    
        c.SwaggerDoc("v1", new OpenApiInfo  Title = "QuartzTest", Version = "v1" );
    );

并创建了一个示例作业。AddJobAndTrigger的代码取自https://andrewlock.net/using-quartz-net-with-asp-net-core-and-worker-services/

该部分运行良好，但现在我想让最终用户能够通过 REST API 手动触发特定作业。

我创建了一个简单的控制器，它应该能够通过以下方式手动触发作业：

scheduler.TriggerJob(new Jobkey("MarkAsSolutionReminderJob"));

（参考：Quartz.Net Trigger Scheduled Job On Demand）

下面是我的控制器：

[ApiController]
[Route("[controller]")]
public class QuartzController : ControllerBase

    private readonly IScheduler _scheduler;
    private readonly ILogger<WeatherForecastController> _logger;

    public QuartzController(IScheduler scheduler, ILogger<WeatherForecastController> logger)
    
        _scheduler = scheduler;
        _logger = logger;
    

    [HttpGet("Run")]
    public async Task<OkObjectResult> Run(string jobName)
    
        //check if a specific job exists

        //if yes then run that job
        await _scheduler.TriggerJob(new JobKey("HelloWorldJob"));
        return Ok("OK");
    

但是当我尝试运行它时，我得到了这个错误：

System.InvalidOperationException：无法解析服务类型 尝试激活时出现“Quartz.IScheduler” 'QuartzTest.Controllers.QuartzController'。在 Microsoft.Extensions.DependencyInjection.ActivatorUtilities.GetService（IServiceProvider sp, Type type, Type requiredBy, Boolean isDefaultParameterRequired) 在 lambda_method10（闭包，IServiceProvider，对象 []）在 Microsoft.AspNetCore.Mvc.Controllers.ControllerActivatorProvider.c__DisplayClass4_0.b__0(ControllerContext 控制器上下文）在 Microsoft.AspNetCore.Mvc.Controllers.ControllerFactoryProvider.c__DisplayClass5_0.g__CreateController|0(ControllerContext 控制器上下文）在 Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next（状态& next, Scope& 范围, Object& 状态, Boolean& isCompleted) at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.InvokeInnerFilterAsync() --- 来自先前位置的堆栈跟踪结束 --- 在 Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|19_0(ResourceInvoker 调用者，任务 lastTask，下一个状态，作用域范围，对象状态，布尔值 已完成）在 Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker 调用者、任务任务、IDisposable 范围）在 Microsoft.AspNetCore.Routing.EndpointMiddleware.g__AwaitRequestTask|6_0（端点 端点，任务 requestTask，ILogger 记录器）在 Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext 上下文）在 Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIMiddleware.Invoke(HttpContext httpContext) 在 Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware.Invoke(HttpContext httpContext，ISwaggerProvider swaggerProvider）在 Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext 上下文）

如何访问控制器内的调度程序，并在理想情况下检查特定作业是否存在以及它们的状态（是否正在运行）？

【参考方案1】：

我认为services.AddQuartz 就足够了。

AddQuartz 将调度程序工厂，而不是 IScheduler 添加到 DI 容器。

由于获取调度程序是异步完成的，因此在启动期间很难设置它。

重构您的代码，改为依赖于工厂并使用它来获取调度程序

[ApiController]
[Route("[controller]")]
public class QuartzController : ControllerBase 
    private readonly ISchedulerFactory factory;
    private readonly ILogger<WeatherForecastController> _logger;

    public QuartzController(ISchedulerFactory factory, ILogger<WeatherForecastController> logger) 
        this.factory = factory;
        _logger = logger;
    

    [HttpGet("Run")]
    public async Task<OkObjectResult> Run(string jobName) 
        IScheduler scheduler = await factory.GetScheduler();

        //...check if a specific job exists

        //if yes then run that job
        await scheduler.TriggerJob(new JobKey("HelloWorldJob"));

        return Ok("OK");
    

【讨论】：

我刚刚在 repo 中找到了一个示例：github.com/quartznet/quartznet/blob/main/src/…。呵呵，下次一定要看看项目repo。感谢您的帮助！