自定义存储库实现

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" />