SpringBoot中基于设计模式和配置动态选择Repository策略

本文旨在解决springboot应用中动态选择不同数据存储库（repository）的挑战，避免冗长的条件判断或硬编码映射。通过引入服务定位器（service locator）设计模式，并结合spring框架的`servicelocatorfactorybean`，我们提供了一种灵活、可扩展且易于配置的解决方案，实现基于运行时条件动态获取并使用特定的`@repository`实例，从而提升代码的可维护性和扩展性。

在构建复杂的Spring Boot应用程序时，我们经常会遇到需要根据特定业务逻辑或请求参数动态选择不同的数据持久化策略。例如，一个服务可能需要将数据存储到Elasticsearch、MongoDB或Redis，具体取决于请求中的whereToSave字段。传统的做法往往是使用一系列if-else语句或硬编码的Map来映射不同的存储库实例。然而，随着存储库数量的增加，这种方法会迅速变得难以维护和扩展。

传统方法的局限性

让我们回顾一下常见的两种传统实现方式及其弊端：

基于if-else的条件判断：

@RestControllerpublic class ControllerVersionOne {    @Autowired private ElasticRepository elasticRepository;    @Autowired private MongoDbRepository mongoRepository;    @Autowired private RedisRepository redisRepository;    @PostMapping(path = "/save")    public String save(@RequestBody MyRequest myRequest) {        String whereToSave = myRequest.getWhereToSave();        MyPojo myPojo = new MyPojo(UUID.randomUUID().toString(), myRequest.getValue());        if (whereToSave.equals("elastic")) {            return elasticRepository.save(myPojo).toString();        } else if (whereToSave.equals("mongo")) {            return mongoRepository.save(myPojo).toString();        } else if (whereToSave.equals("redis")) {            return redisRepository.save(myPojo).toString();        } else {            return "unknown destination";        }    }}

问题： 代码冗长，当需要添加新的存储库时，必须修改控制器中的if-else逻辑，违反开闭原则。

基于硬编码Map的策略模式（有限）：

@RestControllerpublic class ControllerVersionTwo {    private Map<String, Function> designPattern;    @Autowired    public ControllerVersionTwo(ElasticRepository elasticRepository, MongoDbRepository mongoRepository, RedisRepository redisRepository) {        designPattern = new HashMap();        designPattern.put("elastic", myPojo -> elasticRepository.save(myPojo));        designPattern.put("mongo", myPojo -> mongoRepository.save(myPojo));        designPattern.put("redis", myPojo -> redisRepository.save(myPojo));    }    @PostMapping(path = "/save")    public String save(@RequestBody MyRequest myRequest) {        String whereToSave = myRequest.getWhereToSave();        MyPojo myPojo = new MyPojo(UUID.randomUUID().toString(), myRequest.getValue());        return designPattern.get(whereToSave).apply(myPojo).toString();    }}

问题： 虽然消除了if-else链，但映射关系仍然在代码中硬编码。每次添加新存储库时，仍需修改构造函数中的Map初始化逻辑。此外，此处的Map存储的是Function，而非直接的@Repository实例，限制了直接操作Repository的能力。

为了解决上述问题，我们可以引入服务定位器（Service Locator）设计模式，并结合Spring框架提供的ServiceLocatorFactoryBean来实现动态、可配置的Repository选择。

采用服务定位器模式动态选择Repository

服务定位器模式允许我们通过一个统一的接口来获取服务实例，而无需知道具体的实现细节。在Spring Boot中，ServiceLocatorFactoryBean可以帮助我们动态地创建这样一个服务定位器。

1. 定义一个通用的Repository基础接口

首先，我们需要定义一个所有具体Repository都将实现的通用接口。这确保了我们可以通过一个统一的类型来操作不同的Repository实例。

// BaseRepository.javapublic interface BaseRepository {    MyPojo save(MyPojo pojo); // 假设所有Repository都有一个save方法    // 可以在这里添加其他通用方法}

2. 实现具体的Repository

