自定義 Repository 實現

Spring Data 提供了多種選項來建立少量程式碼的查詢方法。但是當這些選項不符合您的需求時，您也可以為 repository 方法提供自己的自定義實現。本節描述瞭如何執行此操作。

定製單個 Repository

為了使用自定義功能豐富 repository，您必須首先定義一個片段介面以及自定義功能的實現，如下所示：

自定義 repository 功能的介面

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定義 repository 功能的實現

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

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

與片段介面對應的類名中最重要的部分是 Impl 字尾。您可以透過設定 @Enable<StoreModule>Repositories(repositoryImplementationPostfix = …) 來定製特定儲存的字尾。

從歷史上看，Spring Data 自定義 repository 實現的發現遵循一種命名模式，該模式從 repository 派生自定義實現類名，從而有效地允許單個自定義實現。

與 repository 介面位於同一包中，並且與 repository 介面名稱後跟 實現字尾 匹配的型別被視為自定義實現並將被視為自定義實現。遵循該名稱的類可能會導致意外的行為。

我們認為單自定義實現命名已被棄用，建議不要使用此模式。請改為遷移到基於片段的程式設計模型。

實現本身不依賴於 Spring Data，可以是常規的 Spring Bean。因此，您可以使用標準的依賴注入行為來注入對其他 Bean（例如 JdbcTemplate）的引用，參與切面等等。

然後您可以讓您的 repository 介面繼承片段介面，如下所示：

對您的 repository 介面的更改

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

  // Declare query methods here
}

使用您的 repository 介面擴充套件片段介面將 CRUD 功能和自定義功能結合起來，並使其可供客戶端使用。

Spring Data repository 透過使用構成 repository 組合的片段來實現。片段包括基礎 repository、功能性切面（例如 Querydsl）以及自定義介面及其實現。每次向 repository 介面新增一個介面時，您都透過新增一個片段來增強組合。基礎 repository 和 repository 切面實現由每個 Spring Data 模組提供。

以下示例顯示了自定義介面及其實現：

片段及其實現

interface HumanRepository {
  void someHumanMethod(User user);
}

class HumanRepositoryImpl implements HumanRepository {

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

interface ContactRepository {

  void someContactMethod(User user);

  User anotherContactMethod(User user);
}

class ContactRepositoryImpl implements ContactRepository {

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

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

以下示例顯示了一個擴充套件 CrudRepository 的自定義 repository 介面：

對您的 repository 介面的更改

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

  // Declare query methods here
}

Repository 可以由多個自定義實現組成，這些實現按照其宣告順序匯入。自定義實現比基礎實現和 repository 切面具有更高的優先順序。此順序允許您覆蓋基礎 repository 和切面方法，並在兩個片段貢獻相同方法簽名時解決歧義。Repository 片段不僅限於在單個 repository 介面中使用。多個 repository 可以使用一個片段介面，從而允許您在不同的 repository 之間重用自定義功能。

以下示例顯示了一個 repository 片段及其實現：

覆蓋 save(…) 的片段

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

class CustomizedSaveImpl<T> implements CustomizedSave<T> {

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

以下示例顯示了一個使用前面 repository 片段的 repository：

定製的 repository 介面

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

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

配置

repository 基礎設施嘗試透過掃描找到 repository 的包下的類來自動檢測自定義實現片段。這些類需要遵循追加字尾（預設為 Impl）的命名約定。

以下示例顯示了一個使用預設字尾的 repository 和一個為字尾設定自定義值的 repository：

示例 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 的類作為自定義 repository 實現。第二個示例嘗試查詢 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 中為 repository 實現定義的名稱匹配，並使用它而不是第一個實現。

手動裝配

如果您的自定義實現僅使用基於註解的配置和自動裝配，則前面所示的方法效果很好，因為它被視為任何其他 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>

使用 spring.factories 註冊片段

正如配置部分已經提到的，基礎設施僅在 repository 基本包內自動檢測片段。因此，如果片段位於其他位置或想由外部存檔貢獻，並且它們不共享共同名稱空間，則將找不到它們。在 spring.factories 中註冊片段可以繞過此限制，如下一節所述。

假設您想為您的組織提供一些自定義搜尋功能，可跨多個 repository 使用，並利用文字搜尋索引。

首先，您需要的是片段介面。請注意泛型 <T> 引數，以使片段與 repository 域型別對齊。

片段介面

package com.acme.search;

public interface SearchExtension<T> {

