工厂+策略+模板模式消除代码中的if else

2023-08-01

字数统计: 1.6k字 | 阅读时长≈ 8分

前言

在日常开发中我们经常会碰到许多if else，如果if else过多，代码就会变得难以维护，这时候我们就可以使用工厂+策略+模板模式来优化代码，让代码更加清晰，易于维护, 本文将着重讲解 springboot 项目中的实现案例，带领大家体会设计模式开闭原则带来的好处。

一、业务需求

例如手机系统中很多应用需要提供多支付方式扣款，目前需要支持支付宝、微信和云闪付这个三种支付方式
if else 写法伪代码如下：

public boolean pay(Integer payType, BigDecimal money) {
    if (payType == 1) { // 支付宝支付
        return alipay(money);
    } else if (payType == 2) { // 微信支付
        return wechat(money);
    } else if (payType == 3) { // 云闪付支付
        return unionpay(money);
    }
    return false;
}

二、代码实现

1.工厂模式

springboot 中通过 @Resource private List<AbstractHandler> handlers, @Resource private Map<String, AbstractHandler> 能将所有的继承抽象类或者实现接口的类注入到对应的List或Map中；在此前提下， AppFactory 通过实现了 InitializingBean 的 afterPropertiesSet() 方法，在初始化bean后将系统中所有的 handler 注册到 strategyMap ，那么新增策略就不需要我们手动维护到 strategyMap 中。
（不使用模板模式可以将 AbstractHandler 都替换成 Handler ）

package com.xxx.design.pattern.service;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.map.MapUtil;
import com.xxx.design.pattern.handler.AbstractHandler;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.List;
import java.util.Map;

/**
 * @author yinshuang
 * @date 2023/8/1 23:44
 * @description AppFactory
 */
@Slf4j
@Component
public final class AppFactory implements InitializingBean {

    @Resource
    private List<AbstractHandler> handlers;

    private final Map<Integer, AbstractHandler> strategyMap = MapUtil.newConcurrentHashMap();

    /**
     * 根据type获取handler
     *
     * @param type 类型
     * @return handler 策略处理类
     */
    public AbstractHandler getStrategy(Integer type) {
        return strategyMap.get(type);
    }

    /**
     * 注册handler
     *
     * @param handler 策略处理类
     */
    public void register (AbstractHandler handler) {
        if (handler == null || handler.getType() == null) {
            return;
        }
        strategyMap.put(handler.getType(), handler);
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        // 初始化bean后注册所有handler
        if (CollUtil.isNotEmpty(handlers)) {
            handlers.forEach(this::register);
        }
    }
}

2.策略模式+模板模式

方式1.定义接口 (适用于所有策略都是统一接口的场景)

package com.xxx.design.pattern.handler;

import java.math.BigDecimal;

/**
 * @author yinshuang
 * @date 2023/8/2 11:13
 * @description Handler
 */
public interface Handler {

    public Integer getType();

    public void pay(BigDecimal money);
}

方式2.定义抽象类 (这里采用的就是模板模式，适用于所有策略支持灵活拓展方法的场景，如云闪付没有聊天功能，就不需要实现聊天方法即可)

package com.xxx.design.pattern.handler;

import com.xxx.design.pattern.constant.AppTypeEnum;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.InitializingBean;

import java.math.BigDecimal;

/**
 * @author yinshuang
 * @date 2023/8/1 23:46
 * @description AbstractHandler
 */
@Slf4j
public abstract class AbstractHandler {

    public Integer getType() {
        return -1;
    }

    public void pay(BigDecimal money) {
        log.info("该应用不支持付款操作");
        throw new UnsupportedOperationException();
    }

    public String chat(String chatObj, String content) {
        log.info("该应用不支持聊天操作");
        throw new UnsupportedOperationException();
    }
}

支付宝策略类实现 (不使用模板模式可以将 `extends AbstractHandler` 替换成 `implements Handler` )

package com.xxx.design.pattern.handler;

import com.xxx.design.pattern.constant.AppTypeEnum;
import com.xxx.design.pattern.service.AppFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.math.BigDecimal;

/**
 * @author yinshuang
 * @date 2023/8/1 23:47
 * @description AliPayHandler
 */
@Slf4j
@Component
public class AliPayHandler extends AbstractHandler {

    @Override
    public Integer getType() {
        return AppTypeEnum.ALIPAY.getCode();
    }

    @Override
    public void pay(BigDecimal menoy) {
        log.info("{}成功支付{}元！", AppTypeEnum.getEnumByCode(getType()).getDesc() , menoy);
    }

    @Override
    public String chat(String chatObj, String content) {
        AppTypeEnum typeEnum = AppTypeEnum.getEnumByCode(getType());
        log.info("用户使用{}向{}发送了消息，内容是：{}", typeEnum.getDesc(), chatObj, content);
        return typeEnum.getDesc() + "聊天对话回复消息";
    }

}

