设计模式-23-策略模式

背景
基本介绍
策略模式UML
应用示例
注意事项

背景

阿里开发规约-编程规约-控制语句-第六条：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现。相信大家都见过这种代码：

if (conditionA) {
逻辑 1
} else if (conditionB) {
逻辑 2
} else if (conditionC) {
逻辑 3
} else {
逻辑 4
}

这种代码虽然写起来简单，但是很明显违反了面向对象的 2 个基本原则：
单一职责原则（一个类应该只有一个发生变化的原因）：因为之后修改任何一个逻辑，当前类都会被修改。
开闭原则（对扩展开放，对修改关闭）：如果此时需要添加（删除）某个逻辑，那么不可避免的要修改原来的代码
因为违反了以上两个原则，尤其是当 if-else 块中的代码量比较大时，后续代码的扩展和维护就会逐渐变得非常困难且容易出错，使用卫语句也同样避免不了以上两个问题。因此根据我的经验，得出一个我个人认为比较好的实践：

if-else 不超过 2 层，块中代码 1~5 行，直接写到块中，否则封装为方法。 if-else 超过 2 层，但块中的代码不超过 3 行，尽量使用卫语句。 if-else 超过 2 层，且块中代码超过 3 行，尽量使用策略模式

基本介绍

策略模式（Strategy Pattern）中，定义算法族（策略组），分别封装起来，让他们之间可以互相替换，此模式让算法的变化独立于使用算法的客户
这算法体现了几个设计原则，第一、把变化的代码从不变的代码中分离出来；第二、针对接口编程而不是具体类（定义了策略接口）；第三、多用组合/聚合，少用继承（客户通过组合方式使用策略）。

策略模式UML

设计模式-23-策略模式 - 图1

说明：从上图可以看到，客户 context 有成员变量 strategy 或者其他的策略接口，至于需要使用到哪个策略，我们可以在构造器中指定

应用示例

需求说明

我们平台的动态表单，之前专门用于模型输入的提交。现在业务方希望对表单能力进行开放，除了可用于模型提交，还可以用于业务方指定功能的提交（方式设计为绑定一个 HSF 泛化服务，HSF 即淘系内部的 RPC 框架）。加上我们在配置表单时的 “预览模式” 下的提交，那么表单目前便有以下三种提交类型

预览表单时的提交
模型输入时的提交
绑定 HSF 时的提交

需求分析

代码实现
首先定义策略的接口，包括两个方法
1. 获取策略类型的方法
2. 处理策略逻辑的方法
```java /**
- 表单提交处理器
- @author Jason */ public interface FormSubmitHandler {
  
  /**
  - 获得提交类型（返回值也可以使用已经存在的枚举类）
  - @return 提交类型 */ String getSubmitType();
  /**
  - 处理表单提交请求 *
  - @param request 请求
  - @return 响应，left 为返回给前端的提示信息，right 为业务值 */ CommonPairResponse handleSubmit(FormSubmitRequest request);

```java
/**
 * 表单提交的请求
 * @author Jason
 */
@Getter
@Setter
public class FormSubmitRequest {
    /**
     * 提交类型
     *
     *@see FormSubmitHandler#getSubmitType() */
    private String submitType;
    /**
     * 用户 id
     */
    private Long userId;
    /**
     * 表单提交的值
     */
    private Map<String, Object> formInput;
    // 其他属性
}

其中，FormSubmitHandler 的 getSubmitType 方法用来获取表单的提交类型（即策略类型），用于根据客户端传递的参数直接获取到对应的策略实现；客户端传递的相关参数都被封装为 FormSubmitRequest，传递给 handleSubmit 进行处理。

第二步，相关策略实现

@Component
public class FormPreviewSubmitHandler implements FormSubmitHandler{

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public String getSubmitType() {
        return "preview";
    }

    @Override
    public CommonPairResponse handleSubmit(FormSubmitRequest request) {
        logger.info("预览模式提交：userId={}, formInput={}", request.getUserId(), request.getFormInput());
        return CommonPairResponse.success("预览模式提交数据成功！", null);
    }
}

@Component
public class FormModelSubmitHandler implements FormSubmitHandler<Long> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public String getSubmitType() {
        return "model";
    }

    @Override
    public CommonPairResponse<String, Long> handleSubmit(FormSubmitRequest request) {
        logger.info("模型提交：userId={}, formInput={}", request.getUserId(), request.getFormInput());
        // 模型创建成功后获得模型的 id
        Long modelId = createModel(request);
        return CommonPairResponse.success("模型提交成功！", modelId);
    }

    private Long createModel(FormSubmitRequest request) {
        // 创建模型的逻辑
        return 123L;
    }
}

