項目介紹：
Hangfire：是一個開源的job調度系統,支持分佈式JOB！！
Hangfire.HttpJob 是我針對Hangfire開發的一個組件,該組件和Hangfire本身是獨立的。可以獨立更新Hangfire版本不影響！
該組件已被Hangfire官方採納，在Hangfire官網可以查到：
開源地址：
https://github.com/yuzd/Hangfire.HttpJob
該項目目的是：
剝離Job調度和業務
Hangfire.HttpJob究竟是幹嘛的
- 傳統使用Hangfire都是把JOb的處理邏輯代碼寫在和Hangfire的同一個工程！
缺點： 這樣就耦合在了一起，如果業務線增大，會導致每個業務線的Job處理邏輯都得和Hangfire耦合在一起！發佈的時候所有業務線Job都得暫停調度- 而使用了Hangfire.HttpJob的話 就是把Hangfire的服務拓展成可以把Job的處理邏輯代碼寫在別的工程裏面(以webapi的形式暴露給Hangfire去調度)
優點：這樣就解耦了Hangfire和業務處理邏輯，業務job開發者可以忽略Hangfire的存在！不同的業務線分開不同的JobAgent可以分別部署，發佈互不影響
Hangfire.HttpJob
是對Hangfire的一個擴展插件，利用Hangfire.HttpJob可以快速搭建分部署Job調度Server。
特點是：
- 業務與調度完全分離。
- 支持定點執行 延遲執行 週期性循環執行，支持秒級別
- 配合JobAgent組件可以實現Job管理 監控 日誌等
共有三篇文章
開源分佈式Job系統,調度與業務分離-如何創建一個計劃httpjob任務
開源分佈式Job系統,調度與業務分離-如何創建週期性的HttpJob任務
開源分佈式Job系統,調度與業務分離-HttpJob.Agent組件介紹以及如何使用
本篇教程：如何創建一個計劃httpjob任務
計劃httpjob任務的定義
一次性的job 只運行一次
1. 進入hangfire的後臺 點擊 左側欄【計劃】
會看到一個按鈕名稱叫 【新增常規作業】如下圖所示：
2. 點擊【新增常規作業】會出現一個json編輯器
如下圖所示
json編輯器的參數說明如下
| 字段名稱 | 備註 |
|---|---|
| JobName | 你給這個httpjob起的名稱【必填項】 |
| Method | 這個httpjob的請求方式 "get" 或者 "post" 【必填項】 |
| ContentType | 這個httpjob的請求ContentType 默認"application/json" 【必填項】 |
| Url | 這個httpjob的請求url 【必填項】 |
| DelayFromMinutes | 需要延遲執行的分鐘,注意：0 代表立刻執行； -1代表只能手動觸發； >=1代表延遲分鐘數 【必填項】 |
| Data | 這個httpjob在Method=“post”的時候可以指定post的內容,可以是一個對象也可以是一個string或者其他類型 |
| Timeout | 這個httpjob請求的超時時間(單位是毫秒 例如5000 代表是5秒) |
| BasicUserName | 這個httpjob請求需要啓用basic認證時設置的username |
| BasicPassword | 這個httpjob請求需要啓用basic認證時設置的密碼 |
| EnableRetry | 失敗的時候(比如超時 遠程服務器請求錯誤等)是否啓用重試 默認false ,如果設置true 會重試最大3次 |
| SendSucMail | 這個httpjob請求無異常的時候是否發送通知郵件 默認false |
| SendFaiMail | 這個httpjob請求異常的時候是否發送通知郵件 默認true |
| 設置通知郵件地址 如果有多個用半角逗號隔開 | |
| AgentClass | 如果是AgentJob開發的httpjob 則需要填寫，填寫的是完整的類型格式{namespace},{程序集的名稱} 例如：TestHangfireAgent.Jobs,TestHangfireAgent |
3.舉例
我開發了一個訂單支付超時檢測 接口
訪問地址是：
http://localhost:5000/checkOrder
訪問方式是POST
訪問的參數是 orderId
接口有basicAuth驗證 用戶名是admin 密碼是test
希望計劃 15分鐘後執行 看有沒有支付 沒有支付 就把訂單狀態改成取消
如果接口訪問失敗那麼通知郵箱 [email protected]
# 那麼對應如下填寫：
{
"JobName": "checkOrder", //Job名稱
"Method": "POST", //http請求的方法
"ContentType": "application/json", //http參數類型
"Url": "http://localhost:5000/checkOrder",//接口的地址
"DelayFromMinutes": 15, //15分鐘後執行
"Data": {
"OrderId":123456 //傳的參數 orderId
},
"Timeout": 5000, //http調用超時設置
"BasicUserName": "admin", //http調用的basicAuth
"BasicPassword": "test", //http調用的basicAuth
"EnableRetry": false,
"SendSucMail": false,
"SendFaiMail": true, //http失敗時發郵件通知
"Mail": "[email protected]", //http調用失敗通知我
"AgentClass": ""
}
點擊【提交】添加job 成功如下圖所示：
可以看到會在15分鐘後執行該job
針對該job 可以看到有四個按鈕
| 按鈕名稱 | 說明 |
|---|---|
| 加入隊列 | 如果你想讓這個job立即執行 可以點擊該按鈕 |
| 刪除選中 | 如果你想刪除這個job 可以點擊該按鈕 |
| 帶參數執行 | 這個按鈕的作用是 重新定義JSON裏面的Data的值 並立即執行的意思，在AgentJob場景下使用較多 |
| 停止Job | 這個只能在AgentJob纔可以使用 |
job到時執行 如下圖所示
job執行完畢 在完成列表可以查詢
點擊job編號進入job詳情頁查看具體執行情況和日誌
也可以在Tag頁面進行查看
說明：Tag頁面是按jobName進行分組查詢的
點擊某一個jobName 進入該jobName下所有的運行完成的job列表
