策略模式(Strategy Pattern)定义了一组策略,分别在不同类中封装起来,每种策略都 可以根据当前场景相互替换,从而使策略的变化可以独立于操作者。比如我们要去某个 地方,会根据距离的不同(或者是根据手头经济状况)来选择不同的出行方式(共享单 车、坐公交、滴滴打车等等),这些出行方式即不同的策略。

何时使用策略模式

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

  1. if (conditionA) {
  2. 逻辑 1
  3. } else if (conditionB) {
  4. 逻辑 2
  5. } else if (conditionC) {
  6. 逻辑 3
  7. } else {
  8. 逻辑 4
  9. }

这种代码虽然写起来简单,但是很明显违反了面向对象的 2 个基本原则:

  • 单一职责原则(一个类应该只有一个发生变化的原因):因为之后修改任何一个逻辑, 当前类都会被修改。
  • 开闭原则(对扩展开放,对修改关闭):如果此时需要添加(删除)某个逻辑,那么不 可避免的要修改原来的代码。

因为违反了以上两个原则,尤其是当 if-else 块中的代码量比较大时,后续代码的扩展和维 护就会逐渐变得非常困难且容易出错,使用卫语句也同样避免不了以上两个问题。因此根据 我的经验,得出一个我个人认为比较好的实践:

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

卫语句就是把复杂的条件表达式拆分成多个条件表达式,减少嵌套。嵌套了好几层的if - then-else语句,转换为多个if语句,实现它的逻辑,这多条的if语句就是卫语句。

卫语句示例:

  1. 未使用卫语句:
  2. public void getHello(int type) {
  3. if (type == 1) {
  4. return;
  5. } else {
  6. if (type == 2) {
  7. return;
  8. } else {
  9. if (type == 3) {
  10. return;
  11. } else {
  12. //若在此处在次判断type的值,这个嵌套会更加进行
  13. setHello();
  14. }
  15. }
  16. }
  17. }
  18. 使用卫语句:
  19. public void getHello(int type) {
  20. if (type == 1) {
  21. return;
  22. }
  23. if (type == 2) {
  24. return;
  25. }
  26. if (type == 3) {
  27. return;
  28. }
  29. setHello();
  30. }

愉快地使用策略模式

在 Spring 中,实现策略模式的方法多种多样,下面我分享一下我目前实现策略模式的 “最 佳套路”(如果你有更好的套路,欢迎赐教,一起讨论哦)。

需求背景

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

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

现在,有请我的 “最佳套路” 上场。

第一步,定义策略接口

首先定义策略的接口,包括两个方法:

  1. 获取策略类型的方法
  2. 处理策略逻辑的方法

FormSubmitHandler 接口

  1. /**
  2. * 表单提交处理器
  3. */
  4. public interface FormSubmitHandler<R extends Serializable> {
  5. /**
  6. * 获得提交类型(返回值也可以使用已经存在的枚举类)
  7. *
  8. * @return 提交类型
  9. */
  10. String getSubmitType();
  11. /**
  12. * 处理表单提交请求
  13. *
  14. * @param request 请求
  15. * @return 响应,left 为返回给前端的提示信息,right 为业务值
  16. */
  17. CommonPairResponse<String, R> handleSubmit(FormSubmitRequest request);
  18. }

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

  1. /**
  2. * 表单提交的请求
  3. */
  4. @Getter
  5. @Setter
  6. public class FormSubmitRequest {
  7. /**
  8. * 提交类型
  9. *
  10. * @see FormSubmitHandler#getSubmitType()
  11. */
  12. private String submitType;
  13. /**
  14. * 用户 id
  15. */
  16. private Long userId;
  17. /**
  18. * 表单提交的值
  19. */
  20. private Map<String, Object> formInput;
  21. }

第二步,相关策略实现

预览表单时的提交:

  1. @Component
  2. public class FormPreviewSubmitHandler implements FormSubmitHandler<Serializable> {
  3. private final Logger logger = LoggerFactory.getLogger(this.getClass());
  4. @Override
  5. public String getSubmitType() { return "preview"; }
  6. @Override
  7. public CommonPairResponse<String, Serializable> handleSubmit(FormSubmitRequest request) {
  8. logger.info("预览模式提交:userId={}, formInput={}", request.getUserId(), request.getFormInput())
  9. return CommonPairResponse.success("预览模式提交数据成功!", null);
  10. }
  11. }