@Component
public class FormHsfSubmitHandler implements FormSubmitHandler<Serializable> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public String getSubmitType() {
        return "hsf";
    }

    @Override
    public CommonPairResponse<String, Serializable> handleSubmit(FormSubmitRequest request) {
        logger.info("HSF 模式提交：userId={}, formInput={}", request.getUserId(), request.getFormInput());
        // 进行 HSF 泛化调用，获得业务方返回的提示信息和业务数据
        CommonPairResponse<String, Serializable> response = hsfSubmitData(request);
        return response;
    }

    private CommonPairResponse<String, Serializable> hsfSubmitData(FormSubmitRequest request) {
        return CommonPairResponse.success("", null);
    }
}

第三步，建立策略的简单工厂

@Component
public class FormSubmitHandlerFactory implements InitializingBean, ApplicationContextAware {

    private static final Map<String, FormSubmitHandler<Serializable>> FORM_SUBMIT_HANDLER_MAP = new HashMap<>(8);

    private ApplicationContext appContext;

    /**
     * 根据提交类型获取对应的处理器
     *
     * @param submitType 提交类型
     * @return 提交类型对应的处理器
     */
    public FormSubmitHandler<Serializable> getHandler(String submitType) {
        return FORM_SUBMIT_HANDLER_MAP.get(submitType);
    }

    @Override
    public void afterPropertiesSet() {
        // 将 Spring 容器中所有的 FormSubmitHandler 注册到 FORM_SUBMIT_HANDLER_MAP
        appContext.getBeansOfType(FormSubmitHandler.class)
                .values()
                .forEach(handler -> FORM_SUBMIT_HANDLER_MAP.put(handler.getSubmitType(), handler));
    }

    @Override
    public void setApplicationContext(@NonNull ApplicationContext applicationContext) {
        appContext = applicationContext;
    }

}

我们让 FormSubmitHandlerFactory 实现 InitializingBean 接口，在 afterPropertiesSet 方法中，基于 Spring 容器将所有 FormSubmitHandler 自动注册到 FORM_SUBMIT_HA NDLER_MAP，从而 Spring 容器启动完成后， getHandler 方法可以直接通过 submitType 来获取对应的表单提交处理器。

测试
在表单服务中，我们通过 FormSubmitHandlerFactory 来获取对应的表单提交处理器，从而处理不同类型的提交

@Service
public class FormServiceImpl implements FormService {

    @Autowired
    private FormSubmitHandlerFactory submitHandlerFactory;

    @Override
    public CommonPairResponse<String, Serializable> submitForm(FormSubmitRequest request) {
        String submitType = request.getSubmitType();
        // 根据 submitType 找到对应的提交处理器
        FormSubmitHandler<Serializable> submitHandler = submitHandlerFactory.getHandler(submitType);
        // 判断 submitType 对应的 handler 是否存在
        if (submitHandler == null) {
            return CommonPairResponse.failure("非法的提交类型: " + submitType);
        }
        // 处理提交
        return submitHandler.handleSubmit(request);
    }
}

Factory 只负责获取 Handler，Handler 只负责处理具体的提交，Service 只负责逻辑编排，从而达到功能上的 “低耦合高内聚”。

@RestController
public class SimpleController {

    @Autowired
    private FormService formService;


    @PostMapping("/form/submit")
    public CommonPairResponse<String, Serializable> submitForm(@RequestParam String submitType, @RequestParam String formInputJson) {
        JSONObject formInput = JSONUtil.parseObj(formInputJson);
        FormSubmitRequest request = new FormSubmitRequest();
        request.setUserId(123456L);
        request.setSubmitType(submitType);
        request.setFormInput(formInput);
        return formService.submitForm(request);
    }

}

注意事项

策略模式的关键是：分析项目中变化部分与不变部分
策略模式的核心思想是：多用组合/聚合少用继承；用行为类组合，而不是行为的继承。更有弹性
体现了“对修改关闭，对扩展开放”原则，客户端增加行为不用修改原有代码，只要添加一种策略（或者行为）即可，避免了使用多重转移语句（if…else if…else）
提供了可以替换继承关系的办法：策略模式将算法封装在独立的Strategy 类中使得你可以独立于其Context 改变它，使它易于切换、易于理解、易于扩展
需要注意的是：每添加一个策略就要增加一个类，当策略过多是会导致类数目庞

背景

基本介绍

策略模式UML

应用示例

需求说明

需求分析

代码实现

注意事项