自訂 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

@EnableMongoRepositories(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);
}

假設實際的全文檢索搜尋可透過 SearchService 取得，該服務已註冊為內容中的 Bean，因此您可以在我們的 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 後處理器

將 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 {

    // ...
}

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

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

類別需要具有超類別的建構子，儲存庫特定的 repository 工廠實作會使用該建構子。如果 repository 基礎類別有多個建構子，請覆寫採用 EntityInformation 以及儲存庫特定基礎架構物件（例如 EntityManager 或範本類別）的建構子。

最後一步是讓 Spring Data 基礎架構知道自訂的 repository 基礎類別。在組態中，您可以透過使用 repositoryBaseClass 來執行此操作，如下列範例所示

範例 4. 組態自訂 repository 基礎類別

Java
XML

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

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