springboot接口多實現類選擇性註入解決方案

Posted on by

一、問題的描述

在實際的系統應用開發中我經常會遇到這樣的一類需求，相信大傢在工作中也會經常遇到：

同一個系統在多個省份部署。

一個業務在北京是一種實現方式，是基於北京用戶的需求。

同樣的業務在上海是另外一種實現方式，與北京的實現方式大同小異

遇到這樣的需求，我們通常會定義一個業務實現的接口，比如：

public interface IDemoService {
  public void doSomething();
}

在北京環境下這樣實現，比如：

@Component
public class DemoServiceBeijing implements IDemoService {
  @Override
  public void doSomething() {System.out.println("北京的業務實現");}
}

在上海環境下這樣實現，比如：

@Component
public class DemoServiceShanghai implements IDemoService {
  @Override
  public void doSomething() {System.out.println("上海的業務實現");}
}

然後我們寫一個模擬業務測試用例

@SpringBootTest
class DemoApplicationTests {
    //這裡註入的demoService是DemoServiceShanghai，還是DemoServiceBeijing？
    @Resource
    IDemoService demoService;  
    @Test
    void testDemoService() {
        demoService.doSomething();
    }
}

當我們執行這個測試用例的時候一定會報錯，因為Spring發現瞭兩個IDemoService的實現類。它不知道去實例化哪一個實現類，來作為IDemoService的實際業務處理bean。當然我們期望的狀態是：

在北京部署系統的時候，使用DemoServiceBeijing作為IDemoService的實現類完成依賴註入

在上海部署系統的時候，使用DemoServiceShanghai作為IDemoService的實現類完成依賴註入

二、相對低級解決方案

面對上面的需求，先說幾個相對低級的解決方案，這幾個方案雖然可以實現我們期望的狀態，但是對運維不夠友好。

2.1. 方案一：使用@Primary註解

假如在北京部署系統的時候，在DemoServiceBeijing的類上面加上@Primary,該註解的作用就是強迫從多個實現類裡面選一個實現類，如果Spring不知道選哪一個，我們告訴它一個默認的。

2.2. 方案二：使用@Resource註解

因為@Resource註解默認使用名稱進行依賴註入，所以變量名明確叫做demoServiceBeijing（首字母小寫），使用的就是DemoServiceBeijing實現類。

@Resource
IDemoService demoServiceBeijing;  //這裡的變量名稱指定瞭bean名稱
//IDemoService demoService;  被替換掉

或者

@Resource(name = "demoServiceBeijing")  //使用resource註解明確指定名稱
IDemoService demoService;

2.3.方案三：使用@Qualifier註解

與上文同樣的道理，使用@Qualifier註解，指定bean的名稱進行依賴註入

@Qualifier("demoServiceBeijing")  //使用Qualifier註解明確指定名稱
@Resource
IDemoService demoService;

上面所提到的三個方案雖然都可以解決：在不同的部署環境下使用不同的接口實現類完成依賴註入的問題。但是這樣不好，因為一旦我們要把部署環境從beijing（北京）換成shanghai（上海），就需要把上面的註解的位置或者內容全都修改一遍（所有的實現類代碼都要修改）。

三、相對高級的解決方案

我們提出進一步的期望：就是隻修改一個配置就能完成部署環境切換的操作。比如：

deploy:
  province: beijing

當我們期望把部署環境從北京切換到上海的時候，隻需要將上文配置中的beijing 改成 shanghai ，這該怎麼實現呢？

在北京的實現類上面加上ConditionalOnProperty註解，havingValue的值為beijing

@Component
@ConditionalOnProperty(value="deploy.province",havingValue = "beijing")
public class DemoServiceBeijing implements IDemoService {

在上海的實現類上面加上ConditionalOnProperty註解，havingValue的值為shanghai

@Component
@ConditionalOnProperty(value="deploy.province",havingValue = "shanghai")
public class DemoServiceShanghai implements IDemoService {

ConditionalOnProperty註解在這裡的作用就是：讀取配置文件發現deploy.province,並將該配置的值與havingValue匹配，匹配上哪一個就實例化哪一個類作為該接口的實現類bean註入到Spring容器中（當然註入過程需要配合@Component註解實現）

以上就是springboot接口多實現類選擇性註入解決方案的詳細內容，更多關於springboot接口多實現類選擇性註入的資料請關註WalkonNet其它相關文章！

推薦閱讀：