Spring Boot中如何幹掉if else

cipher發表於2019-02-02
Spring Boot

前言

看到crossoverJie的文章《利用策略模式優化過多 if else 程式碼》後受到啟發，可以利用策略模式簡化過多的if else程式碼，文章中提到可以通過掃描實現處理器的自注冊，我在這裡介紹在Spring Boot框架中的實現方法。

需求

這裡虛擬一個業務需求，讓大家容易理解。假設有一個訂單系統，裡面的一個功能是根據訂單的不同型別作出不同的處理。

訂單實體：

public class OrderDTO {
    
    private String code;

    private BigDecimal price;

    /**
     * 訂單型別
     * 1：普通訂單；
     * 2：團購訂單；
     * 3：促銷訂單；
     */
    private String type;
    
    // ... 省略 get / set ...
    
}
複製程式碼

service介面：

public interface IOrderService {

    /**
     * 根據訂單的不同型別作出不同的處理
     *
     * @param dto 訂單實體
     * @return 為了簡單，返回字串
     */
    String handle(OrderDTO dto);

}
複製程式碼

傳統實現

根據訂單型別寫一堆的if else：

public class OrderServiceImpl implements IOrderService {

    @Override
    public String handle(OrderDTO dto) {
        String type = dto.getType();
        if ("1".equals(type)) {
            return "處理普通訂單";
        } else if ("2".equals(type)) {
            return "處理團購訂單";
        } else if ("3".equals(type)) {
            return "處理促銷訂單";
        }
        return null;
    }

}
複製程式碼

策略模式實現

利用策略模式，只需要兩行即可實現業務邏輯：

@Service
public class OrderServiceV2Impl implements IOrderService {

    @Autowired
    private HandlerContext handlerContext;

    @Override
    public String handle(OrderDTO dto) {
        AbstractHandler handler = handlerContext.getInstance(dto.getType());
        return handler.handle(dto);
    }

}
複製程式碼

可以看到上面的方法中注入了HandlerContext，這是一個處理器上下文，用來儲存不同的業務處理器，具體在下文會講解。我們從中獲取一個抽象的處理器AbstractHandler，呼叫其方法實現業務邏輯。

現在可以瞭解到，我們主要的業務邏輯是在處理器中實現的，因此有多少個訂單型別，就對應有多少個處理器。以後需求變化，增加了訂單型別，只需要新增相應的處理器就可以，上述OrderServiceV2Impl完全不需改動。

我們先看看業務處理器的寫法：

@Component
@HandlerType("1")
public class NormalHandler extends AbstractHandler {

    @Override
    public String handle(OrderDTO dto) {
        return "處理普通訂單";
    }

}
複製程式碼
@Component
@HandlerType("2")
public class GroupHandler extends AbstractHandler {

    @Override
    public String handle(OrderDTO dto) {
        return "處理團購訂單";
    }

}
複製程式碼
@Component
@HandlerType("3")
public class PromotionHandler extends AbstractHandler {

    @Override
    public String handle(OrderDTO dto) {
        return "處理促銷訂單";
    }

}
複製程式碼

首先每個處理器都必須新增到spring容器中，因此需要加上@Component註解，其次需要加上一個自定義註解@HandlerType，用於標識該處理器對應哪個訂單型別，最後就是繼承AbstractHandler，實現自己的業務邏輯。

自定義註解 @HandlerType：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface HandlerType {

    String value();

}
複製程式碼

抽象處理器 AbstractHandler：

public abstract class AbstractHandler {
    abstract public String handle(OrderDTO dto);
}
複製程式碼

自定義註解和抽象處理器都很簡單，那麼如何將處理器註冊到spring容器中呢？ 具體思路是：

  • 掃描指定包中標有@HandlerType的類；
  • 將註解中的型別值作為key，對應的類作為value，儲存在Map中；
  • 以上面的map作為建構函式引數，初始化HandlerContext，將其註冊到spring容器中；

我們將核心的功能封裝在HandlerProcessor類中，完成上面的功能。

HandlerProcessor：

@Component
@SuppressWarnings("unchecked")
public class HandlerProcessor implements BeanFactoryPostProcessor {

    private static final String HANDLER_PACKAGE = "com.cipher.handler_demo.handler.biz";

    /**
     * 掃描@HandlerType，初始化HandlerContext，將其註冊到spring容器
     *
     * @param beanFactory bean工廠
     * @see HandlerType
     * @see HandlerContext
     */
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        Map<String, Class> handlerMap = Maps.newHashMapWithExpectedSize(3);
        ClassScaner.scan(HANDLER_PACKAGE, HandlerType.class).forEach(clazz -> {
            // 獲取註解中的型別值
            String type = clazz.getAnnotation(HandlerType.class).value();
            // 將註解中的型別值作為key，對應的類作為value，儲存在Map中
            handlerMap.put(type, clazz);
        });
        // 初始化HandlerContext，將其註冊到spring容器中
        HandlerContext context = new HandlerContext(handlerMap);
        beanFactory.registerSingleton(HandlerContext.class.getName(), context);
    }

}
複製程式碼

ClassScaner：掃描工具類原始碼

HandlerProcessor需要實現BeanFactoryPostProcessor，在spring處理bean前，將自定義的bean註冊到容器中。

核心工作已經完成，現在看看HandlerContext如何獲取對應的處理器：

HandlerContext：

public class HandlerContext {

    private Map<String, Class> handlerMap;

    public HandlerContext(Map<String, Class> handlerMap) {
        this.handlerMap = handlerMap;
    }

    public AbstractHandler getInstance(String type) {
        Class clazz = handlerMap.get(type);
        if (clazz == null) {
            throw new IllegalArgumentException("not found handler for type: " + type);
        }
        return (AbstractHandler) BeanTool.getBean(clazz);
    }

}
複製程式碼

BeanTool：獲取bean工具類

#getInstance方法根據型別獲取對應的class，然後根據class型別獲取註冊到spring中的bean。

最後請注意一點，HandlerProcessor和BeanTool必須能被掃描到，或者通過@Bean的方式顯式的註冊，才能在專案啟動時發揮作用。

總結

利用策略模式可以簡化繁雜的if else程式碼，方便維護，而利用自定義註解和自注冊的方式，可以方便應對需求的變更。本文只是提供一個大致的思路，還有很多細節可以靈活變化，例如使用列舉型別、或者靜態常量，作為訂單的型別，相信你能想到更多更好的方法。

全部示例程式碼請檢視：handler_demo

閱讀原文：www.ciphermagic.cn

希望對你有所幫助：）

相關文章