自定義 Repository 實現

Spring Data 提供了多種選項，只需少量編碼即可建立查詢方法。但當這些選項不滿足您的需求時，您也可以為 repository 方法提供自己的自定義實現。本節將介紹如何實現。

自定義單個 Repository

要使用自定義功能豐富一個 repository，您必須首先為該自定義功能定義一個 fragment 介面及其實現，如下所示

用於自定義 repository 功能的介面

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定義 repository 功能的實現

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

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

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

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

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

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

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

然後您可以讓您的 repository 介面擴充套件該 fragment 介面，如下所示

對您的 repository 介面的更改

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

  // Declare query methods here
}

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

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

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

帶有其實現的 Fragment

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
}

Repositories 可以由多個自定義實現組成，這些實現按照其宣告的順序匯入。自定義實現的優先順序高於基本實現和 repository 切面。這種順序允許您覆蓋基本 repository 和切面方法，並在兩個 fragment 貢獻相同方法簽名時解決歧義。Repository fragment 不僅限於在一個 repository 介面中使用。多個 repositories 可以使用同一個 fragment 介面，從而允許您在不同的 repositories 中重用定製。

以下示例展示了一個 repository fragment 及其實現

覆蓋 save(…) 的 Fragment

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 fragment 的 repository

自定義 repository 介面

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

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

配置

repository 基礎設施會嘗試透過掃描在其找到 repository 的包下的類來自動檢測自定義實現 fragment。這些類需要遵循附加字尾的命名約定，預設字尾為 Impl。

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

示例 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 的類作為自定義 repository 實現。第二個示例會嘗試查詢 com.acme.repository.CustomizedUserRepositoryMyPostfix。

歧義解決

如果在不同的包中找到多個具有匹配類名的實現，Spring Data 會使用 bean 名稱來標識要使用哪一個。

考慮到前面展示的 CustomizedUserRepository 的以下兩個自定義實現，將使用第一個實現。它的 bean 名稱是 customizedUserRepositoryImpl，這與 fragment 介面 (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 中為 repository 實現定義的名稱，並且將使用它而不是第一個實現。

手動連線

如果您的自定義實現僅使用基於註解的配置和自動注入，前述方法效果很好，因為它被當作任何其他 Spring bean 處理。如果您的實現 fragment 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 註冊 Fragment

正如配置部分已經提到的，基礎設施只會在 repository 基本包內自動檢測 fragment。因此，如果 fragment 位於其他位置或需要由外部存檔貢獻，並且它們不共享一個共同的名稱空間，那麼它們將不會被找到。在 spring.factories 中註冊 fragment 可以讓您規避此限制，如下一節所述。

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

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

Fragment 介面

public interface SearchExtension<T> {

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

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

Fragment 實現

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 factory 來暴露方法元資料。

暴露 Repository 元資料

標記介面
Bean 後置處理器

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

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 factory 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 上啟用該標誌。

宣告和實現 fragment 都到位後，您可以在 META-INF/spring.factories 檔案中註冊該擴充套件，並在需要時進行打包。

在 `META-INF/spring.factories` 中註冊 fragment

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

現在您可以使用您的擴充套件了；只需將該介面新增到您的 repository 中即可。

使用它

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 factory 實現使用的父類建構函式。如果 repository 基類有多個建構函式，請重寫接受 EntityInformation 以及 store 特定基礎設施物件（例如 EntityManager 或模板類）的建構函式。

最後一步是讓 Spring Data 基礎設施知曉自定義的 repository 基類。在配置中，您可以透過使用 repositoryBaseClass 來實現，如下例所示

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

Java
XML

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

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