.net core下定时任务的实现

作者: Bug生活2048 | 来源:发表于2018-04-02 19:48 被阅读112次

    在上一篇[.net core下验证码及二维码登录的实现]主要介绍了验证码及二维码的实现,本篇主要介绍下在 .net core下如何实现定时任务

    Hangfire介绍

    Hangfire作为一款高人气且容易上手的分布式后台执行服务,支持多种数据库。在 .net core的环境中,由Core自带的DI管理着生命周期,免去了在NF4.X环境中配置always running的麻烦,真正做到开箱即用。

    官方文档点这里

    相较于quartz.net相比,最大的优点是有个自带的监控界面,比较方便。但有一点,Hangfire只支持分钟级别的定时任务,如果想用秒级别的定时任务,那可能Hangfire就不满足你的需求了。

    Hangfire基础

    基于队列的任务处理(Fire-and-forget jobs)

    基于队列的任务处理是Hangfire中最常用的,客户端使用BackgroundJob类的静态方法Enqueue来调用,传入指定的方法(或是匿名函数),Job Queue等参数.(类似MQ)

    var jobId = BackgroundJob.Enqueue(
        () => Console.WriteLine("Fire-and-forget!"));
    

    在任务被持久化到数据库之后,Hangfire服务端立即从数据库获取相关任务并装载到相应的Job Queue下,在没有异常的情况下仅处理一次,若发生异常,提供重试机制,异常及重试信息都会被记录到数据库中,通过Hangfire控制面板可以查看到这些信息。

    延迟任务执行(Delayed jobs)

    延迟(计划)任务跟队列任务相似,客户端调用时需要指定在一定时间间隔后调用:

    var jobId = BackgroundJob.Schedule(
        () => Console.WriteLine("Delayed!"),
        TimeSpan.FromDays(7));
    
    定时任务执行(Recurring jobs)

    定时(循环)任务代表可以重复性执行多次,支持CRON表达式:

    RecurringJob.AddOrUpdate(
        () => Console.WriteLine("Recurring!"),
        Cron.Daily);
    
    延续性任务执行(Continuations)

    延续性任务类似于.NET中的Task,可以在第一个任务执行完之后紧接着再次执行另外的任务:

    BackgroundJob.ContinueWith(
        jobId,
        () => Console.WriteLine("Continuation!"));
    

    代码实现

    在我的项目中,实际只用到了定时任务(用于跑一些报表,邮件预警之类的需求),其他的业务场景感觉还是MQ更加适合。

    下面来看看 .net core下具体的代码实现:

    首先需要引用组件Hangfire.dllHangfire.MySqlStorage.dll,我使用的是Mysql。

    Startup.cs中的ConfigureServices中初始化数据库:

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();
        services.AddHangfire(x => x.UseStorage(new MySqlStorage(CONNECTION_STRING)));
    }
    

    Configure启动你的Hangfire服务:

    var jobOptions = new BackgroundJobServerOptions
    {
        //Queues = new[] { "test", "default" },//队列名称,只能为小写
        WorkerCount = Environment.ProcessorCount * 5, //并发任务数
        ServerName = "hangfire1",//服务器名称
    };
    
    app.UseHangfireServer(jobOptions);//启动Hangfire服务
    

    同时你可以在Configure下启动你的监控应用:

    var options = new DashboardOptions
    {
        Authorization = new[] { new HangfireAuthorizationFilter() }
    };
    app.UseHangfireDashboard("/job_dashboard", options);
    

    这样启动后就可以看到你的监控后台了,输入地址/job_dashboard

    1

    一些小改动

    由于项目可能经常会重新部署,所以在项目启动时我会默认重新启动定时任务:

    Startup.cs直接启动JobService.Register():

    public static async void Register()
    {
        var jobKeys =await JobMonitorServices.GetAllJobKey();
    
        if (!jobKeys.Any())
            return;
    
        //暂时只开一个queue,后期可扩展
        foreach(var keyModel in jobKeys)
        {
            var key = keyModel.Key.Split(':')[1];
            RecurringJob.AddOrUpdate(key, () => JobMonitorServices.Execute(key), keyModel.Value);
        }        
    }
    

    至于GetAllJobKey方法,是我直接从数据库里取的:

    public static async Task<List<HashModel>> GetAllJobKey()
    {
        string sql = $@"SELECT distinct `Key`,`Field`,`Value` FROM Hash WHERE Field='Cron';";
        using (var conn = DatabaseManager.GetConnection(DatabaseManager.JOB_DBName))
        {
            await conn.OpenAsync();
            return (await conn.QueryAsync<HashModel>(sql)).ToList() ;
        }
    }
    

    这样的话我可以同时暴露出对应的新增修改job接口了,这样方便我们直接通过服务去新增job,或者修改job的触发时间:

    /// <summary>
    /// 新增or更新Job
    /// </summary>
    /// <param name="entity"></param>
    /// <returns></returns>
    [HttpPost]
    public IActionResult Post([FromBody]JobKeyRequestModel entity)
    {
        var result = JobMonitorServices.CheckEnableJobKey(entity);
        if (result.Result)
            RecurringJob.AddOrUpdate(entity.Key, () => JobMonitorServices.Execute(entity.Key), entity.Cron,TimeZoneInfo.Local);
        return AssertNotFound(result);
    }
    

    总结

    Hangfire对于小项目来说用起来还是比较方便的,但对于精度要求和性能要求比较高的项目来说,还需要考量下。毕竟没有压测过,不知道性能怎么样。

    相关文章

      网友评论

        本文标题:.net core下定时任务的实现

        本文链接:https://www.haomeiwen.com/subject/jgnxhftx.html