自定义存储库实现

Spring Data 提供了多种创建查询方法的选项，只需少量编码。但是，当这些选项不满足您的需求时，您也可以为存储库方法提供自己的自定义实现。本节介绍如何做到这一点。

自定义单个仓库

要为仓库添加自定义功能，您需要先定义一个片段接口和一个用于自定义功能的实现，如下所示

自定义仓库功能的接口

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定义仓库功能的实现

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  public void someCustomMethod(User user) {
    // Your custom implementation
  }
}

与片段接口对应的类名中最重要的部分是 Impl 后缀。

实现本身不依赖于 Spring Data，可以是普通的 Spring Bean。因此，您可以使用标准的依赖注入行为来注入对其他 Bean 的引用（例如 JdbcTemplate），参与方面，等等。

然后，您可以让您的仓库接口扩展片段接口，如下所示

对仓库接口的更改

interface UserRepository extends CrudRepository<User, Long>, CustomizedUserRepository {

  // Declare query methods here
}

将片段接口与您的仓库接口扩展在一起，将 CRUD 和自定义功能结合起来，并使其可供客户端使用。

Spring Data 仓库是通过使用构成仓库组合的片段来实现的。片段是基本仓库、功能方面（例如 QueryDsl）以及自定义接口及其实现。每次将接口添加到仓库接口时，您都会通过添加片段来增强组合。基本仓库和仓库方面实现由每个 Spring Data 模块提供。

以下示例显示了自定义接口及其实现

带有实现的片段

interface HumanRepository {
  void someHumanMethod(User user);
}

class HumanRepositoryImpl implements HumanRepository {

  public void someHumanMethod(User user) {
    // Your custom implementation
  }
}

interface ContactRepository {

  void someContactMethod(User user);

  User anotherContactMethod(User user);
}

class ContactRepositoryImpl implements ContactRepository {

  public void someContactMethod(User user) {
    // Your custom implementation
  }

  public User anotherContactMethod(User user) {
    // Your custom implementation
  }
}

以下示例显示了扩展 CrudRepository 的自定义仓库的接口

对仓库接口的更改

interface UserRepository extends CrudRepository<User, Long>, HumanRepository, ContactRepository {

  // Declare query methods here
}

仓库可以由多个自定义实现组成，这些实现按其声明顺序导入。自定义实现比基本实现和仓库方面具有更高的优先级。这种排序允许您覆盖基本仓库和方面方法，并在两个片段贡献相同方法签名时解决歧义。仓库片段不仅限于在单个仓库接口中使用。多个仓库可以使用片段接口，让您在不同的仓库之间重用自定义项。

以下示例显示了仓库片段及其实现

覆盖 save(…) 的片段

interface CustomizedSave<T> {
  <S extends T> S save(S entity);
}

class CustomizedSaveImpl<T> implements CustomizedSave<T> {

  public <S extends T> S save(S entity) {
    // Your custom implementation
  }
}

以下示例显示了使用前面仓库片段的仓库

自定义仓库接口

interface UserRepository extends CrudRepository<User, Long>, CustomizedSave<User> {
}

interface PersonRepository extends CrudRepository<Person, Long>, CustomizedSave<Person> {
}

配置

仓库基础设施尝试通过扫描它找到仓库的包下面的类来自动检测自定义实现片段。这些类需要遵循将后缀附加到默认值为 Impl 的命名约定。

以下示例显示了使用默认后缀的仓库和为后缀设置自定义值的仓库

示例 1. 配置示例

Java
XML

@EnableJpaRepositories(repositoryImplementationPostfix = "MyPostfix")
class Configuration { … }

<repositories base-package="com.acme.repository" />

<repositories base-package="com.acme.repository" repository-impl-postfix="MyPostfix" />

前面的示例中的第一个配置尝试查找名为 com.acme.repository.CustomizedUserRepositoryImpl 的类，以充当自定义仓库实现。第二个示例尝试查找 com.acme.repository.CustomizedUserRepositoryMyPostfix。

歧义解决

如果在不同的包中找到多个具有匹配类名的实现，Spring Data 将使用 bean 名称来识别要使用哪个实现。

鉴于以下两个针对之前显示的 CustomizedUserRepository 的自定义实现，将使用第一个实现。它的 bean 名称是 customizedUserRepositoryImpl，它与片段接口（CustomizedUserRepository）加上后缀 Impl 相匹配。

示例 2. 歧义实现的解决

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

@Component("specialCustomImpl")
class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}

如果使用 @Component("specialCustom") 注解 UserRepository 接口，则 bean 名称加上 Impl 就会与 com.acme.impl.two 中为存储库实现定义的 bean 名称匹配，并且将使用它而不是第一个实现。

手动连接

如果自定义实现仅使用基于注解的配置和自动连接，则前面显示的方法效果很好，因为它被视为任何其他 Spring bean。如果实现片段 bean 需要特殊连接，则可以声明 bean 并根据上一节中描述的约定对其进行命名。然后，基础设施将按名称引用手动定义的 bean 定义，而不是自己创建 bean 定义。以下示例展示了如何手动连接自定义实现

示例 3. 自定义实现的手动连接

Java
XML

class MyClass {
  MyClass(@Qualifier("userRepositoryImpl") UserRepository userRepository) {
    …
  }
}

<repositories base-package="com.acme.repository" />

<beans:bean id="userRepositoryImpl" class="…">
  <!-- further configuration -->
</beans:bean>

自定义基础存储库

当您想要自定义基础存储库行为以影响所有存储库时，上一节中描述的方法需要对每个存储库接口进行自定义。为了更改所有存储库的行为，您可以创建一个扩展特定于持久性技术的存储库基类的实现。然后，此类充当存储库代理的自定义基类，如以下示例所示

自定义存储库基类

class MyRepositoryImpl<T, ID>
  extends SimpleJpaRepository<T, ID> {

  private final EntityManager entityManager;

  MyRepositoryImpl(JpaEntityInformation entityInformation,
                          EntityManager entityManager) {
    super(entityInformation, entityManager);

    // Keep the EntityManager around to used from the newly introduced methods.
    this.entityManager = entityManager;
  }

  @Transactional
  public <S extends T> S save(S entity) {
    // implementation goes here
  }
}

该类需要具有超类的构造函数，该构造函数由特定于存储的存储库工厂实现使用。如果存储库基类具有多个构造函数，请覆盖接受 EntityInformation 和特定于存储的基础设施对象（例如 EntityManager 或模板类）的构造函数。

最后一步是让 Spring Data 基础设施感知自定义的仓库基类。在配置中，您可以使用 `repositoryBaseClass` 来实现，如下例所示

示例 4. 配置自定义仓库基类

Java
XML

@Configuration
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />