SpringBoot使用策略者模式解决if-else

SpringBoot使用策略者模式解决if-else

转载自: http://www.ciphermagic.cn/spring-boot-without-if-else.html

前言

利用策略模式简化过多的if-else代码，通过扫描实现处理器的自注册，在Spring Boot框架中的实现策略者模式。

需求

这里虚拟一个业务需求。假设有一个订单系统，里面的一个功能是根据订单的不同类型作出不同的处理。

步骤实现

1. 创建SpringBoot项目 springboot-strategistmodel

2. 修改pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.itmayedu</groupId>
    <artifactId>springboot-strategistmodel</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
    </parent>

    <dependencies>
        <!-- SpringBoot整合Web组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--常用工具类 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>

    </dependencies>
</project>

3. 添加application.yml

###服务启动端口号
server:
  port: 8012
spring:
  application:
    name: springboot-strategistmodel

4. 创建SpringBoot启动类

package com.itmayiedu;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AppStrategistModel {
    public static void main(String[] args) {
        SpringApplication.run(AppStrategistModel.class, args);
    }
}

5. 订单实体:

package com.itmayiedu.model;

import java.math.BigDecimal;

public class OrderDTO {
    private String code;
    private BigDecimal price;

    /**
     * 订单类型
     * 1 普通订单
     * 2 团购订单
     * 3 促销订单
     */
    private String type;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public BigDecimal getPrice() {
        return price;
    }

    public void setPrice(BigDecimal price) {
        this.price = price;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }
}

6. service接口：

package com.itmayiedu.service;

import com.itmayiedu.model.OrderDTO;

public interface IOrderService {
    /**
     * 根据订单不同类型做出不同的处理
     * @param dto 订单实体
     * @return 为了方便 返回字符串演示
     */
    String handle(OrderDTO dto);
}

7. 创建实现类 ServiceImpl

1. 传统模式实现: 根据订单类型写一堆的if else

   package com.itmayiedu.service.impl;
   
   import com.itmayiedu.model.OrderDTO;
   import com.itmayiedu.service.IOrderService;
   import org.springframework.stereotype.Service;
   
   @Service
   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;
       }
   }
   
   

2. 使用策略中模式实现

   package com.itmayiedu.service.impl;
   
   import com.itmayiedu.handler.AbstractHandler;
   import com.itmayiedu.handler.HandlerContext;
   import com.itmayiedu.model.OrderDTO;
   import com.itmayiedu.service.IOrderService;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.stereotype.Service;
   
   @Service
   public class OrderServiceV2Impl implements IOrderService {
   
       // HandlerContext 这是一个处理器上下文，用来保存不同的业务处理器
       @Autowired
       private HandlerContext handlerContext;
   
       // 利用策略模式
   
       /**
        * 主要的业务逻辑是在处理器中实现的，
        * 因此有多少个订单类型，就对应有多少个处理器。
        * 以后需求变化，增加了订单类型，只需要添加相应的处理器就可以，上述OrderServiceV2Impl完全不需改动。
        * @param dto 订单实体
        * @return
        */
       @Override
       public String handle(OrderDTO dto) {
   
           // 从中获取一个抽象的处理器AbstractHandler，调用其方法实现业务逻辑
           // 原型就是具体是哪个类  比如 普通订单类NormalHandler  团购订单类GroupHandler  促销订单类PromotionHandler
           AbstractHandler handler = handlerContext.getInstance(dto.getType());
           return handler.handler(dto);
       }
   
   }
   
   

   可以看到上面的方法中注入了HandlerContext，这是一个处理器上下文，用来保存不同的业务处理器，具体在下文会讲解。我们从中获取一个抽象的处理器AbstractHandler，调用其方法实现业务逻辑。

   现在可以了解到，我们主要的业务逻辑是在处理器中实现的，因此有多少个订单类型，就对应有多少个处理器。以后需求变化，增加了订单类型，只需要添加相应的处理器就可以，上述OrderServiceV2Impl完全不需改动。

8. 创建业务处理器 普通订单类NormalHandler、团购订单类GroupHandler、促销订单类PromotionHandler

package com.itmayiedu.handler.biz;

import com.itmayiedu.handler.AbstractHandler;
import com.itmayiedu.handler.HandlerType;
import com.itmayiedu.model.OrderDTO;
import org.springframework.stereotype.Component;

/**
 * 普通订单处理器
 */
@Component
@HandlerType("1")
public class NormalHandler extends AbstractHandler {
    @Override
    public String handler(OrderDTO dto) {
        return "处理普通订单";
    }
}

package com.itmayiedu.handler.biz;

