[SpringBoot]接口的多实现:选择性注入SpringBoot接口的实现类

news2024/11/13 10:26:03

最近在项目中遇到两种情况，准备写个博客记录一下。

情况说明：Service层一个接口是否可以存在多个具体实现，此时应该如何调用Service（的具体实现）？

其实之前的项目中也遇到过这种情况，只不过我采用的方式是新建了一个Service接口，然后拆分两个实现类，让两个实现类分别实现两个不同的接口，然后在Controller中分别注入两个Service。最近项目中又遇到了这种情况，于是简单研究了一下，一个Service确实是可以有多个实现的，以下介绍4种区分实现类的方式。

^{以下代码本人均已测试，并对一些情况做了补充（欢迎继续补充）。}

文章目录

实现
- 方式1：直接使用实现类类名来区分
- 方式2：`@Qualifier`注解
- 方式3：设置主实现类
- 方式4：使用`@Resource`注解
总结
致谢

实现

方式1：直接使用实现类类名来区分

我在以下代码中直接创建一个接口AaaService，然后让BbbServiceImpl和CccServiceImpl分别来实现AaaService，且BbbServiceImpl和CccServiceImpl注册为Service。

public interface AaaService {
    String say();
}

@Service
public class BbbServiceImpl implements AaaService {
    @Override
    public String say() {
        System.out.println("我是BBB");
        return "我是BBB";
    }
}

@Service
public class CccServiceImpl implements AaaService {
    @Override
    public String say() {
        System.out.println("我是CCC");
        return "我是CCC";
    }
}

以上代码AAA就有了两个Service实现类，尽管我没有遵循一些明明规则，但是BBB与CCC确实是AAA的实现类，且它们三个都是Service层的组件，接下来我在Controller中注入这两个组件。

@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private AaaService bbbServiceImpl;

    @Autowired
    private AaaService cccServiceImpl;

    @GetMapping("/b")
    public String BBB(){
        return bbbServiceImpl.say();
    }

    @GetMapping("/c")
    public String CCC(){
        return cccServiceImpl.say();
    }

}

这时候我们启动项目，通过浏览器分别访问/test/b与/test/c地址，情况如下：

/test/b：我是BBB（且后端控制台也输出：我是BBB）
/test/c：我是CCC（且后端控制台也输出：我是CCC）

因此，我们确实在Controller层同时注入了一个Service的两个实现类。

方式2：`@Qualifier`注解

通常情况下，如果注入的B与C的变量名没有遵循与实现类同名（小驼峰）的命名方式的话，项目会启动失败，并且报错如下：

Action:

Consider marking one of the beans as @Primary, updating the consumer to accept multiple beans, or using @Qualifier to identify the bean that should be consumed

表现如下：

在这里插入图片描述

这是在提示我们使用@Qualifier注解来区分两个实现类（使用方式一也是可以的）。在一些情况下，我们虽然一个Service有多个实现类，但是我们依旧想用最传统的方式，也就是接口名小驼峰的方式来作为它的实现类来使用，但是很明显，像是下面这段代码在该情况下是不能生效的，因为我们并没有一个叫AaaService的实现类。

@RestController
public class TestController {
  @Autowired
  private AaaService aaaService;
}

上面这段代码运行起来之后就会报我们上面说到的报错，该如何解决呢？？只需要在@Autowired上面加上一个注解就可以，写法如下：

@RestController
public class TestController {
  @Qualifier("bbbServiceImpl")
  @Autowired
  private AaaService aaaService;
}

^{注意，注解中写的内容必须是该Service接口的某个实现类的小驼峰名称。}

这样一来，我们就在该Controller中注入了BbbServiceImpl，只不过它的名称是aaaService，在后续使用中，我们调用的也是BbbServiceImpl种的方法。

方式3：设置主实现类

通过以上两种方式，我们已经可以实现自由的选择我们具体要注入的是哪一个实现类，但是如果业务中有这样的一个场景：我默认下只使用A实现类，BC实现类是我在特殊情况下才去使用的。在这种情况下，我希望能有一种“默认”机制的出现，该如何实现呢？请看以下代码:

public interface AaaService  {
	// ...  
}

@Service
@Primary // 注意这一个注解
public interface BbbServiceImpl implements AaaService {
  // Aaa的实现 ...
}

@Service
public interface CccServiceImpl implements AaaService {
  // Aaa的实现 ...
}

在以上代码中，由于B实现上面有一个@Primary注解，因此该实现类会被当做是A接口的主要实现类，这时候我若是未指明具体使用的是哪一个实现类（就不会报错啦），就会默认用的是B实现类。

这时候又出现了一个小问题，如果这时候我想用C，该怎么办呢？换种方式问一下：命名这个东西是随便写的，如果我们恰巧如方式1中所说的，我变量名命名成了cccServiceImpl，它注入的是B还是C呢？答案揭晓：是B。在此种情况下，用命名来区分实现类的方式已经失效了，要是想使用其他的实现类，只能使用方式二中的@Qualifier注解来区分。

方式4：使用`@Resource`注解

正如方式3中所说，我们设置了@Primary之后，已经无法通过@Autowired注解去控制注入哪个实现类了，但是有没有一种方法还是可以用名称去选择呢？当然可以，那就是@Resource注解。

因为Resource注解默认使用名称进行依赖注入，所以情况3中的代码不变，我们对Controller做如下修改：

@RestController
public class TestController {
  
  @Resource
  AaaService cccServiceImpl;
  
  @GetMapping("/test")
  public String test() {
    return cccServiceImpl.say();
  }
  
}

在以上代码中，虽然我们已经对AaaService设置了默认实现类BbbServiceImpl，但是使用@Resource注解注入了名称为cccServiceImpl的实现，这时候访问/test，得到的字符串依旧是"我是CCC"。

总结

结论：一个Service可以有多个实现，且我们可以手动选择具体使用的哪个实现
使用@Autowired且没有做过多操作（如设置默认实现）的情况下，我们可以使用注入的变量名称（一定是小驼峰）的方式选择变量名，也可以在@Autowired上面添加@Qualifier("实现类的小驼峰")的方式来选择具体实现类。
我们可以在接口实现类上写上@Primary注解来认证该实现类为主实现类，在该情况下，如果不特意指定是哪个实现类，则一律认为是默认实现类。
当指定了默认实现类之后，使用@Autowired+小驼峰名称的注入方式，已经无法指定特定实现类，只能使用``@Qualifier(“实现类的小驼峰”)@+@Autowired或@Resource + 小驼峰命名`的方式进行区分。