自定义存储库实现

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. 消除歧义的实现

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
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

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

在自定义实现中使用 `JpaContext`

当使用多个 EntityManager 实例和自定义存储库实现时，您需要将正确的 EntityManager 连接到存储库实现类。您可以通过在 @PersistenceContext 注释中明确命名 EntityManager 来实现此目的，或者如果 EntityManager 是 @Autowired，则通过使用 @Qualifier 来实现此目的。

从 Spring Data JPA 1.9 开始，Spring Data JPA 包含一个名为 JpaContext 的类，该类允许您按受管理的域类获取 EntityManager，假设它仅由应用程序中的一个 EntityManager 实例管理。以下示例演示如何在自定义存储库中使用 JpaContext

示例 5. 在自定义存储库实现中使用 JpaContext

class UserRepositoryImpl implements UserRepositoryCustom {

  private final EntityManager em;

  @Autowired
  public UserRepositoryImpl(JpaContext context) {
    this.em = context.getEntityManagerByManagedType(User.class);
  }

  …
}

此方法的优点是，如果域类型被分配给不同的持久性单元，则不必修改存储库来更改对持久性单元的引用。