微信策略类实现

package com.xxx.design.pattern.handler;

import com.xxx.design.pattern.constant.AppTypeEnum;
import com.xxx.design.pattern.service.AppFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.math.BigDecimal;

/**
 * @author yinshuang
 * @date 2023/8/1 23:47
 * @description WeChatHandler
 */
@Slf4j
@Component
public class WeChatHandler extends AbstractHandler {

    @Override
    public Integer getType() {
        return AppTypeEnum.WECHAT.getCode();
    }

    @Override
    public void pay(BigDecimal menoy) {
        log.info("{}成功支付{}元！", AppTypeEnum.getEnumByCode(getType()).getDesc() , menoy);
    }

    @Override
    public String chat(String chatObj, String content) {
        AppTypeEnum typeEnum = AppTypeEnum.getEnumByCode(getType());
        log.info("用户使用{}向{}发送了消息，内容是：{}", typeEnum.getDesc(), chatObj, content);
        return typeEnum.getDesc() + "聊天对话回复消息";
    }
}

云闪付策略类实现

package com.xxx.design.pattern.handler;

import com.xxx.design.pattern.constant.AppTypeEnum;
import com.xxx.design.pattern.service.AppFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.math.BigDecimal;

/**
 * @author yinshuang
 * @date 2023/8/1 23:48
 * @description UnionPayHandler
 */
@Slf4j
@Component
public class UnionPayHandler extends AbstractHandler {

    @Override
    public Integer getType() {
        return AppTypeEnum.UNIONPAY.getCode();
    }

    @Override
    public void pay(BigDecimal menoy) {
        log.info("{}成功支付{}元！", AppTypeEnum.getEnumByCode(getType()).getDesc() , menoy);
    }

}

从上面的三种策略类的实现，我们不难看出，工厂+策略模式的写的多支付代码，添加一种新的支付方式只需要在代码中新增一种 handler 的策略类（重写 getType() 和 pay() 方法），体现了设计模式的开闭原则: 对扩展开放，对修改封闭。

3.测试类

package com.xxx.design.pattern;

import com.xxx.design.pattern.constant.AppTypeEnum;
import com.xxx.design.pattern.handler.AbstractHandler;
import com.xxx.design.pattern.service.AppFactory;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.annotation.Resource;
import java.math.BigDecimal;

/**
 * @author yinshuang
 * @date 2023/8/1 23:45
 * @description DesignPatternTestDesignPatternTest
 */
@Slf4j
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = DesignPatternApplication.class)
public class DesignPatternTest {
    @Resource
    private AppFactory appFactory;

    @Test
    @DisplayName("工厂+策略+模板模式测试")
    public void pattern001() {
        AbstractHandler handler1 = appFactory.getStrategy(AppTypeEnum.ALIPAY.getCode());
        handler1.pay(new BigDecimal("5"));
        handler1.chat("张三", "已转账5元请查收！");

        AbstractHandler handler2 = appFactory.getStrategy(AppTypeEnum.WECHAT.getCode());
        handler2.pay(new BigDecimal("10"));
        handler2.chat("李四", "已转账10元请查收！");

        AbstractHandler handler3 = appFactory.getStrategy(AppTypeEnum.UNIONPAY.getCode());
        handler3.pay(new BigDecimal("20"));
        // handler3没有重写chat，执行后会抛异常
        // handler3.chat("王五", "已转账20元请查收！");
    }
}

执行结果：

2023-08-02 11:22:33.556  INFO 11388 --- [           main] c.c.design.pattern.DesignPatternTest     : Started DesignPatternTest in 3.817 seconds (JVM running for 5.059)
2023-08-02 11:22:33.808  INFO 11388 --- [           main] c.c.d.pattern.handler.AliPayHandler      : 支付宝成功支付5元！
2023-08-02 11:22:33.808  INFO 11388 --- [           main] c.c.d.pattern.handler.AliPayHandler      : 用户使用支付宝向张三发送了消息，内容是：已转账5元请查收！
2023-08-02 11:22:33.808  INFO 11388 --- [           main] c.c.d.pattern.handler.WeChatHandler      : 微信成功支付10元！
2023-08-02 11:22:33.808  INFO 11388 --- [           main] c.c.d.pattern.handler.WeChatHandler      : 用户使用微信向李四发送了消息，内容是：已转账10元请查收！
2023-08-02 11:22:33.808  INFO 11388 --- [           main] c.c.d.pattern.handler.UnionPayHandler    : 云闪付成功支付20元！

本文作者： yinshuang
本文链接： https://yinshuang007.github.io/2023/08/01/工厂-策略模式优化代码中的if-else/
版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！

前言