当前位置: 首页 > 工具软件 > quartz web > 使用案例 >

webAPI的定时任务( Quartz)

林建本
2023-12-01

在引用处添加入 Quartz 首先在web.config下加入关于quartz的配置

  <configSections>
    <!--Quartz-->
    <section name="quartz" type="System.Configuration.NameValueSectionHandler" />
  </configSections>
  <!--Quartz配置-->
  <quartz>
    <add key="quartz.scheduler.instanceName" value="ExampleDefaultQuartzScheduler" />
    <add key="quartz.threadPool.type" value="Quartz.Simpl.SimpleThreadPool, Quartz" />
    <add key="quartz.threadPool.threadCount" value="10" />
    <add key="quartz.threadPool.threadPriority" value="2" />
    <add key="quartz.jobStore.misfireThreshold" value="60000" />
    <add key="quartz.jobStore.type" value="Quartz.Simpl.RAMJobStore, Quartz" />
    <!--******************************Plugin配置*********************************************-->
    <add key="quartz.plugin.xml.type" value="Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz" />
    <add key="quartz.plugin.xml.fileNames" value="~/quartz_jobs.xml" />
  </quartz>

完成后 先建立需要使用功能的任务(为发送邮件)

  /// <summary>
    /// 处理定时任务
    /// </summary>
    public class CreateJob:IJob
    {
        public void Execute(IJobExecutionContext context)
        {
            SendMail();
            //具体的方法

        }

        public bool MethodSendMail(PromptMail modle)
        {
            System.Net.Mail.MailMessage msg = new System.Net.Mail.MailMessage();

            msg.To.Add(modle.UserAdd);

            msg.From = new MailAddress("kin81@126.com", "dulei", System.Text.Encoding.UTF8);
            //msg.ReplyTo = new MailAddress("2038666146@qq.com");
            /* 上面3个参数分别是发件人地址(可以随便写),发件人姓名,编码*/
            msg.Subject = "这是测试邮件";//邮件标题  
            msg.SubjectEncoding = System.Text.Encoding.UTF8;//邮件标题编码  
            msg.Body = "第二次测试邮件内容";//邮件内容  
            msg.BodyEncoding = System.Text.Encoding.UTF8;//邮件内容编码  
            msg.IsBodyHtml = true;//是否是HTML邮件  
            msg.Priority = MailPriority.High;//邮件优先级 
            SmtpClient client = new SmtpClient();
            client.Host = "smtp.126.com";
            client.Credentials = new NetworkCredential("kin81@126.com", "king811223"); //创建用户凭证
            client.DeliveryMethod = SmtpDeliveryMethod.Network; //使用网络传送
            object userState = msg;
            try
            {
                client.Send(msg);
                //简单一点儿可以client.Send(msg); 
                return true;
            }
            catch (System.Net.Mail.SmtpException ex)
            {
                return false;
            }
        }

        public async Task<int> SendMail()
        {
            int num = 0;
            try
            {
                PromptMail model = new PromptMail()
                {
                    UserAdd = "229541625@qq.com"
                };
                bool result = MethodSendMail(model);
            }
            catch (Exception)
            {
                num = -1;
            }
            return await Task.FromResult(num);
        }
    }
    /// <summary>
    /// 邮件提示
    /// </summary>
    public class PromptMail
    {
        public string UserAdd { get; set; }
        public string MailModel { get; set; }
        public string ReplyTo { get; set; }
    }

创建 开启的服务形式以及方法

   public class JobScheduler
    {
        public static void Start()
        {

            //调度器工厂
            ISchedulerFactory factory = new StdSchedulerFactory();
            //调度器
            IScheduler scheduler = factory.GetScheduler();
            scheduler.GetJobGroupNames();

            /*-------------计划任务代码实现------------------*/
            //创建任务
            IJobDetail job = JobBuilder.Create<CreateJob>().Build();

            //创建触发器(2小时触发一次)
            ITrigger trigger = TriggerBuilder.Create().StartNow().WithCronSchedule("* * 0/2 * * ?").Build();//WithIdentity("TimeTrigger", "TimeGroup").WithSimpleSchedule(t => t.WithIntervalInMinutes(30).RepeatForever()).Build();

            // 添加任务及触发器至调度器中
            scheduler.ScheduleJob(job, trigger);
            /*-------------计划任务代码实现------------------*/

            //启动
            scheduler.Start();
        }
    }

最后在Global.asax下添加方法的启动项:

   protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            //执行定时任务
            JobScheduler.Start();
            GlobalConfiguration.Configure(WebApiConfig.Register);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
            // 使api返回为json
            GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
        }

其中学习资料为 参考:https://www.cnblogs.com/lazyInsects/p/8075487.html
Quartz是一款比较好用的定时任务执行工具类,虽然我们平时也可以自己写代码实现定时执行,但是如果比较负责的定时任务做起来比较费力费时,所以Quartz就派上用场了
Quartz有两种主要使用方式

1、SimpleTrigger

2、CronTrigger

