自定义仓库实现

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

@EnableElasticsearchRepositories(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. 消除歧义的实现
package com.acme.impl.one;

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

  // Your custom implementation
}
package com.acme.impl.two;

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

  // Your custom implementation
}

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

手动连接

如果自定义实现仅使用基于注释的配置和自动连接，则前面显示的方法效果很好，因为它被视为任何其他 Spring 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
@EnableElasticsearchRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }
<repositories base-package="com.acme.repository"
     base-class="….MyRepositoryImpl" />