規(guī)則執(zhí)行器：告別冗余IF判斷，讓代碼更優(yōu)雅高效
作者：一安
針對(duì)這個(gè)需求，我首先梳理了一下咱們規(guī)則執(zhí)行器大概的設(shè)計(jì)， 然后我設(shè)計(jì)了一個(gè) V1 版本和大家一起分享一下，如果大家也有這樣的 case 可以給我分享留言，下面部分主要是設(shè)計(jì)和實(shí)現(xiàn)的流程和 code。
最近公司有個(gè)小需求，需要對(duì)之前已有的試用用戶申請(qǐng)規(guī)則進(jìn)行拓展。我們的場(chǎng)景大概如下所示:
if (是否海外用戶) {
return false;
}
if (刷單用戶) {
return false;
}
if (未付費(fèi)用戶 && 不再服務(wù)時(shí)段) {
return false
}
if (轉(zhuǎn)介紹用戶 || 付費(fèi)用戶 || 內(nèi)推用戶) {
return true;
}按照上述的條件我們可以得出的結(jié)論是：
- 咱們的的主要流程主要是基于and 或者or 的關(guān)系。
- 如果有一個(gè)不匹配的話，其實(shí)咱們后續(xù)的流程是不用執(zhí)行的，就是需要具備一個(gè)短路的功能。
- 對(duì)于目前的現(xiàn)狀來說，我如果在原有的基礎(chǔ)上來改，只要稍微注意一下解決需求不是很大的問題，但是說后面可維護(hù)性非常差。
后面經(jīng)過權(quán)衡過后，我還是決定將這個(gè)部分進(jìn)行重構(gòu)一下。
規(guī)則執(zhí)行器
針對(duì)這個(gè)需求，我首先梳理了一下咱們規(guī)則執(zhí)行器大概的設(shè)計(jì)， 然后我設(shè)計(jì)了一個(gè) V1 版本和大家一起分享一下，如果大家也有這樣的 case 可以給我分享留言，下面部分主要是設(shè)計(jì)和實(shí)現(xiàn)的流程和 code。
規(guī)則執(zhí)行器的設(shè)計(jì)
規(guī)則處理邏輯優(yōu)化
對(duì)于規(guī)則的抽象并實(shí)現(xiàn)規(guī)則
// 業(yè)務(wù)數(shù)據(jù)
@Data
public class RuleDto {
private String address;
private int age;
}
// 規(guī)則抽象
public interface BaseRule {
boolean execute(RuleDto dto);
}
// 規(guī)則模板
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;
}
}
// 具體規(guī)則- 例子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;
}
}
// 具體規(guī)則- 例子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= "中國";
}執(zhí)行器構(gòu)建
public class RuleService {
private Map<Integer, List<BaseRule>> hashMap = new HashMap<>();
private static final int AND = 1;
private static final int OR = 0;
public static RuleService create() {
return new 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 boolean execute(RuleDto dto) {
for (Map.Entry<Integer, List<BaseRule>> item : hashMap.entrySet()) {
List<BaseRule> ruleList = item.getValue();
switch (item.getKey()) {
case AND:
// 如果是 and 關(guān)系，同步執(zhí)行
System.out.println("execute key = " + 1);
if (!and(dto, ruleList)) {
return false;
}
break;
case OR:
// 如果是 or 關(guān)系，并行執(zhí)行
System.out.println("execute key = " + 0);
if (!or(dto, ruleList)) {
return false;
}
break;
default:
break;
}
}
return true;
}
private boolean and(RuleDto dto, List<BaseRule> ruleList) {
for (BaseRule rule : ruleList) {
boolean execute = rule.execute(dto);
if (!execute) {
// and 關(guān)系匹配失敗一次，返回 false
return false;
}
}
// and 關(guān)系全部匹配成功，返回 true
return true;
}
private boolean or(RuleDto dto, List<BaseRule> ruleList) {
for (BaseRule rule : ruleList) {
boolean execute = rule.execute(dto);
if (execute) {
// or 關(guān)系匹配到一個(gè)就返回 true
return true;
}
}
// or 關(guān)系一個(gè)都匹配不到就返回 false
return false;
}
}執(zhí)行器的調(diào)用
public class RuleServiceTest {
@org.junit.Test
public void execute() {
//規(guī)則執(zhí)行器
//優(yōu)點(diǎn)：比較簡單，每個(gè)規(guī)則可以獨(dú)立，將規(guī)則，數(shù)據(jù)，執(zhí)行器拆分出來，調(diào)用方比較規(guī)整
//缺點(diǎn)：數(shù)據(jù)依賴公共傳輸對(duì)象 dto
//1. 定義規(guī)則 init rule
AgeRule ageRule = new AgeRule();
NameRule nameRule = new NameRule();
NationalityRule nationalityRule = new NationalityRule();
AddressRule addressRule = new AddressRule();
SubjectRule subjectRule = new SubjectRule();
//2. 構(gòu)造需要的數(shù)據(jù) create dto
RuleDto dto = new RuleDto();
dto.setAge(5);
dto.setName("張三");
dto.setAddress("北京");
dto.setSubject("數(shù)學(xué)");;
//3. 通過以鏈?zhǔn)秸{(diào)用構(gòu)建和執(zhí)行 rule execute
boolean ruleResult = RuleService
.create()
.and(Arrays.asList(nationalityRule, nameRule, addressRule))
.or(Arrays.asList(ageRule, subjectRule))
.execute(dto);
System.out.println("this student rule execute result :" + ruleResult);
}
}總結(jié)
規(guī)則執(zhí)行器的優(yōu)點(diǎn)和缺點(diǎn)
- 優(yōu)點(diǎn)：
比較簡單，每個(gè)規(guī)則可以獨(dú)立，將規(guī)則，數(shù)據(jù)，執(zhí)行器拆分出來，調(diào)用方比較規(guī)整；
我在 Rule 模板類中定義 convert 方法做參數(shù)的轉(zhuǎn)換這樣可以能夠，為特定 rule 需要的場(chǎng)景數(shù)據(jù)提供拓展。
- 缺點(diǎn)：上下 rule 有數(shù)據(jù)依賴性，如果直接修改公共傳輸對(duì)象 dto 這樣設(shè)計(jì)不是很合理，建議提前構(gòu)建數(shù)據(jù)。
責(zé)任編輯：武曉燕
來源：
一安未來
