给Hangfire的webjob增加callback和动态判断返回结果功能设计
背景介绍
通常业务中需要用到定时执行功能,我用hangfire搭建了一个调度服务,这个调度服务是独立于业务逻辑的,具体可以参考文章:https://github.com/yuzd/Hangfire.HttpJob/wiki
也就是说只要我有了这个调度服务后,只要提供给我的接口 我就可以调度它(比如在xx点xx分运行,或者每隔xx分运行,或者每周一8点运行等等)。
但是有一个问题,对方的接口是调用成功还是失败完全取决于对方的接口设计!
有的接口被设计成 请求的StatusCode 是200的是代表接口成功,非200的代表接口失败。
有的接口被设计成返回的json结构有一个特定的字段来代表接口调用成功还是失败,例如:success字段。比如返回的结构大概这样子:{"success":false,"data":"xxxx"}
等等,这些都是case by case ,不同的写接口的人定的规则可能不一样,通过webjob的调用方式如何动态的验证成功还是失败呢?
如上面提到动态的验证结果,我分了2种情况处理:要么看Response返回的statuscode,要么是看返回的结果里面的指定字段来判断!
1. 根据Response返回的statuscode
statuscode很好做,我在设计Hangfire.HttpJob这个扩展插件时是可以在外部设置一个验证委托
默认的返回的statuscode 小于 400 则认为http请求是成功的,否则失败
2. 返回的结果里面的指定字段来判断
我采用EL表达式来实现的,EL表达式将请求的返回体设置为json变量,然后在表达式中可以直接以属性的方式到值,表达式返回布尔类型。
针对不同的接口,我可以设置一个独立的表达式来进行判断!
首先在job添加的时候设置el表达式!如下图
如何写EL表达式:(很简单,返回的结构体是什么字段就可以用什么字段)
接口的返回体是一个string。我先将这个String转成json类型(dynamic)
然后是采用Spring.EL表达式实现的。CallbackEL表达式的返回类型是布尔类型
返回体在表达式里面是有下面2个变量:
#resultBody 是返回体的 string
#result 是返回体的 json体(根据上面转的,如果上面是非json格式的那就不能使用这个变量了)
比如说我调用的httpjob 返回体是
{"Success":false,"Info":"test"}
那么我可以这么写
"CallbackEL": "#result.Success"
也可以这么写
"CallbackEL": "#result.Info.Equals('ok')"
表达式如何运行的?
Spring.EL是我从Spring.Net里面剥离出来的一个组件,可以从nuget里面引用,支持net45和netstandard2.0
//检查是否有设置EL表达式if (!string.IsNullOrEmpty(item.CallbackEL)){var elResult = InvokeSpringElCondition(item.CallbackEL, result, context, new Dictionary<string, object> { { "resultBody", result } });if (!elResult){throw new HttpStatusCodeException(item.CallbackEL, result);}RunWithTry(() => context.WriteLine($"【{Strings.CallbackELExcuteResult}:Ok 】" + item.CallbackEL));}
/// <summary>/// 用EL表达式动态判断是否执行成功/// </summary>/// <returns></returns>private static bool InvokeSpringElCondition(string placeholder,string result, PerformContext context,Dictionary<string, object> param){try{try{param["result"] = JsonConvert.DeserializeObject<ExpandoObject>(result);}catch (Exception){//ignore}var parameterValue = ExpressionEvaluator.GetValue(null, placeholder, param);return (bool)parameterValue;}catch (Exception e){context.WriteLine($"【{Strings.CallbackELExcuteError}】" + placeholder);context.WriteLine(e);return false;}}
调用对象 ExpressionEvaluator 传 Dictionary<string, object> param 作为参数,使用#参数来引用。如果你的参数是string 那么可以写c#中string的所有方法比如 StarsWith,EndsWith,Equals 等等
如果你的参数类型是一个dynamic,那你就可以直接像使用js的对象属性一样
Callback功能设计
举例:
我们调用了A接口,如果A接口成功我们想把A接口的返回值作为请求参数再去调用B接口。
如果A接口失败在调用C接口通知错误!
参考ajax的callback设计
如上图 可以自行添加 Success 或者 Fail 作为回调
如果定义了Success 那么父job执行成功没有报错则运行 Success回调
如果定义了Fail 那么父job执行失败 则运行 Fail回调
Success 里面还可以定义 Success 和 Fail
Fail 里面还可以定义 Success 和 Fail 如下图:
回调的Json参数
字段 | 说明 |
---|---|
Url | 请求Url |
Method | Post,Get |
Data | Post时可以填,支持占位符(具体请看下面的介绍) |
ContentType | application/json |
Timeout | 超时(毫秒) |
BasicUserName | basicauth用户名 |
BasicPassword | basicauth密码 |
AgentClass | 基于jobAgent开发的httpjob需要填 |
Headers | key:value 的jsonstring "{"key":,"value"}" |
回调执行的逻辑
注意:回调不是作为新的的HangfireHttpJob执行的,是依附在最顶级的父Job的!
举例:
如果:JobA -》 Fail B -> Success BB
JobA本身执行错误的话则会走重试逻辑(如果开启重试的话),重试到顶后 进入 Fail B, Fail B 执行成功 则进入 Success BB。如果Success BB 执行成功,那么 JobA 则认为是成功的,否则认为失败!
如果:JobA -》 Fail B -> Fail BB
JobA本身执行错误的话则会走重试逻辑(如果开启重试的话),重试到顶后 进入 Fail B, Fail B 执行失败 则进入 Fail BB 。Fail BB 执行失败,那么 JobA 认为失败!
Fail B 执行成功 进入 Success C, Success C,执行成功 认为 JobA 认为成功,否则 Job A 认为失败!
总结:如果回调 则会按照设置的回调一路走下去,看最后一个回调是否成功。如果成功 则认为整个链路执行成功,否则认为失败!
回调的代码实现是一个递归的方式调用
为了实现回调能够把上一个运行的结果最为参数,开发了占位符(placeholder)功能
也为了更好的扩展占位符功能,
首先要介绍下 dashbord里面的 全局配置 功能 如下图:
全局配置 :存储在当前目录下的 hangfire_global.json 文件(可以在StartUp代码修改HangfireHttpJobOptions.GlobalSettingJsonFilePath值指定其他地方
这个功能为了介绍重复的配置,可以集中配置一些参数,然后给各个job去使用!
占位符功能采用Spring.EL表达式实现的。
字符串中placeholder替换逻辑
第一步:把字符串中的 ${xxx} 的xxx全部替换成 全局配置里面的值
第二步:把字符串中的 #{yyy} 的yyy全部按照SpringEL表达式逻辑运行后的值进行替换
比如:上图中你在全局配置了一个参数叫test
Data:"你好呀:${test}"
在运行时会被替换成 =》 你好呀:1
例如:使用父job的返回值传给 callback
如果运行失败传给callback是报错信息
例如:使用时间替换
可以直接在 #{} 方法里面用DateTime这个变量 这个变量和c#一样的功能
比如
#{DateTime.Now} 代表运行时的当前时间+时分秒
#{DateTime.Today} 代表运行时的当天
#{DateTime.Today.AddDays(-1)} 代表运行时的昨天
#{DateTime.Today.AddDays(1)} 代表运行时的明天
总结:
以上 hangfire的webjob调度扩展组件(https://github.com/yuzd/Hangfire.HttpJob/wiki)
已经非常灵活了,基于hangfire的核心调度功能,加上webjob的调用方式,很方便的把业务逻辑分离出来!
不管业务接口如何写,基于EL表达式都可以准确的判断出来执行成功还是失败,根据回调功能很方便的执行链式调用和错误通知!
给Hangfire的webjob增加callback和动态判断返回结果功能设计相关推荐
- 把执行结果转成json对象报错_给Hangfire的webjob增加callback和动态判断返回结果功能设计...
背景介绍 通常业务中需要用到定时执行功能,我用hangfire搭建了一个调度服务,这个调度服务是独立于业务逻辑的,具体可以参考文章:https://github.com/yuzd/Hangfire.H ...
- LHF Objective-C语法(7)id类型、动态判断与选择器
1.id类型 // Complex.h============================== #import <Foundation/Foundation.h> @interface ...
- 动态判断时间插件显示到年月日时分秒
根据得到的时间格式,动态判断时间插件显示到年月日时分秒 主要split切割字符串来判断 split将一个字符串切割为字符串数组 <!DOCTYPE html> <html>&l ...
- ajax实现注册用户名时动态显示用户名是否已经被注册(1、ajax可以实现我们常见的注册用户名动态判断)(2、jquery里面的ajax也是类似我们这样封装了的函数)...
ajax实现注册用户名时动态显示用户名是否已经被注册(1.ajax可以实现我们常见的注册用户名动态判断)(2.jquery里面的ajax也是类似我们这样封装了的函数) 一.总结 1.ajax可以实现我 ...
- m0n0wall 1.3b18增加3322.org动态域名支持过程实录
一.前言 由于本人对FreeBSD不熟悉,也不会PHP开发,所以都是拿来主义,一直使用m0n0wall 1.22中文版.1.235中文版和1.235中文插件版(30w核心). 可是最近的项目要用无线网 ...
- java 数组的长度如何增加,用Java动态增加任意类型数组的长度
用Java动态增加任意类型数组的长度 如果你需要动态增加数组大小: public int[] expandArray(int[] a, int size) { if (size < ...
- php动态增加div,JavaScript动态创建div等元素实例
js动态创建div等元素实例 var Test={ createDiv:function(){ var div = document.createElement('div'); div.id=&quo ...
- docker port如何增加端口_Docker 动态添加端口映射解决思路
Docker 动态添加端口映射? docker 创建容器的时候,我们如果使用docker的桥接网络(bridge)那么一般需要暴露容器内一些端口到宿主机上,也就是容器与宿主机间的端口映射.最近很多的人 ...
- h3c端口聚合实现服务器增加带宽,H3C动态链路聚合对接服务器双网卡
5820X两个千兆端口做了动态聚合,如下: Aggregation Interface: Bridge-Aggregation30 Aggregation Mode: Dynamic Loadshar ...
最新文章
- 25.怎样在IDEA中使用JUnit4和JUnitGenerator V2.0自动生成测试模块
- ASP.NET Web API MediaTypeFormatter
- mine 规范_《民用建筑热工设计规范》GB50176-2016
- 这才是老公的正确用法,不吃就往死里打......
- SpringBoot入门到精通_第4篇 _开发三板斧
- php中数组下标,PHP数组介绍_php
- python findcontours_基于Python的opencv学习练习(十二) findContours()轮廓与绘制drawContours()...
- CAP原理和最终一致性(Eventually Consistency)
- CSS 属性篇(六):background-size属性
- pysnmp snmpwalk
- WINDOWS CMAKE与NMAKE
- 微信商户、支付宝特殊能力开通
- xxl-job分布式任务调度平台
- 2023新年快乐,友盟+伴你岁岁年年
- CentOS 7账号密码忘了怎么办?
- Ae试水~(待填坑)
- qpsk的映射过程_(完整版)QPSK调制原理及matlab程序实现
- go发送smtp邮件时的踩坑记录——auth login、x509: cannot validate certificate for错误
- Excel如何将数据拆分开
- var、let、const的区别