自定义存储库实现

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 中为存储库实现定义的名称，并且它将代替第一个名称使用。

手动布线

如果您的自定义实现仅使用基于注释的配置和自动装配，则前面显示的方法很好用，因为它被视为任何其他 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
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

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