业务背景
近日在公司领到一个小需求,需要对之前已有的试用用户申请规则进行拓展。我们的场景大概如下所示:
- if (是否海外用户) {
- return false;
- }
- if (刷单用户) {
- return false;
- }
- if (未付费用户 && 不再服务时段) {
- return false;
- }
- if (转介绍用户 || 付费用户 || 内推用户) {
- return true;
- } else {
- return false;
- }
按照上述的条件我们可以得出的结论是:
咱们的的主要流程主要是基于 and 或者 or 的关系。
如果有一个不匹配的话,其实咱们后续的流程是不用执行的,就是需要具备一个短路的功能。
对于目前的现状来说,我如果在原有的基础上来修改,只要稍微注意一下解决需求不是很大的问题,但是说后面可维护性非常差。
后面进过权衡过后,我还是决定将这个部分进行重构一下。
规则执行器
针对这个需求,我首先梳理了一下咱们规则执行器大概的设计, 我们首先需要对规则进行抽象, 然后定义规则模板,然后通过规则模板去自己实现具体的规则,最后对于规则中可能会存在共享对象的转换,我们提前在模板方法中定义即可,后期如果需要的话,可以对 DSL 语言或者增加脚本语言解析器,以及反射 class 文件的方式来实现动态拓展。
最后我设计了一个 V1 版本和大家一起分享一下,如果大家也有这样的 case 可以给我分享留言,下面部分主要是设计和实现的流程和 code .
规则执行器的设计
对于我规则的执行器的设计,我收到 <<策略模式>> 和 << 规约模式>> 的启发。 在这个场景咱们首先想到的就是将规则的自然语言转换为程序代码。在 DDD 设计中,我们可以选择 DSL 方式来处理 Rule 的一种方式;对于业务数据处理或者其他的复杂流程,我们可以通过 Rule 模板来进行自定义实现具体的 Rule 策略。
对于规则执行器的处理步骤如下:
- 首先需要构造业务数据如用户基本,用户状态,以及一些业务数据;
- 然后通过当前的上下文,获取具体规则列表,这里可以从规则工厂中获取;
- 然后调用规则执行方法拿到结果。
- 在执行的过程,对链接关系的处理,常用的关系有 and or not 等
抽象规则和定义模板
首先需要定义 BaseRule 作为 Rule 的一个抽象,定义 execute 方法为执行方法。然后定义 AbstractRule
作为规则模板,作为一个方法的公共实现,提供拓展点 convert 、executeRule 可以用户转换自定义 RuleDto 数据结构。 AddressRule 和 NationalityRule分别做为两个实现 Rule 的具体策略或者说是具体实现。
- // 业务数据
- @Data
- public class RuleDto {
- private String address;
- private int age;
- }
- // 规则抽象
- public interface BaseRule {
- boolean execute(RuleDto dto);
- }
- // 规则模板
- public abstract class AbstractRule implements BaseRule {
- protected <T> T convert(RuleDto dto) {
- return (T) dto;
- }
- @Override
- public boolean execute(RuleDto dto) {
- return executeRule(convert(dto));
- }
- protected <T> boolean executeRule(T t) {
- return true;
- }
- }
- // 具体规则- 例子1
- public class AddressRule extends AbstractRule {
- @Override
- public boolean execute(RuleDto dto) {
- System.out.println("AddressRule invoke!");
- if (dto.getAddress().startsWith(MATCH_ADDRESS_START)) {
- return true;
- }
- return false;
- }
- }
- // 具体规则- 例子2
- public class NationalityRule extends AbstractRule {
- @Override
- protected <T> T convert(RuleDto dto) {
- NationalityRuleDto nationalityRuleDto = new NationalityRuleDto();
- if (dto.getAddress().startsWith(MATCH_ADDRESS_START)) {
- nationalityRuleDto.setNationality(MATCH_NATIONALITY_START);
- }
- return (T) nationalityRuleDto;
- }
- @Override
- protected <T> boolean executeRule(T t) {
- System.out.println("NationalityRule invoke!");
- NationalityRuleDto nationalityRuleDto = (NationalityRuleDto) t;
- if (nationalityRuleDto.getNationality().startsWith(MATCH_NATIONALITY_START)) {
- return true;
- }
- return false;
- }
- }
- // 常量定义
- public class RuleConstant {
- public static final String MATCH_ADDRESS_START= "北京";
- public static final String MATCH_NATIONALITY_START= "中国";
- }
规则执行器的核心构建
RuleService 是规则执行和规则管道链接的具体类,在这个类里面我们首先提供了一个构造器方法 create()可以提供默认的初始化过程
- // 规则执行器
- public class RuleService {
- private Map<Integer, List<BaseRule>> hashMap = new HashMap<>();
- private static final int NOT = 2;
- private static final int AND = 1;
- private static final int OR = 0;
- private RuleDto ruleDto;
- public static RuleService create(RuleDto ruleDto) {
- RuleService ruleService = new RuleService();
- ruleService.ruleDto = ruleDto;
- return ruleService;
- }
- public RuleService and(List<BaseRule> ruleList) {
- hashMap.put(AND, ruleList);
- return this;
- }
- public RuleService or(List<BaseRule> ruleList) {
- hashMap.put(OR, ruleList);
- return this;
- }
- public RuleService not(List<BaseRule> ruleList) {
- hashMap.put(NOT, ruleList);
- return this;
- }
- public boolean execute() {
- return this.execute(ruleDto);
- }
- private boolean execute(RuleDto dto) {
- for (Map.Entry<Integer, List<BaseRule>> item : hashMap.entrySet()) {
- List<BaseRule> ruleList = item.getValue();
- switch (item.getKey()) {
- case AND:
- // 如果是 and 关系,同步执行
- System.out.println("execute key = " + 1);
- if (!andRule(dto, ruleList)) {
- return false;
- }
- break;
- case OR:
- // 如果是 or 关系,并行执行
- System.out.println("execute key = " + 0);
- if (!orRule(dto, ruleList)) {
- return false;
- }
- break;
- case NOT:
- // 如果是 not 关系
- System.out.println("execute key = " + 2);
- if (!notRule(dto, ruleList)) {
- return false;
- }
- default:
- break;
- }
- }
- return true;
- }
- private boolean andRule(RuleDto dto, List<BaseRule> ruleList) {
- for (BaseRule rule : ruleList) {
- boolean execute = rule.execute(dto);
- if (!execute) {
- // and 关系匹配失败一次,返回 false
- return false;
- }
- }
- // and 关系全部匹配成功,返回 true
- return true;
- }
- private boolean orRule(RuleDto dto, List<BaseRule> ruleList) {
- for (BaseRule rule : ruleList) {
- boolean execute = rule.execute(dto);
- if (execute) {
- // or 关系匹配到一个就返回 true
- return true;
- }
- }
- // or 关系一个都匹配不到就返回 false
- return false;
- }
- private boolean notRule(RuleDto dto, List<BaseRule> ruleList) {
- // not 规则内部为 and 链接
- return !andRule(dto, ruleList);
- }
- }
- // 规则工厂类
- public class RuleServices {
- /**
- * 学生规则教研
- *
- * @return
- */
- public static RuleService isValidStudent(RuleDto ruleDto) {
- AgeRule ageRule = new AgeRule();
- NameRule nameRule = new NameRule();
- NationalityRule nationalityRule = new NationalityRule();
- AddressRule addressRule = new AddressRule();
- SubjectRule subjectRule = new SubjectRule();
- Flag110Rule flag110Rule = new Flag110Rule();
- return RuleService
- .create(ruleDto)
- .and(Arrays.asList(nationalityRule, nameRule, addressRule))
- .or(Arrays.asList(ageRule, subjectRule))
- .not(Collections.singletonList(flag110Rule));
- }
- }
客户端调用代码
客户端调用主要分为三个步骤:
首先是需要构造业务数据,因为规则策略,是基于数据处理的。
然后从规则工厂中,获取规则列表后返回规则定义执行器。
最后执行规则,返回结果。
- public class RuleServiceTest {
- @org.junit.Test
- public void execute() {
- //规则执行器
- //优点:比较简单,每个规则可以独立,将规则,数据,执行器拆分出来,调用方比较规整
- //缺点:数据依赖公共传输对象 dto
- //1. 构造需要的数据 create dto
- RuleDto dto = new RuleDto();
- dto.setAge(5);
- dto.setName("张三");
- dto.setAddress("北京");
- dto.setSubject("数学");;
- //2. 定义规则 init rule
- RuleService ruleService = RuleServices.isValidStudent(dto);
- //3. 规则执行 rule execute
- boolean ruleResult = ruleService.execute();
- System.out.println("this student rule execute result :" + ruleResult);
- }
- }
总结
规则执行器的优点和缺点
优点:
- 比较简单,每个规则可以独立,将规则,数据,执行器拆分出来,调用方比较规整;
- 我在 Rule 模板类中定义 convert 方法做参数的转换这样可以能够,为特定 rule 需要的场景数据提供拓展。
缺点:上下游 rule 有数据依赖性,如果直接修改 dto 传输对象的值不是特别合理,这种建议采用中间数据存储临时数据。
参考资料
https://www.codenong.com/30430818
https://cloud.tencent.com/developer/article/1528935