如何创建一个周期性的 HttpJob

优质

小牛编辑

127浏览

2023-12-01

周期性的HttpJob任务的定义

是多次运行的job 采用Cron表达式进行定义运行规则

注意事项

最新版的hangfire已支持 6位数的Cron表达式(支持到秒级)
但是我在hangfire的dashbord扩展的Cron生成页面还不支持到秒级别(大家可以在google找可以生成6位的网站工具)

1. 进入hangfire的后台点击上侧栏【周期性作业】

如下图所示：

针对周期性作业可以看到有三个按钮

按钮名称	说明
新增周期性作业	新增一个周期性httpjob作业
编辑周期性作业	如果你重新编辑该周期性httpjob作业内容可以点击该按钮
Cron表达式生成	跳转到Cron表达式生成页面

1. 生成Cron表达式

点击【Cron表达式生成】进入Cron表达式生成页面如下图：

例如我想要每天晚上8点05分执行

得出结果：【5 20 * * *】

2.新增周期性作业

点击【新增周期性作业】按钮会出现一个json编辑器

json 编辑器的参数说明如下

字段名称	备注
JobName	你给这个httpjob起的名称【必填项】
Method	这个httpjob的请求方式 "get" 或者 "post" 【必填项】
ContentType	这个httpjob的请求ContentType 默认"application/json" 【必填项】
Url	这个httpjob的请求url 【必填项】
==Cron==	Cron表达式可以先用【Cron表达式生成】功能生成好,如果为空则代表只能是手动出发执行！
Data	这个httpjob在Method=“post”的时候可以指定post的内容,可以是一个对象也可以是一个string或者其他类型
Timeout	这个httpjob请求的超时时间(单位是毫秒例如5000 代表是5秒)
BasicUserName	这个httpjob请求需要启用basic认证时设置的username
BasicPassword	这个httpjob请求需要启用basic认证时设置的密码
EnableRetry	失败的时候(比如超时远程服务器请求错误等)是否启用重试默认false
RetryTimes	错误尝试次数自定义，EnableRetry=true的时候启用
RetryDelaysInSeconds	失败重试区间,半角逗号隔开，EnableRetry=true的时候启用
SendSucMail	这个httpjob请求无异常的时候是否发送通知邮件默认false
SendFaiMail	这个httpjob请求异常的时候是否发送通知邮件默认true
Mail	设置通知邮件地址如果有多个用半角逗号隔开
AgentClass	如果是==AgentJob开发的httpjob== 则需要填写，填写的是完整的类型格式{namespace},{程序集的名称} 例如：TestHangfireAgent.Jobs.XXXJOB,TestHangfireAgent
CallbackEL	el表达式来判断返回体是否成功还是失败，请查看wiki专门针对这个功能的介绍

举例

比如
每天晚上8点执行一次查询订单已完成超xx小时了（xx作为参数）
但是还没有点评的
发短信让催点评
接口地址：http://localhost:5000/scoreOrder
访问方式是POST
接口有basicAuth验证 用户名是admin 密码是test

# 那么对应如下填写：

{
  "JobName": "scoreOrder",                  //Job名称
  "Method": "POST",                         //http请求的方法 
  "ContentType": "application/json",        //http参数类型
  "Url": "http://localhost:5000/scoreOrder",//接口的地址 
  "Cron": "5 20 * * *",                     //每天晚上8点05分执行
  "Data": {
    "Hour":48                               //传的参数超过48小时
  },
  "Timeout": 5000,                          //http调用超时设置
  "BasicUserName": "admin",                 //http调用的basicAuth
  "BasicPassword": "test",                  //http调用的basicAuth
  "EnableRetry": false,                     //http调用失败的错误重试
  "RetryTimes" : 3 ,                        //错误尝试次数自定义，EnableRetry=true的时候启用
  "RetryDelaysInSeconds" : "5,20,30"        //失败重试区间,半角逗号隔开，EnableRetry=true的时候启用
  "SendSucMail": false,
  "SendFaiMail": true,                      //http失败时发邮件通知
  "Mail": "1877682825@qq.com",              //http调用失败通知我
  "AgentClass": ""
}

点击【提交】

添加成功在job列表可以查

我刚才设置的是20:05分执行

目前时间是19:50

正好是还有15分钟就要执行了说明Cron表达式没有问题

对于周期性job 有3个按钮可以操作

按钮名称	说明
立即执行	如果你希望不要等到8点05想立即就执行可以点击它
停止或开始任务	如果你希望暂停这个周期性job 可以点它，点完之后再次点击就是开启
编辑周期任务	如果你刚刚添加的参数有错误,可以点击这个按钮重新编辑提交