Spring項(xiàng)目中用這種模式更方便

前言

不知道大家在項(xiàng)目中有沒(méi)有遇到過(guò)這樣的場(chǎng)景，根據(jù)傳入的類型，調(diào)用接口不同的實(shí)現(xiàn)類或者說(shuō)服務(wù)，比如根據(jù)文件的類型使用 CSV解析器或者JSON解析器，在調(diào)用的客戶端一般都是用if else去做判斷，比如類型等于JSON，我就用JSON解析器，那如果新加一個(gè)類型的解析器，是不是調(diào)用的客戶端還要修改呢？這顯然太耦合了，本文就介紹一種方法，服務(wù)定位模式Service Locator Pattern來(lái)解決，它幫助我們消除緊耦合實(shí)現(xiàn)及其依賴性，并提出將服務(wù)與其具體類解耦。

文件解析器的例子

我們通過(guò)一個(gè)例子來(lái)告訴你如何使用Service Locator Pattern。

假設(shè)我們有一個(gè)從各種來(lái)源獲取數(shù)據(jù)的應(yīng)用程序，我們必須解析不同類型的文件，比如解析CSV文件和JSON文件。

1. 定義一個(gè)類型的枚舉

public enum ContentType {
  JSON,
  CSV
}

2. 定義一個(gè)解析的接口

public interface Parser {
  List parse(Reader r);
}

3. 根據(jù)不同的文件類型有不同的實(shí)現(xiàn)類

// 解析csv
@Component
public class CSVParser implements Parser { 
  @Override
  public List parse(Reader r) { .. }
}

// 解析json
@Component
public class JSONParser implements Parser {
  @Override
  public List parse(Reader r) { .. }
}

4. 最后寫一個(gè)調(diào)用的客戶端，通過(guò)switch case根據(jù)不同的類型調(diào)用不同的實(shí)現(xiàn)

@Service
public class Client {
  private Parser csvParser, jsonParser;

  @Autowired
  public Client(Parser csvParser, Parser jsonParser) {
    this.csvParser = csvParser;
    this.jsonParser = jsonParser;
  }

  public List getAll(ContentType contentType) {
    ..

    switch (contentType) {
      case CSV:
        return csvParser.parse(reader);
      case JSON:
        return jsonParser.parse(reader);
      ..
    }
  }
  ..
}

可能大部分人都是像上面一樣的方式實(shí)現(xiàn)的，也能正常運(yùn)行，那深入思考下，存在什么問(wèn)題嗎？

現(xiàn)在假如產(chǎn)品經(jīng)理提出了一個(gè)新需求要支持XML類型的文件，是不是客戶端也要修改代碼，需要在switch case中添加新的類型，這就導(dǎo)致客戶端和不同的解析器緊密耦合。

那么有什么更好的方法呢？

應(yīng)用Service Locator Pattern

沒(méi)錯(cuò)，那就是用上我們的服務(wù)定位模式Service Locator Pattern。

1. 讓我們定義我們的服務(wù)定位器接口ParserFactory， 它有一個(gè)接受內(nèi)容類型參數(shù)并返回Parser的方法。

public interface ParserFactory {
  Parser getParser(ContentType contentType);
}

2. 我們配置ServiceLocatorFactoryBean使用ParserFactory作為服務(wù)定位器接口，ParserFactory這個(gè)接口不需要寫實(shí)現(xiàn)類。

@Configuration
public class ParserConfig {

  @Bean("parserFactory")
  public FactoryBean serviceLocatorFactoryBean() {
    ServiceLocatorFactoryBean factoryBean = new ServiceLocatorFactoryBean();
    // 設(shè)置服務(wù)定位接口   
    factoryBean.setServiceLocatorInterface(ParserFactory.class);
    return factoryBean;
  }

}

3. 設(shè)置解析器Bean的名稱為類型名稱，方便服務(wù)定位

// 設(shè)置bean的名稱和類型一致
@Component("CSV")
public class CSVParser implements Parser { .. }
@Component("JSON")
public class JSONParser implements Parser { .. }
@Component("XML")
public class XMLParser implements Parser { .. }

4. 修改枚舉, 添加XML

public enum ContentType {
  JSON,
  CSV,
  XML
}

5. 最后用客戶端調(diào)用，直接根據(jù)類型調(diào)用對(duì)應(yīng)的解析器，沒(méi)有了switch case

@Service
public class Client {
  private ParserFactory parserFactory;
  @Autowired
  public Client(ParserFactory parserFactory) {
    this.parserFactory = parserFactory;
  }
  public List getAll(ContentType contentType) {
    ..
    // 關(guān)鍵點(diǎn)，直接根據(jù)類型獲取
    return parserFactory
        .getParser(contentType)  
        .parse(reader);
  }
  ..
}

嘿嘿，我們已經(jīng)成功地實(shí)現(xiàn)了我們的目標(biāo)?，F(xiàn)在再加新的類型，我們只要擴(kuò)展添加新的解析器就行，再也不用修改客戶端了，滿足開閉原則。

如果你覺得Bean的名稱直接使用類型怪怪的，這邊可以建議你按照下面的方式來(lái)。

public enum ContentType {
  JSON(TypeConstants.JSON_PARSER),
  CSV(TypeConstants.CSV_PARSER),
  XML(TypeConstants.XML_PARSER);
  private final String parserName;
  ContentType(String parserName) {
    this.parserName = parserName;
  }

  @Override
  public String toString() {
    return this.parserName;
  }
  public interface TypeConstants {

    String CSV_PARSER = "csvParser";
    String JSON_PARSER = "jsonParser";
    String XML_PARSER = "xmlParser"; 
  }
}

@Component(TypeConstants.CSV_PARSER)
public class CSVParser implements Parser { .. }
@Component(TypeConstants.JSON_PARSER)
public class JSONParser implements Parser { .. }
@Component(TypeConstants.XML_PARSER)
public class XMLParser implements Parser { .. }

剖析Service Locator Pattern

通過(guò)前面的例子，想必大家基本知道服務(wù)定位器模式如何使用了吧，現(xiàn)在我們深入剖析下。

服務(wù)定位器模式消除了客戶端對(duì)具體實(shí)現(xiàn)的依賴。以下引自 Martin Fowler 的文章總結(jié)了核心思想：“服務(wù)定位器背后的基本思想是擁有一個(gè)知道如何獲取應(yīng)用程序可能需要的所有服務(wù)的對(duì)象。因此，此應(yīng)用程序的服務(wù)定位器將有一個(gè)在需要時(shí)返回“服務(wù)”的方法。”

Spring 的ServiceLocatorFactoryBean實(shí)現(xiàn)了 FactoryBean接口，創(chuàng)建了Service Factory服務(wù)工廠Bean。

總結(jié)

我們通過(guò)使用服務(wù)定位器模式實(shí)現(xiàn)了一種擴(kuò)展 Spring 控制反轉(zhuǎn)的絕妙方法。它幫助我們解決了依賴注入未提供最佳解決方案的用例。也就是說(shuō)，依賴注入仍然是首選，并且在大多數(shù)情況下不應(yīng)使用服務(wù)定位器來(lái)替代依賴注入。