@Primary和@Qualifer 注解-----當某個接口有多個實現類時，優先注入哪個類

在spring 中使用注解，常使用@Autowired， 默認是根據類型Type來自動注入的。但有些特殊情況，對同一個接口，可能會有幾種不同的實現類。

@Primary和@Qualifer 注解的區別在於：

用@Primary 告訴spring 在猶豫的時候優先選擇哪一個具體的實現。

用@Qualifer告訴spring真正使用哪一個具體的實現。

 

下面是個簡單的使用例子。

有如下一個接口

  public interface Singer { String sing(String lyrics); } 

 

有下面的兩個實現類:

@Component // 加注解，讓spring識別
public class MetalSinger implements Singer{

    @Override
    public String sing(String lyrics) {
        return "I am singing with DIO voice: "+lyrics;
    }
}

//注意，這里沒有注解
public class OperaSinger implements Singer {
    @Override
    public String sing(String lyrics) {
        return "I am singing in Bocelli voice: "+lyrics;
    }
}

 

下面就是注入上面的接口實現類:

@Component
public class SingerService {
    private static final Logger logger = LoggerFactory.getLogger(SingerService.class);

    @Autowired
    private Singer singer;

    public String sing(){
        return singer.sing("song lyrics");
    }
}

 

 

結果是什么呢？
I am singing with DIO voice: song lyrics. 原因很簡單，就是 OperaSinger 這個類上面根本沒有加上注解@Copmonent 或者 @Service, 所以spring 注入的時候，只能找到 MetalSinger 這個實現類. 所以才有這個結果。

但是如果一旦 OperaSinger 這個類加上了@Copmonent 或者 @Service 注解，有趣的事情就會發生，你會發現一個錯誤的結果或異常:
org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type [main.service.Singer] is defined: expected single matching bean but found 2: metalSinger,operaSinger

提示很明確了，spring 根據類型無法選擇到底注入哪一個。這個時候@Primay 可以閃亮登場了。

@Primary
@Component
public class OperaSinger implements Singer{

    @Override
    public String sing(String lyrics) {
        return "I am singing in Bocelli voice: "+lyrics;
    }
}

 

如果代碼改成這樣，再次運行，結果如下：
"I am singing in Bocelli voice: song lyrics"， 用@Primary 告訴spring 在猶豫的時候優先選擇哪一個具體的實現。

二、@Qualifer注解

 

有如下接口：

public interface EmployeeService {
    public EmployeeDto getEmployeeById(Long id);
}

 

同時有下述兩個實現類 EmployeeServiceImpl和EmployeeServiceImpl1：

@Service("service")
public class EmployeeServiceImpl implements EmployeeService {
    public EmployeeDto getEmployeeById(Long id) {
        return new EmployeeDto();
    }
}

@Service("service1")
public class EmployeeServiceImpl1 implements EmployeeService {
    public EmployeeDto getEmployeeById(Long id) {
        return new EmployeeDto();
    }
}

 

調用代碼如下：

@Controller
@RequestMapping("/emplayee.do")
public class EmployeeInfoControl {
    
    @Autowired
    EmployeeService employeeService;
     
    @RequestMapping(params = "method=showEmplayeeInfo")
    public void showEmplayeeInfo(HttpServletRequest request, HttpServletResponse response, EmployeeDto dto) {
        #略
    }
}

 

  在啟動tomcat時報如下錯誤：

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'employeeInfoControl': Injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: com.test.service.EmployeeService com.test.controller.EmployeeInfoControl.employeeService; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No unique bean of type [com.test.service.EmployeeService] is defined: expected single matching bean but found 2: [service1, service2]

  其實報錯信息已經說得很明確了,在autoware時，由於有兩個類實現了EmployeeService接口，所以Spring不知道應該綁定哪個實現類，所以拋出了如上錯誤。

 

這個時候就要用到@Qualifier注解了，qualifier的意思是合格者，通過這個標示，表明了哪個實現類才是我們所需要的，我們修改調用代碼，添加@Qualifier注解，需要注意的是@Qualifier的參數名稱必須為我們之前定義@Service注解的名稱之一！

@Controller
@RequestMapping("/emplayee.do")
public class EmployeeInfoControl {
    
    @Autowired
    @Qualifier("service")
    EmployeeService employeeService;
    
    @RequestMapping(params = "method=showEmplayeeInfo")
    public void showEmplayeeInfo(HttpServletRequest request, HttpServletResponse response, EmployeeDto dto) {
        #略
    }
}

 

 問題解決！