    List<T> search(String text, Limit limit);
}

假設實際的全文搜尋透過一個註冊為上下文中的 Bean 的 SearchService 提供，這樣您就可以在我們的 SearchExtension 實現中消費它。執行搜尋所需的一切是集合（或索引）名稱以及一個將搜尋結果轉換為實際域物件的物件對映器，如下所示。

片段實現

package com.acme.search;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Limit;
import org.springframework.data.repository.core.RepositoryMethodContext;

class DefaultSearchExtension<T> implements SearchExtension<T> {

    private final SearchService service;

    DefaultSearchExtension(SearchService service) {
        this.service = service;
    }

    @Override
    public List<T> search(String text, Limit limit) {
        return search(RepositoryMethodContext.getContext(), text, limit);
    }

    List<T> search(RepositoryMethodContext metadata, String text, Limit limit) {

        Class<T> domainType = metadata.getRepository().getDomainType();

        String indexName = domainType.getSimpleName().toLowerCase();
        List<String> jsonResult = service.search(indexName, text, 0, limit.max());

        return jsonResult.stream().map(…).collect(toList());
    }
}

在上面的示例中，RepositoryMethodContext.getContext() 用於檢索實際方法呼叫的元資料。RepositoryMethodContext 暴露了附加到 repository 的資訊，例如域型別。在這種情況下，我們使用 repository 域型別來確定要搜尋的索引名稱。

暴露呼叫元資料是昂貴的，因此預設情況下停用它。要訪問 RepositoryMethodContext.getContext()，您需要建議負責建立實際 repository 的 repository 工廠暴露方法元資料。

暴露 Repository 元資料

標記介面
Bean Post Processor

將 RepositoryMetadataAccess 標記介面新增到片段實現中將觸發基礎設施併為使用該片段的 repository 啟用元資料暴露。

package com.acme.search;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Limit;
import org.springframework.data.repository.core.support.RepositoryMetadataAccess;
import org.springframework.data.repository.core.RepositoryMethodContext;

class DefaultSearchExtension<T> implements SearchExtension<T>, RepositoryMetadataAccess {

    // ...
}

可以透過 BeanPostProcessor 直接在 repository 工廠 bean 上設定 exposeMetadata 標誌。

import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.repository.core.support.RepositoryFactoryBeanSupport;
import org.springframework.lang.Nullable;

@Configuration
class MyConfiguration {

    @Bean
    static BeanPostProcessor exposeMethodMetadata() {

        return new BeanPostProcessor() {

            @Override
            public Object postProcessBeforeInitialization(Object bean, String beanName) {

                if(bean instanceof RepositoryFactoryBeanSupport<?,?,?> factoryBean) {
                    factoryBean.setExposeMetadata(true);
                }
                return bean;
            }
        };
    }
}

請不要簡單地複製/貼上上述內容，而是考慮您的實際用例，這可能需要一種更精細的方法，因為上述方法只會簡單地在每個 repository 上啟用該標誌。

將片段宣告和實現都準備就緒後，您可以在 META-INF/spring.factories 檔案中註冊擴充套件，並在需要時打包。

在 META-INF/spring.factories 中註冊片段

com.acme.search.SearchExtension=com.acme.search.DefaultSearchExtension

現在您已準備好使用您的擴充套件；只需將介面新增到您的 repository 中即可。

使用它

package io.my.movies;

import com.acme.search.SearchExtension;
import org.springframework.data.repository.CrudRepository;

interface MovieRepository extends CrudRepository<Movie, String>, SearchExtension<Movie> {

}

定製基礎 Repository

前面部分描述的方法要求您在想要定製基礎 repository 行為以影響所有 repository 時，定製每個 repository 介面。為了改為更改所有 repository 的行為，您可以建立一個實現，該實現擴充套件持久化技術特定的 repository 基礎類。然後，此類將充當 repository 代理的自定義基礎類，如下例所示：

自定義 repository 基礎類

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;
  }

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

該類需要具有其 store 特定 repository 工廠實現使用的超類建構函式。如果 repository 基礎類有多個建構函式，請覆蓋接受 EntityInformation 以及特定儲存基礎設施物件（例如 EntityManager 或模板類）的那個。

最後一步是使 Spring Data 基礎設施知道定製的 repository 基礎類。在配置中，您可以使用 repositoryBaseClass 來實現這一點，如下例所示：

示例 4. 配置自定義 repository 基礎類

Java
XML

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

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