近日在公司领到一个小需求,需要对之前已有的试用用户申请规则进行拓展。我们的场景大概如下所示:

  1. if (是否海外用户) {
  2. return false;
  3. }
  4. if (刷单用户) {
  5. return false;
  6. }
  7. if (未付费用户 && 不再服务时段) {
  8. return false
  9. }
  10. if (转介绍用户 || 付费用户 || 内推用户) {
  11. return true;
  12. }

按照上述的条件我们可以得出的结论是:

  • 咱们的的主要流程主要是基于 and 或者 or 的关系。
  • 如果有一个不匹配的话,其实咱们后续的流程是不用执行的,就是需要具备一个短路的功能。
  • 对于目前的现状来说,我如果在原有的基础上来改,只要稍微注意一下解决需求不是很大的问题,但是说后面可维护性非常差。

后面进过权衡过后,我还是决定将这个部分进行重构一下。

规则执行器

针对这个需求,我首先梳理了一下咱们规则执行器大概的设计, 然后我设计了一个 V1 版本和大家一起分享一下,如果大家也有这样的 case 可以给我分享留言,下面部分主要是设计和实现的流程和 code.

规则执行器的设计

解决大量if 来判断 - 图1

对于规则的抽象并实现规则

  1. // 业务数据
  2. @Data
  3. public class RuleDto {
  4. private String address;
  5. private int age;
  6. }
  7. // 规则抽象
  8. public interface BaseRule {
  9. boolean execute(RuleDto dto);
  10. }
  11. // 规则模板
  12. public abstract class AbstractRule implements BaseRule {
  13. protected <T> T convert(RuleDto dto) {
  14. return (T) dto;
  15. }
  16. @Override
  17. public boolean execute(RuleDto dto) {
  18. return executeRule(convert(dto));
  19. }
  20. protected <T> boolean executeRule(T t) {
  21. return true;
  22. }
  23. }
  24. // 具体规则- 例子1
  25. public class AddressRule extends AbstractRule {
  26. @Override
  27. public boolean execute(RuleDto dto) {
  28. System.out.println("AddressRule invoke!");
  29. if (dto.getAddress().startsWith(MATCH_ADDRESS_START)) {
  30. return true;
  31. }
  32. return false;
  33. }
  34. }
  35. // 具体规则- 例子2
  36. public class NationalityRule extends AbstractRule {
  37. @Override
  38. protected <T> T convert(RuleDto dto) {
  39. NationalityRuleDto nationalityRuleDto = new NationalityRuleDto();
  40. if (dto.getAddress().startsWith(MATCH_ADDRESS_START)) {
  41. nationalityRuleDto.setNationality(MATCH_NATIONALITY_START);
  42. }
  43. return (T) nationalityRuleDto;
  44. }
  45. @Override
  46. protected <T> boolean executeRule(T t) {
  47. System.out.println("NationalityRule invoke!");
  48. NationalityRuleDto nationalityRuleDto = (NationalityRuleDto) t;
  49. if (nationalityRuleDto.getNationality().startsWith(MATCH_NATIONALITY_START)) {
  50. return true;
  51. }
  52. return false;
  53. }
  54. }
  55. // 常量定义
  56. public class RuleConstant {
  57. public static final String MATCH_ADDRESS_START= "北京";
  58. public static final String MATCH_NATIONALITY_START= "中国";
  59. }

执行器构建

  1. public class RuleService {
  2. private Map<Integer, List<BaseRule>> hashMap = new HashMap<>();
  3. private static final int AND = 1;
  4. private static final int OR = 0;
  5. public static RuleService create() {
  6. return new RuleService();
  7. }
  8. public RuleService and(List<BaseRule> ruleList) {
  9. hashMap.put(AND, ruleList);
  10. return this;
  11. }
  12. public RuleService or(List<BaseRule> ruleList) {
  13. hashMap.put(OR, ruleList);
  14. return this;
  15. }
  16. public boolean execute(RuleDto dto) {
  17. for (Map.Entry<Integer, List<BaseRule>> item : hashMap.entrySet()) {
  18. List<BaseRule> ruleList = item.getValue();
  19. switch (item.getKey()) {
  20. case AND:
  21. // 如果是 and 关系,同步执行
  22. System.out.println("execute key = " + 1);
  23. if (!and(dto, ruleList)) {
  24. return false;
  25. }
  26. break;
  27. case OR:
  28. // 如果是 or 关系,并行执行
  29. System.out.println("execute key = " + 0);
  30. if (!or(dto, ruleList)) {
  31. return false;
  32. }
  33. break;
  34. default:
  35. break;
  36. }
  37. }
  38. return true;
  39. }
  40. private boolean and(RuleDto dto, List<BaseRule> ruleList) {
  41. for (BaseRule rule : ruleList) {
  42. boolean execute = rule.execute(dto);
  43. if (!execute) {
  44. // and 关系匹配失败一次,返回 false
  45. return false;
  46. }
  47. }
  48. // and 关系全部匹配成功,返回 true
  49. return true;
  50. }
  51. private boolean or(RuleDto dto, List<BaseRule> ruleList) {
  52. for (BaseRule rule : ruleList) {
  53. boolean execute = rule.execute(dto);
  54. if (execute) {
  55. // or 关系匹配到一个就返回 true
  56. return true;
  57. }
  58. }
  59. // or 关系一个都匹配不到就返回 false
  60. return false;
  61. }
  62. }

执行器的调用

  1. public class RuleServiceTest {
  2. @org.junit.Test
  3. public void execute() {
  4. //规则执行器
  5. //优点:比较简单,每个规则可以独立,将规则,数据,执行器拆分出来,调用方比较规整
  6. //缺点:数据依赖公共传输对象 dto
  7. //1. 定义规则 init rule
  8. AgeRule ageRule = new AgeRule();
  9. NameRule nameRule = new NameRule();
  10. NationalityRule nationalityRule = new NationalityRule();
  11. AddressRule addressRule = new AddressRule();
  12. SubjectRule subjectRule = new SubjectRule();
  13. //2. 构造需要的数据 create dto
  14. RuleDto dto = new RuleDto();
  15. dto.setAge(5);
  16. dto.setName("张三");
  17. dto.setAddress("北京");
  18. dto.setSubject("数学");;
  19. //3. 通过以链式调用构建和执行 rule execute
  20. boolean ruleResult = RuleService
  21. .create()
  22. .and(Arrays.asList(nationalityRule, nameRule, addressRule))
  23. .or(Arrays.asList(ageRule, subjectRule))
  24. .execute(dto);
  25. System.out.println("this student rule execute result :" + ruleResult);
  26. }
  27. }

总结

规则执行器的优点和缺点

优点:

  • 比较简单,每个规则可以独立,将规则,数据,执行器拆分出来,调用方比较规整;
  • 我在 Rule 模板类中定义 convert 方法做参数的转换这样可以能够,为特定 rule 需要的场景数据提供拓展。

    缺点:

  • 上下 rule 有数据依赖性,如果直接修改公共传输对象 dto 这样设计不是很合理,建议提前构建数据。