使用Spring特性實現介面多實現類的動態呼叫方式

2022-02-25 13:00:03

正好用到。mark一下背景

org.springframework.beans及org.springframework.context這兩個包是Spring IoC容器的基礎，其中重要的類有BeanFactory，BeanFactory是IoC容器的核心介面，其職責包括：範例化、定位、設定應用程式中的物件及建立這些物件間的依賴關係。

ApplicationContext作為BeanFactory的子類，在Bean管理的功能上得到了很大的增強，也更易於與Spring AOP整合使用。

今天我們要討論的並不是BeanFactory或者ApplicationContext的實現原理，而是對ApplicationContext的一種實際應用方式。

問題的提出

在實際工作中，我們經常會遇到一個介面及多個實現類的情況，並且在不同的條件下會使用不同的實現類。

從使用方式上看，有些類似SPI的用法，但是由於SPI的使用並不是太方便，那麼怎麼辦呢？我們可以藉助ApplicationContext的getBeansOfType來實現我們需要的結果。

首先我們看一下這個方法的簽名

<T> Map<String, T> getBeansOfType(Class<T> type) throws BeansException;

從上面的程式碼上我們可以看出來這個方法能返回一個介面的全部實現類（前提是所有實現類都必須由Spring IoC容器管理）。

接下來看看我們遇到的問題是什麼？

"假設從A點到B點有多種交通方式，每種交通方式的費用不同，可以根據乘客的需要進行選擇"（好吧，我承認這是個非常蹩腳的需求，但是可以聯想一下類似的需求，比如支付方式、快遞公司，在頁面提供幾個選項，業務程式碼根據選項的不同選擇不同的實現類範例進行呼叫）。

實現

回到我們的例子，按照這個交通方式的需求，我們的設計如下：有一個交通方式的介面，介面有兩個方式，一個查詢費用、一個查詢該交通方式的型別，同時，我們可以用一個列舉型別類標識交通型別。

我們還需要一個工廠類來根據交通型別標識查詢該交通型別的Bean範例，從而使用該範例，獲得交通型別的詳細資訊及該交通型別的操作。

程式碼如下

介面：

/**
 * 交通方式
 */
public interface TrafficMode { 
    /**
     * 查詢交通方式編碼
     * @return 編碼
     */
    TrafficCode getCode();
 
    /**
     * 查詢交通方式的費用，單位：分
     * @return 費用
     */
    Integer getFee(); 
}

列舉：

/**
 * 交通型別列舉
 */
public enum TrafficCode { 
    TRAIN,
    BUS 
}

介面有兩個實現類：

/**
 * 汽車方式
 */
@Component
public class BusMode implements TrafficMode { 
    @Override
    public TrafficCode getCode() {
        return TrafficCode.BUS;
    }
 
    @Override
    public Integer getFee() {
        return 10000;
    } 
}

/**
 * 火車方式
 */
@Component
public class TrainMode implements TrafficMode { 
    @Override
    public TrafficCode getCode() {
        return TrafficCode.TRAIN;
    }
 
    @Override
    public Integer getFee() {
        return 9000;
    } 
}

工廠類：

/**
 * 交通方式工廠類
 */
@Component
public class TrafficModeFactory implements ApplicationContextAware { 
    private static Map<TrafficCode, TrafficMode> trafficBeanMap;
 
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        Map<String, TrafficMode> map = applicationContext.getBeansOfType(TrafficMode.class);
        trafficBeanMap = new HashMap<>();
        map.forEach((key, value) -> trafficBeanMap.put(value.getCode(), value));
    }
 
    public static <T extends TrafficMode> T getTrafficMode(TrafficCode code) {
        return (T)trafficBeanMap.get(code);
    } 
}

驗證

有了上面的程式碼之後，我們一起通過單元測試來看一下效果，單元測試程式碼片段如下：

    @Test
    public void testGetTrafficMode() {
        TrafficMode mode = TrafficModeFactory.getTrafficMode(TrafficCode.BUS);
        Assert.assertEquals(mode.getFee().intValue(), 10000); 
        mode = TrafficModeFactory.getTrafficMode(TrafficCode.TRAIN);
        Assert.assertEquals(mode.getFee().intValue(), 9000);
    }

執行之後的結果呢？必然是通過。

關於SPI

文章到這裡，有同學可能會問：這和SPI有什麼區別呢？SPI同樣也能實現同樣的功能啊。首先說明一下，SPI是JDK自帶的功能，雖然歷史是比較久遠的了，但是不代表它不好，而且有些場景非SPI不可（比如JDBC）。

我們明確一下SPI是什麼以及它的設計是用來做什麼的。SPI的全名為Service Provider Interface（服務提供介面），因為這個是針對廠商或者外掛的。比較經典的用法就是JDBC，java提供了標準的JDBC介面，每個資料庫廠商提供自己的資料庫驅動實現。

下面是JDBC驅動的介面

public interface Driver {
    Connection connect(String var1, Properties var2) throws SQLException; 
    boolean acceptsURL(String var1) throws SQLException; 
    DriverPropertyInfo[] getPropertyInfo(String var1, Properties var2) throws SQLException; 
    int getMajorVersion(); 
    int getMinorVersion(); 
    boolean jdbcCompliant(); 
    Logger getParentLogger() throws SQLFeatureNotSupportedException;
}