import com.itmayiedu.handler.AbstractHandler;
import com.itmayiedu.handler.HandlerType;
import com.itmayiedu.model.OrderDTO;
import org.springframework.stereotype.Component;

/**
 * 团购订单处理器
 */
@Component
@HandlerType("2")
public class GroupHandler extends AbstractHandler {
    @Override
    public String handler(OrderDTO dto) {
        return "处理团购订单";
    }

}

package com.itmayiedu.handler.biz;

import com.itmayiedu.handler.AbstractHandler;
import com.itmayiedu.handler.HandlerType;
import com.itmayiedu.model.OrderDTO;
import org.springframework.stereotype.Component;

/**
 * 促销订单处理器
 */
@Component
@HandlerType("3")
public class PromotionHandler extends AbstractHandler {
    @Override
    public String handler(OrderDTO dto) {
        return "处理促销订单";
    }
}

首先每个处理器都必须添加到spring容器中，因此需要加上@Component注解，其次需要加上一个自定义注解@HandlerType，用于标识该处理器对应哪个订单类型，最后就是继承AbstractHandler，实现自己的业务逻辑。

9. 添加自定义注解 @HandlerType

package com.itmayiedu.handler;

import java.lang.annotation.*;

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

10. 抽象处理器 AbstractHandler

package com.itmayiedu.handler;
    
    import com.itmayiedu.model.OrderDTO;
    
    /**
     * 抽象处理器 AbstractHandler
     */
    public abstract class AbstractHandler {
    
        abstract public String handler(OrderDTO dto);
    }

自定义注解和抽象处理器都很简单，那么如何将处理器注册到`spring`容器中呢？
具体思路是：

- 扫描指定包中标有`@HandlerType`的类；
- 将注解中的类型值作为`key`，对应的类作为`value`，保存在`Map`中；
- 以上面的`map`作为构造函数参数，初始化`HandlerContext`，将其注册到`spring`容器中；

我们将核心的功能封装在`HandlerProcessor`类中，完成上面的功能。

11. 创建HandlerProcessor

    package com.itmayiedu.handler;
    
    import com.itmayiedu.util.ClassScaner;
    import org.springframework.beans.BeansException;
    import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
    import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
    import org.springframework.stereotype.Component;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * 将处理器注册到spring容器中
     * 1、扫描指定包中标有@HandlerType的类；
     * 2、将注解中的类型值作为key，对应的类作为value，保存在Map中；
     * 3、以上面的map作为构造函数参数，初始化HandlerContext，将其注册到spring容器中；
     */
    @Component
    @SuppressWarnings("unchecked")
    public class HandlerProcessor implements BeanFactoryPostProcessor {
    
        private static final String HANDLER_PACKAGE = "com.itmayiedu.handler.biz";


​    
​        /**
​         * 扫描@HandlerType，初始化HandlerContext，将其注册到spring容器
​         *
​         * @param beanFactory bean工厂
​         * @see HandlerType
​         * @see HandlerContext
​         */
​        @Override
​        public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
​            Map<String, Class> handlerMap = new HashMap<>();
​            ClassScaner.scan(HANDLER_PACKAGE, HandlerType.class).forEach(clazz -> {
​                // 获取注解中得类型值
​                String type = clazz.getAnnotation(HandlerType.class).value();
​                // 将注解中的类型值作为key 对应的类作为value 保存在Map中
​                handlerMap.put(type, clazz);
​    
                /**
                 * handlerMap
                 * key  value
                 * 1    NormalHandler.class
                 * 2    GroupHandler.class
                 * 3    PromotionHandler.class
                 */
    
            });
            // 初始化HandlerContext 将其注册在spring容器中
            HandlerContext context  = new HandlerContext(handlerMap);
            // 放到bean中的id 就是 handlerContext
            beanFactory.registerSingleton(HandlerContext.class.getName(), context);
        }
    }

`HandlerProcessor`需要实现`BeanFactoryPostProcessor`，在`spring`处理bean前，将自定义的bean注册到容器中。

核心工作已经完成，现在看看`HandlerContext`如何获取对应的处理器：

12. 创建 HandlerContext

 package com.itmayiedu.handler;
    
    import com.itmayiedu.util.BeanTool;
    
    import java.util.Map;
    
    @SuppressWarnings("unchecked")
    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);
        }
    
    }
    

​

#getInstance方法根据类型获取对应的class，然后根据class类型获取注册到spring中的bean。

最后请注意一点，HandlerProcessor和BeanTool必须能被扫描到，或者通过@Bean的方式显式的注册，才能在项目启动时发挥作用。

13. 用到的两个工具类

BeanTool工具类

package com.itmayiedu.util;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

/**
 * Bean工具类<br>
 * 在非spring管理的类中获取spring注册的bean
 *
 * @author cipher
 */
@Component
public class BeanTool implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext context) throws BeansException {
        if (applicationContext == null) {
            applicationContext = context;
        }
    }

    public static Object getBean(String name) {
        return applicationContext.getBean(name);
    }

    public static <T> T getBean(Class<T> clazz) {
        return applicationContext.getBean(clazz);
    }

}

ClassScaner工具类

package com.itmayiedu.util;

import org.apache.commons.lang3.ArrayUtils;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternUtils;
import org.springframework.core.type.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.core.type.filter.AnnotationTypeFilter;
import org.springframework.core.type.filter.TypeFilter;
import org.springframework.util.StringUtils;
import org.springframework.util.SystemPropertyUtils;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;

/**
 * @Author: CipherCui
 * @Description:
 * @Date: Created in 9:15 2018/10/18
 */
public class ClassScaner implements ResourceLoaderAware {

    private final List<TypeFilter> includeFilters = new LinkedList<TypeFilter>();
    private final List<TypeFilter> excludeFilters = new LinkedList<TypeFilter>();

    private ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
    private MetadataReaderFactory metadataReaderFactory = new CachingMetadataReaderFactory(this.resourcePatternResolver);

    @SafeVarargs
    public static Set<Class<?>> scan(String[] basePackages, Class<? extends Annotation>... annotations) {
        ClassScaner cs = new ClassScaner();

        if (ArrayUtils.isNotEmpty(annotations)) {
            for (Class anno : annotations) {
                cs.addIncludeFilter(new AnnotationTypeFilter(anno));
            }
        }

        Set<Class<?>> classes = new HashSet<>();
        for (String s : basePackages) {
            classes.addAll(cs.doScan(s));
        }

        return classes;
    }

    @SafeVarargs
    public static Set<Class<?>> scan(String basePackages, Class<? extends Annotation>... annotations) {
        return ClassScaner.scan(StringUtils.tokenizeToStringArray(basePackages, ",; \t\n"), annotations);
    }

    public final ResourceLoader getResourceLoader() {
        return this.resourcePatternResolver;
    }

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourcePatternResolver = ResourcePatternUtils
                .getResourcePatternResolver(resourceLoader);
        this.metadataReaderFactory = new CachingMetadataReaderFactory(
                resourceLoader);
    }

    public void addIncludeFilter(TypeFilter includeFilter) {
        this.includeFilters.add(includeFilter);
    }

    public void addExcludeFilter(TypeFilter excludeFilter) {
        this.excludeFilters.add(0, excludeFilter);
    }

    public void resetFilters(boolean useDefaultFilters) {
        this.includeFilters.clear();
        this.excludeFilters.clear();
    }

    public Set<Class<?>> doScan(String basePackage) {
        Set<Class<?>> classes = new HashSet<>();
        try {
            String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX
                    + org.springframework.util.ClassUtils
                    .convertClassNameToResourcePath(SystemPropertyUtils
                            .resolvePlaceholders(basePackage))
                    + "/**/*.class";
            Resource[] resources = this.resourcePatternResolver
                    .getResources(packageSearchPath);

            for (int i = 0; i < resources.length; i++) {
                Resource resource = resources[i];
                if (resource.isReadable()) {
                    MetadataReader metadataReader = this.metadataReaderFactory.getMetadataReader(resource);
                    if ((includeFilters.size() == 0 && excludeFilters.size() == 0) || matches(metadataReader)) {
                        try {
                            classes.add(Class.forName(metadataReader
                                    .getClassMetadata().getClassName()));
                        } catch (ClassNotFoundException e) {
                            e.printStackTrace();
                        }
                    }
                }
            }
        } catch (IOException ex) {
            throw new BeanDefinitionStoreException(
                    "I/O failure during classpath scanning", ex);
        }
        return classes;
    }

    protected boolean matches(MetadataReader metadataReader) throws IOException {
        for (TypeFilter tf : this.excludeFilters) {
            if (tf.match(metadataReader, this.metadataReaderFactory)) {
                return false;
            }
        }
        for (TypeFilter tf : this.includeFilters) {
            if (tf.match(metadataReader, this.metadataReaderFactory)) {
                return true;
            }
        }
        return false;
    }

}

项目目录结构:

[外链图片转存失败(img-hzKCcjHY-1569468602150)(images/1569468308811.png)]

总结

利用策略模式可以简化繁杂的if-else代码，方便维护，而利用自定义注解和自注册的方式，可以方便应对需求的变更。本文只是提供一个大致的思路，还有很多细节可以灵活变化，例如使用枚举类型、或者静态常量，作为订单的类型，相信你能想到更多更好的方法。