接下来，让你的所有具体Repository实现BaseRepository接口，并使用@Repository注解为它们指定一个唯一的名称。这个名称将作为服务定位器查找的键。

Elser AI Comics

一个免费且强大的AI漫画生成工具，助力你三步创作自己的一出好戏

522 查看详情

// ARepository.javaimport org.springframework.data.jpa.repository.JpaRepository;import org.springframework.stereotype.Repository;@Repository("repoA") // 指定唯一的bean名称public interface ARepository extends JpaRepository, BaseRepository {    // JpaRepository提供了save方法，所以这里无需额外实现    // 如果没有继承CrudRepository等，需要自行实现save方法    @Override    default MyPojo save(MyPojo pojo) {        // 示例：实际应调用JpaRepository的save方法        return JpaRepository.super.save(pojo);    }}// BRepository.java@Repository("repoB") // 指定唯一的bean名称public interface BRepository extends JpaRepository, BaseRepository {    @Override    default MyPojo save(MyPojo pojo) {        return JpaRepository.super.save(pojo);    }}// 假设ElasticRepository不继承CrudRepository，需要自己实现save// ElasticRepository.java@Repository("elasticRepository")public class ElasticRepository implements BaseRepository {    // 注入Elasticsearch客户端等    // ...    @Override    public MyPojo save(MyPojo pojo) {        // 实现Elasticsearch的保存逻辑        System.out.println("Saving to Elastic: " + pojo.getValue());        return pojo;    }}// MongoDbRepository.java@Repository("mongoDbRepository")public interface MongoDbRepository extends MongoRepository, BaseRepository {    @Override    default MyPojo save(MyPojo pojo) {        return MongoRepository.super.save(pojo);    }}// RedisRepository.java@Repository("redisRepository")public class RedisRepository implements BaseRepository {    // 注入RedisTemplate等    // ...    @Override    public MyPojo save(MyPojo pojo) {        // 实现Redis的保存逻辑        System.out.println("Saving to Redis: " + pojo.getValue());        return pojo;    }}

注意： 如果你的Repository接口继承了CrudRepository、JpaRepository或MongoRepository等Spring Data接口，它们通常已经提供了save方法。为了满足BaseRepository的接口要求，你可以使用Java 8的default方法来直接调用父接口的save方法，或者对于非Spring Data接口的Repository（如ElasticRepository、RedisRepository），则需要手动实现save方法。

3. 定义服务定位器工厂接口

创建一个简单的工厂接口，其中包含一个方法，该方法根据传入的字符串参数返回相应的BaseRepository实例。

// BaseRepositoryFactory.javapublic interface BaseRepositoryFactory {    BaseRepository getBaseRepository(String whereToSave);}

4. 配置ServiceLocatorFactoryBean

在你的Spring配置类中，创建一个ServiceLocatorFactoryBean的Bean。这个Bean将负责在运行时动态地实现BaseRepositoryFactory接口。

// AppConfig.javaimport org.springframework.beans.factory.config.ServiceLocatorFactoryBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class AppConfig {    @Bean    public ServiceLocatorFactoryBean baseRepositoryBean() {        ServiceLocatorFactoryBean serviceLocatorFactoryBean = new ServiceLocatorFactoryBean();        // 设置工厂接口，ServiceLocatorFactoryBean会自动查找Spring上下文中匹配的Bean        serviceLocatorFactoryBean.setServiceLocatorInterface(BaseRepositoryFactory.class);        return serviceLocatorFactoryBean;    }}

ServiceLocatorFactoryBean会查找所有实现了BaseRepository接口的Spring Bean，并根据它们的Bean名称（或@Repository注解中指定的名称）与getBaseRepository方法的参数进行匹配。

5. 在控制器或服务中使用工厂

现在，你可以在任何需要动态选择Repository的地方注入BaseRepositoryFactory，然后根据运行时条件调用其getBaseRepository方法来获取并使用正确的Repository实例。

