开源分布式Job系统,调度与业务分离-HttpJob.Agent组件介绍以及如何使用

项目介绍：

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.Agent组件介绍以及如何使用

HttpJob.Agent是什么？

是一个基于netcore web的一个中间件，专门用于配合Hangfire.HttpJob 开发HttpJob的组件

NUGET地址：Install-Package Hangfire.HttpJob.Agent

帮助快速创建HttpJob并有以下特色

job的调度和业务完全分离
可以在hangfire的后台进行添加变成一个HttpJob
支持在hangfire后台手动发送该job 执行命令和停止命令
支持长时间运行

如何使用

JobAgent 是作为一个中间件来使用的 DEMO 可以查看 https://github.com/yuzd/Hangfire.HttpJob/tree/master/Test/TestHangfireAgent

JobAgent：一个JobAgent表示一个App 通过netcore web形式部署，一个JobAgent可以宿主多个Job

Job:表示单个Job，用于处理特定的业务逻辑

1.创建一个netcore的web空的工程

安装nuget包

这里我也用NLOG组件来记录日志：所以也安装下Nlog的包： NLog.Extensions.Logging

新增一个Nlog.config文件，可以参考 https://github.com/yuzd/Hangfire.HttpJob/blob/master/Test/TestHangfireAgent/NLog.Config

配置startup

在appsettings.json里面配置JobAgent的启动参数

参数说明

字段名称	备注
Enabled	代表是否启用JobAgent
SitemapUrl	代表JobAgent的请求地址默认"/jobagent"
EnabledBasicAuth	代表是否开启basicAuth认证如果true 需要设置下面2个参数
BasicUserName	basicAuth认证的用户名
BasicUserPwd	basicAuth认证的密码

AgentJob 分下面两种

单例的Job ===> 指的是在Agent运行期间只会存在一个实例如果该实例没有执行完毕是不允许再次执行的
多例的Job ===> 每次执行都会新生成一个实例

PS：Job类都是注册在Netcore 的 DI容器里面的，所以可以在job类的构造方法注入你想要的类，比如Logger组件

开始写job了

1. 写一个最简单的job

新建一个cs 叫 TestJob.cs

让它继承 JobAgent 并且重写下面3个方法

OnStart
OnStop
OnException

特别说明： OnStart方法在被执行的时候是在一个独立的线程执行的，所以能够执行长时间的任务

默认注册的单例JOB，下面会有多例的举例

2. 注册到Hangfire里面去

# 特别要注意的以下几个参数
1. Url 要填 Agent的注册地址 “/jobagent”
2. BasicUserName 和 BasicPassword 要填 Agent的配置的basicAuth
3. AgentClass 要填你添加的job类的完整名称
4. DelayFromMinutes这里我们填-1 代表必须手动执行 如果填0代表是立即执行 如果填>1 代表延迟分钟数

# 那么对应如下填写：

{
  "JobName": "TestJob",                     //Job名称
  "Method": "POST",                         //http请求的方法 
  "ContentType": "application/json",        //http参数类型
  "Url": "http://localhost:5002/jobagent",  //Agent的注册地址 
  "DelayFromMinutes": -1,                   //-1代表必须手动启动
  "Data": "",
  "Timeout": 5000,                          //http调用超时设置
  "BasicUserName": "test",                  //Agent设置的basicAuth
  "BasicPassword": "123456",                //Agent设置的basicAuth
  "EnableRetry": false,
  "SendSucMail": false,
  "SendFaiMail": true,                      //http失败时发邮件通知
  "Mail": "1877682825@qq.com",              //http调用失败通知我
  "AgentClass": "TestHangfireAgent.Jobs.TestJob,TestHangfireAgent"
}