第一种方式比较简单,传入一个值,就可以使用,第二种方式传入一个表达式,表达式详细说明如下

由七个子表达式组成

1.Seconds (0-59)
2.Minutes (0-59)
3.Hours (0-23)
4.Day-of-Month (1-31,但是要注意有些月份没有31天)
5.Month (0-11,或者"JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV,DEC")
6.Day-of-Week (1-7,1=SUN 或者"SUN, MON, TUE, WED, THU, FRI, SAT”)
7.Year (1970-2099)

Cron表达式的格式:秒 分 时 日 月 周 年(可选)。
字段名 允许的值 允许的特殊字符
秒 0-59 , - * /
分 0-59 , - * /
小时 0-23 , - * /
日 1-31 , - * ? / L W C
月 1-12 or JAN-DEC , - * /
周几 1-7 or SUN-SAT , - * ? / L C #
年(可选字段) empty 1970-2099 , - * /

字符含义:

  • :代表所有可能的值。因此,“*”在Month中表示每个月,在Day-of-Month中表示每天,在Hours表示每小时
  • :表示指定范围。

, :表示列出枚举值。例如:在Minutes子表达式中,“5,20”表示在5分钟和20分钟触发。

/ :被用于指定增量。例如:在Minutes子表达式中,“0/15”表示从0分钟开始,每15分钟执行一次。“3/20"表示从第三分钟开始,每20分钟执行一次。和"3,23,43”(表示第3,23,43分钟触发)的含义一样。

? :用在Day-of-Month和Day-of-Week中,指“没有具体的值”。当两个子表达式其中一个被指定了值以后,为了避免冲突,需要将另外一个的值设为“?”。例如:想在每月20日触发调度,不管20号是星期几,只能用如下写法:0 0 0 20 * ?,其中最后以为只能用“?”,而不能用“*”。

L :用在day-of-month和day-of-week字串中。它是单词“last”的缩写。它在两个子表达式中的含义是不同的。
在day-of-month中,“L”表示一个月的最后一天,一月31号,3月30号。
在day-of-week中,“L”表示一个星期的最后一天,也就是“7”或者“SAT”
如果“L”前有具体内容,它就有其他的含义了。例如:“6L”表示这个月的倒数第六天。“FRIL”表示这个月的最后一个星期五。
注意:在使用“L”参数时,不要指定列表或者范围,这样会出现问题。

W :“Weekday”的缩写。只能用在day-of-month字段。用来描叙最接近指定天的工作日(周一到周五)。例如:在day-of-month字段用“15W”指“最接近这个月第15天的工作日”,即如果这个月第15天是周六,那么触发器将会在这个月第14天即周五触发;如果这个月第15天是周日,那么触发器将会在这个月第 16天即周一触发;如果这个月第15天是周二,那么就在触发器这天触发。注意一点:这个用法只会在当前月计算值,不会越过当前月。“W”字符仅能在 day-of-month指明一天,不能是一个范围或列表。也可以用“LW”来指定这个月的最后一个工作日,即最后一个星期五。

:只能用在day-of-week字段。用来指定这个月的第几个周几。例:在day-of-week字段用"6#3" or "FRI#3"指这个月第3个周五(6指周五,3指第3个)。如果指定的日期不存在,触发器就不会触发。

表达式例子:

0 * * * * ? 每1分钟触发一次
0 0 * * * ? 每天每1小时触发一次
0 0 10 * * ? 每天10点触发一次
0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发
0 30 9 1 * ? 每月1号上午9点半
0 15 10 15 * ? 每月15日上午10:15触发

*/5 * * * * ? 每隔5秒执行一次
0 */1 * * * ? 每隔1分钟执行一次
0 0 5-15 * * ? 每天5-15点整点触发
0 0/3 * * * ? 每三分钟触发一次
0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发
0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发
0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
0 0 10,14,16 * * ? 每天上午10点,下午2点,4点

0 0 12 ? * WED 表示每个星期三中午12点
0 0 17 ? * TUES,THUR,SAT 每周二、四、六下午五点
0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发
0 15 10 ? * MON-FRI 周一至周五的上午10:15触发

0 0 23 L * ? 每月最后一天23点执行一次
0 15 10 L * ? 每月最后一日的上午10:15触发
0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发

0 15 10 * * ? 2005 2005年的每天上午10:15触发
0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发
0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发

使用示例(C#):

SimpleTrigger和CronTrigger:

Quartz.SimpleTrigger DAtrigger = null;
DAtrigger = new Quartz.SimpleTrigger("trigger", "groupJob", "Job", "Job", ts, null,
      Quartz.SimpleTrigger.RepeatIndefinitely, TimeSpan.FromMinutes(1));
CronTrigger trigger = new CronTrigger("trigger", "groupJob", "Job", "Job");
trigger.CronExpressionString = "0 0/1 9-15 * * ?";
currentschedulerJob.AddJob(Job, true);
currentschedulerJob.ScheduleJob(Job, trigger);
currentschedulerJob.Start();
 类似资料: