Spring Boot顶层接口实现类注入项目的方法

1、背景

 在项目中，我们通常会具有同一特性的业务类定义一个顶层接口，让业务类实现这个接口，通过接口规范来管理这些类。我们将这些实现接口的业务类交托给Spring容器接口后，有时候需要根据业务类型来选择动态选择对应的业务类阿里处理业务。这个时候就获取到这些业务类并进行管理，在需要时取出对应的业务类处理业务。如何管理就是本期要介绍的内容。
 以下是我定义的一个简单的顶层接口，它有两个方法，一个是提供类型的getType()方法，一个是处理业务的hanlde()方法。我们的任务就是对其实现类进行管理，当需要时可根据类型获取对应实现类。

public interface IBaseHandler {
    /**
     * 获取处理器类型
     * @return 处理器类型
     */
    int getType();

    /**
     * 处理业务
     * @param t 业务数据
     * @param <T> 业务数据类型
     */
    <T> void handler(T t);
}

2、简单的管理方法

 我们可以通过使用@Autowired注解将所有实现了IBaseHandler接口的类注入到项目当中，并在需要时遍历业务类对象，获取对应的对象来处理业务。代码如下所示：

    @Autowired
    private List<IBaseHandler> handlers;
     /**
     * 处理业务
     * @param type 业务类型
     * @param data 业务数据
     * @param <T> 业务数据类型
     */
    public <T> void handle(int type, T data) {
        handlers.stream().filter(handler -> handler.getType() == type).findAny().orElseThrow(() -> {
            // 获取不到业务类对象时打印日志并抛出异常
            log.error("Failed to get handler, type:{}", type);
            return new NoSuchElementException("No such handler");
        }).handler(data);
    }

3、更好的管理方法

1、简单管理方法的弊端

 上面的简单管理方法用起来方便，但是有两个弊端：
  （1）耦合度高，所有需要使用该接口的地方都需要进行注入再遍历的过程。
  （2）性能较差，每次执行业务之前都需要遍历一次列表。

2、解决

 我们可以使用一个工具类，提供静态方法来获取业务类。这样所有需要获取业务类的地方，就都可以通过该工具类一步获取到所需的业务类。代码如下：

1、工具类代码

@Slf4j
public class HandlerManager {
    /**
     * 按照type映射的处理器map
     */
    private static Map<Integer, IBaseHandler> typeHandlerMap = new HashMap<>();
    /**
     * 按照类型映射的处理器map
     */
    private static Map<Class<IBaseHandler>, IBaseHandler> clazzHandlerMap = new HashMap<>();

    /**
     * 初始化方法，项目启动时调用该方法来初始化map
     * @param applicationContext spring 上下文对象
     */
    public static void init(ApplicationContext applicationContext) {
        List<IBaseHandler> handlers = new ArrayList<>();
        applicationContext.getBeansOfType(IBaseHandler.class).forEach((name, obj) -> handlers.add(obj));
        // 为了方便，两次循环构建map，一次循环也可以解决，不过人为定义的handler数量不多，一次循环性能提升不大
        typeHandlerMap = handlers.stream().collect(Collectors.toMap(IBaseHandler::getType, obj -> obj));
        clazzHandlerMap = handlers.stream().collect(Collectors.toMap(obj -> (Class<IBaseHandler>) obj.getClass(), obj -> obj));
    }

    public IBaseHandler getHandlerByType(int type) {
        return Optional.ofNullable(typeHandlerMap.get(type)).orElseThrow(() -> {
            // 获取不到处理器打印日志并抛出异常
            log.info("Failed to get handler, type:{}", type);
            return new NoSuchElementException("No such  handler error");
        });
    }

    public IBaseHandler getHandlerByClass(Class<IBaseHandler> clazz) {
        return Optional.ofNullable(clazzHandlerMap.get(clazz)).orElseThrow(() -> {
            // 获取不到处理器打印日志并抛出异常
            log.info("Failed to get handler, clazz:{}", clazz);
            return new NoSuchElementException("No such  handler error");
        });
    }


}

2、调用工具类的init方法

 由于工具类提供的是静态方法，因此无法通过注入的方式来获取到所有的IBaseHanlder，所以需要借助其他可注入IBaseHanlder的类来初始化管理对象，以下是方法：

/**
 * 项目初始化类
 * 继承ApplicationContextAware,实现setApplicationContext，可获取ApplicationContext来获取上下文
 */
@Component
public class ApplicationInit implements ApplicationContextAware {

    @Autowired
    private List<IBaseHandler> handlers;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        // 调用处理器工具类初始化方法
        HandlerManager.init(applicationContext);
    }
}