【spring技术】接口多实现类的注入问题

一、前言

昨天在开发过程中，遇到了一个依赖注入的问题，这个注入的接口存在多个实现类，在注入接口指定实现类时一直报错，当前也是懵逼了好一会，事后回顾一下，遇事一定要冷静；

二、问题

在spring中注入的接口存在多个实现类时，注入的方式是使用以下两种：

1、使用注解@Qualifier查询bean

@Qualifier("dogService")
@Autowired
private AnimalService animalService;

2、使用注解@Resource指定bean

@Resource(name = "dogService")
private AnimalService animalService;

但是，在使用以上两种方式时，一直报错，如下：

***************************
APPLICATION FAILED TO START
***************************

Description:

Parameter 0 of constructor in com.sk.action.AnimalAction required a single bean, but 2 were found:
	- catService: defined in file [G:\work3\springTest\target\classes\com\sk\service\impl\CatServiceImpl.class]
	- dogService: defined in file [G:\work3\springTest\target\classes\com\sk\service\impl\DogServiceImpl.class]


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("dogService")和@Resource(name = "dogService")均没有生效，但是注入具体的实现类时，又能注入成功；

@Resource
private DogServiceImpl dogService;

三、@ConditionalOnProperty注解

通过现象，解决这个问题，可以通过@ConditionalOnProperty注解控制初始化的bean，这样就能做到只初始化一个接口的实现类，临时解决方案

package com.sk.service.impl;

import com.sk.service.AnimalService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.stereotype.Service;

//@Service("dogService")
@Service
@ConditionalOnProperty(prefix = "formatter",name="enabled",havingValue = "true")
public class DogServiceImpl implements AnimalService {
    @Override
    public void play() {
        System.out.println("狗拿耗子！！！");
    }

    @Override
    public void eat() {
        System.out.println("狗爱吃骨头！！！");
    }
}

@ConditionalOnProperty属性介绍：
prefix()：配置属性名称前缀
value()：name()的别名，参考name()说明
name()：如果prefix()不为空，则完整配置属性名称为prefix(）+ name(),否则为name()的内容
havingValue()：表示期望的配置属性值，并且禁止使用false
matchIFMissing()：用于判断当属性值不存在时是否匹配

四、@AllArgsConstructor注解

冷静之后再次分析，发现注入类AnimalAction上面有个注解@AllArgsConstructor，猜想是不是有可能是这个类引起的，再注释掉这个类之后，果然~成功了！

@RestController
//@AllArgsConstructor
public class AnimalAction {
    
    //@Qualifier("dogService")
    //@Autowired

    @Resource
    private AnimalService animalService;

    @GetMapping("/test")
    public void getTest(){
        animalService.play();
    }

}

构造函数注释说明：
@NoArgsConstructor后会 生成无参的构造方法
@RequiredArgsConstructor会将类的每一个final字段或者non-null字段生成一个构造方法
@AllArgsConstructor 生成一个包含过所有字段的构造方法。

注：它们属于lombok的属性注解

五、构造函数注入

当前spring推荐使用@AllArgsConstructor/@RequiredArgsConstructor和final 代替 @Autowired，这样做个人总结好处至少有两点：
1、每个注入的属性不用添加注解@Autowired和@Resource，减少工作量，代码更整洁；
2、final修饰的成员变量是不能够被修改的，避免反射修改；

@RestController
@AllArgsConstructor
public class AnimalAction {
    
    private final DogServiceImpl dogService;

    @GetMapping("/test")
    public void getTest(){
        dogService.play();
    }

}

问题：为什么加上构造器，不用@Autowired也能把对象注入Spring容器？
在Java语言中，每个类至少有一个构造方法。如果程序中没有显式定义任何构造方法，那么将自动提供一个隐含的默认无参构造方法。
只要程序中已经显式定义了构造方法，那么将不再提供隐含的默认构造方法。
所以这里定义了一个带TestService参数的构造器，在初始化这个类的时候需要传入一个TestService对象，这个Spring容器就把它创建了，所有内部不用加@Autowired。

六、@AllArgsConstructor多实现接口注入方法

在接口多实现的场景下如何通过@AllArgsConstructor/@RequiredArgsConstructor实现指定实现类的注入呐？

可以通过设置变量名为接口service的实现类设置的名称，示例如下：

接口注入类：

@RestController
@AllArgsConstructor
public class AnimalAction {

    private final AnimalService dogService;

    @GetMapping("/test")
    public void getTest(){
        dogService.play();
    }
}

接口实现类one：

@Service("catService")
public class CatServiceImpl implements AnimalService {
    @Override
    public void play() {
        System.out.println("猫捉老鼠！！！");
    }

    @Override
    public void eat() {
        System.out.println("猫爱吃鱼！！！");
    }
}

接口实现类two：

@Service("dogService")
//@ConditionalOnProperty(prefix = "formatter",name="enabled",havingValue = "true")
public class DogServiceImpl implements AnimalService {
    @Override
    public void play() {
        System.out.println("狗拿耗子！！！");
    }

    @Override
    public void eat() {
        System.out.println("狗爱吃骨头！！！");
    }
}