Spring Bean 自动装配总结

发表于 2017-06-29 更新于 2024-12-11

依赖注入

按照传统的做法，每个对象负责管理与自己相互协作的对象（即它所依赖的对象）的引用，这将会导致高度耦合和难以测试的代码：

            +---+
  +---new--->Bar|
  |         +---+
+-+-+
|Foo|
+-+-+
  |         +---+
  +---new--->Baz|
            +---+

通过依赖注入（Dependency Injection）这种设计模式，对象的依赖关系将由系统中负责协调各对象的第三方组件在创建对象的时候进行设定。对象无需自行创建或管理它们的依赖关系，依赖关系将被自动注入到需要它们的对象当中去，即做到“控制反转（IoC）”：

             +---+
  +--inject--+Bar|
  |          +---+
+-v-+
|Foo|
+-^-+
  |          +---+
  +--inject--+Baz|
             +---+

如果一个对象只通过接口（而不是具体实现或初始化过程）来表明依赖关系，那么这种依赖就能够在对象本身毫不知情的情况下，用不同的具体实现进行替换。这就是依赖注入所带来的最大收益——松耦合。

对依赖进行替换的一个最常用方法就是在测试的时候使用 mock 实现。

如何实现？

在面向对象的编程中，有几种实现控制反转的基本技术：

使用工厂模式（factory pattern）
使用服务定位模式（service locator pattern）
使用以下任何给定类型的依赖注入（DI）：
- 构造方法注入（a constructor injection）
- setter 方法注入（a setter injection）
- 接口注入（an interface injection）

自动装配

自动装配作为依赖注入的实现方式之一，是为了简化依赖注入的配置而生的。

常用的注解：

@Autowired
@Resource
@Inject

Spring 通过它的配置，能够了解这些组成部分是如何装配起来的。这样的话，就可以在不改变所依赖的类的情况下，修改依赖关系。

Collection Injection

例子一

// Spring 会将 service 对象作为集合注入到 list
@Autowired
private List<DemoService> demoServices;

// Spring 会将 service 的名字作为 key，service 对象作为 value 注入到 Map
@Autowired
private Map<String, DemoService> demoServiceMap;

例子二

下例通过 Collection Injection 实现自定义策略模式。

首先，创建策略注解。注意，此处还使用了 @Service，表示标注了 @PayMethod 注解的类都由 Spring Bean Factory 来创建对象并管理 Bean：

import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import java.lang.annotation.*;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Service
public @interface PayMethod {
  
    PayMethodEnum code();

    @RequiredArgsConstructor
    @Getter
    enum PayMethodEnum {
       ...
    }

}

然后，创建策略类：

/**
 * 策略接口
 */
public interface XxxHandler {
  ...
}

/**
 * 策略实现
 */
@PayMethod(code = PayMethod.PayMethodEnum.CARD)
public class CardPayHandler implements XxxHandler {
  ...
}

最后，创建工厂类：

import java.util.List;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;

import org.springframework.beans.factory.annotation.Autowired;
import org.apache.commons.lang3.NotImplementedException;

@Service
public class XxxHandlerFactoryBean {

    private Map<PayMethod.PayMethodEnum, XxxHandler> map;

    /**
     * 通过构造方法注入策略实现
     */
    @Autowired
    public XxxHandlerFactory(List<XxxHandler> handlers) {
        this.map = handlers.stream()
                .filter(handler -> getAnnotation(handler) != null)
                .collect(Collectors.toMap(handler -> getAnnotation(handler).code(), Function.identity()));
    }

    private PayMethod getAnnotation(XxxHandler handler) {
        return handler.getClass().getAnnotation(PayMethod.class);
    }

    public XxxHandler getHandler(String code) {
        PayMethod.PayMethodEnum payMethodEnum = PayMethod.PayMethodEnum.valueOfCode(code);
        XxxHandler handler = map.get(payMethodEnum);
        if (handler == null) {
            throw new NotImplementedException("Not Implemented");
        }
        return handler;
    }

}