模型输入时的提交:

  1. @Component
  2. public class FormModelSubmitHandler implements FormSubmitHandler<Long> {
  3. private final Logger logger = LoggerFactory.getLogger(this.getClass());
  4. @Override
  5. public String getSubmitType() { return "model"; }
  6. @Override
  7. public CommonPairResponse<String, Long> handleSubmit(FormSubmitRequest request) {
  8. logger.info("模型提交:userId={}, formInput={}", request.getUserId(), request.getFormInput());
  9. // 模型创建成功后获得模型的 id
  10. Long modelId = createModel(request);
  11. return CommonPairResponse.success("模型提交成功!", modelId);
  12. }
  13. private Long createModel(FormSubmitRequest request) { // 创建模型的逻辑
  14. return 123L;
  15. }
  16. }

HSF 模式的提交:

  1. @Component
  2. public class FormHsfSubmitHandler implements FormSubmitHandler<Serializable> {
  3. private final Logger logger = LoggerFactory.getLogger(this.getClass());
  4. @Override
  5. public String getSubmitType() { return "hsf"; }
  6. @Override
  7. public CommonPairResponse<String, Serializable> handleSubmit(FormSubmitRequest request) {
  8. logger.info("HSF 模式提交:userId={}, formInput={}", request.getUserId(), request.getFormInput());
  9. // 进行 HSF 泛化调用,获得业务方返回的提示信息和业务数据
  10. CommonPairResponse<String, Serializable> response = hsfSubmitData(request);
  11. return response;
  12. }
  13. }

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

  1. @Component
  2. public class FormSubmitHandlerFactory implements InitializingBean, ApplicationContextAware {
  3. private static final Map<String, FormSubmitHandler<Serializable>> FORM_SUBMIT_HANDLER_MAP = new HashMap<>(8);
  4. private ApplicationContext appContext;
  5. /**
  6. * 根据提交类型获取对应的处理器
  7. *
  8. * @param submitType 提交类型
  9. * @return 提交类型对应的处理器
  10. */
  11. public FormSubmitHandler<Serializable> getHandler(String submitType) {
  12. return FORM_SUBMIT_HANDLER_MAP.get(submitType);
  13. }
  14. @Override
  15. public void afterPropertiesSet() {
  16. // 将 Spring 容器中所有的 FormSubmitHandler 注册到 FORM_SUBMIT_HANDLER_MAP
  17. appContext.getBeansOfType(FormSubmitHandler.class)
  18. .values()
  19. .forEach(handler -> FORM_SUBMIT_HANDLER_MAP.put(handler.getSubmitType(), handler));
  20. }
  21. @Override
  22. public void setApplicationContext(@NonNull ApplicationContext applicationContext) {
  23. appContext = applicationContext;
  24. }
  25. }

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

第四步,使用 & 测试

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

  1. @Service
  2. public class FormServiceImpl implements FormService {
  3. @Autowired
  4. private FormSubmitHandlerFactory submitHandlerFactory;
  5. public CommonPairResponse<String, Serializable> submitForm(@NonNull FormSubmitRequest request) {
  6. String submitType = request.getSubmitType();
  7. // 根据 submitType 找到对应的提交处理器
  8. FormSubmitHandler<Serializable> submitHandler = submitHandlerFactory.getHandler(submitType);
  9. // 判断 submitType 对应的 handler 是否存在
  10. if (submitHandler == null) {
  11. return CommonPairResponse.failure("非法的提交类型: " + submitType);
  12. }
  13. // 处理提交
  14. return submitHandler.handleSubmit(request);
  15. }
  16. }

Factory 只负责获取 Handler,Handler 只负责处理具体的提交,Service 只负责逻辑编排, 从而达到功能上的 “低耦合高内聚”。
写一个简单的 Controller:

  1. @RestController
  2. public class SimpleController {
  3. @Autowired
  4. private FormService formService;
  5. @PostMapping("/form/submit")
  6. public CommonPairResponse<String, Serializable> submitForm(@RequestParam String submitType, String formInputJson) {
  7. JSONObject formInput = JSON.parseObject(formInputJson);
  8. FormSubmitRequest request = new FormSubmitRequest();
  9. request.setUserId(123456L);
  10. request.setSubmitType(submitType);
  11. request.setFormInput(formInput);
  12. return formService.submitForm(request);
  13. }
  14. }

我感觉到了,这就是非常流畅的感觉~

设想一次扩展

如果我们需要加入一个新的策略,比如绑定 FaaS 函数的提交,我们只需要添加一个新的 策略实现即可,此时不需要修改任何代码,因为Spring 容器重启时会自动将新的实现注册到 FormSubmitHandlerFactory 中 —— 面向 Spring 编程, 太香惹~

参考 阿里淘系技术2020技术年华-技术人的百宝黑皮书.pdf