// ControllerVersionThree.javaimport org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestBody;import org.springframework.web.bind.annotation.RestController;import java.util.UUID;@RestControllerpublic class ControllerVersionThree {    @Autowired    private BaseRepositoryFactory baseRepositoryFactory; // 注入服务定位器工厂    @PostMapping(path = "/save")    public String save(@RequestBody MyRequest myRequest) {        String whereToSave = myRequest.getWhereToSave();        MyPojo myPojo = new MyPojo(UUID.randomUUID().toString(), myRequest.getValue());        try {            // 根据whereToSave参数动态获取Repository实例            BaseRepository repository = baseRepositoryFactory.getBaseRepository(whereToSave);            if (repository != null) {                return repository.save(myPojo).toString();            } else {                return "Unknown destination or repository not found for: " + whereToSave;            }        } catch (Exception e) {            // 处理Repository未找到或保存失败的情况            return "Error saving to " + whereToSave + ": " + e.getMessage();        }    }}

MyRequest 和 MyPojo 示例：

// MyRequest.javapublic class MyRequest {    private String whereToSave;    private String value;    // Getters and Setters    public String getWhereToSave() { return whereToSave; }    public void setWhereToSave(String whereToSave) { this.whereToSave = whereToSave; }    public String getValue() { return value; }    public void setValue(String value) { this.value = value; }}// MyPojo.javapublic class MyPojo {    private String id;    private String value;    // Constructor    public MyPojo(String id, String value) {        this.id = id;        this.value = value;    }    // Getters and Setters    public String getId() { return id; }    public void setId(String id) { this.id = id; }    public String getValue() { return value; }    public void setValue(String value) { this.value = value; }    @Override    public String toString() { return "MyPojo{" + "id='" + id + ''' + ", value='" + value + ''' + '}'; }}

优点与注意事项

优点：

消除硬编码： 彻底移除了if-else链和硬编码的Map映射，使代码更简洁、更易读。高可扩展性： 当需要引入新的数据存储库时，只需创建新的Repository实现，并为其指定唯一的Bean名称，无需修改现有控制器或服务层的逻辑，符合开闭原则。松耦合： 控制器或服务层只依赖于BaseRepositoryFactory接口，与具体的Repository实现解耦。Spring IoC集成： 充分利用Spring的依赖注入和Bean管理机制，无需手动管理Repository实例的生命周期。配置灵活性： 实际中，whereToSave的键值可以来自请求参数、配置文件、数据库等任何动态来源，提供了极大的灵活性。

注意事项：

Bean名称一致性： 确保@Repository注解中指定的名称与你在getBaseRepository方法中期望传入的参数值一致。如果未指定名称，Spring会默认使用类名（首字母小写）作为Bean名称。异常处理： 当ServiceLocatorFactoryBean无法找到匹配的Bean时，getBaseRepository方法会抛出NoSuchBeanDefinitionException。在实际应用中，应捕获并妥善处理此异常，例如返回错误信息或使用默认Repository。接口设计： BaseRepository接口应包含所有不同Repository实现都具备的通用操作。如果某些Repository有非常独特的方法，可能需要考虑更细粒度的接口设计或在获取到具体类型后进行类型转换。性能考量： 对于极高并发且Repository选择逻辑非常简单的情况，ServiceLocatorFactoryBean引入的间接层可能略微增加开销，但对于大多数业务场景，其带来的架构优势远超这点微小开销。

总结

通过采用服务定位器模式和Spring的ServiceLocatorFactoryBean，我们为Spring Boot应用程序提供了一种优雅且强大的解决方案，用于动态选择和管理多个Repository实现。这种方法不仅提升了代码的可维护性和扩展性，还使得应用程序能够更加灵活地适应不断变化的业务需求和数据存储策略。在面对需要根据运行时条件进行服务或组件选择的场景时，这种模式是一个值得考虑的优秀实践。

以上就是SpringBoot中基于设计模式和配置动态选择Repository策略的详细内容，更多请关注创想鸟其它相关文章！