自定義倉庫實現

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

自定義單個倉庫

要為倉庫新增自定義功能，您必須首先定義一個片段介面以及自定義功能的實現，如下所示

自定義倉庫功能的介面

interface CustomizedUserRepository {
  void someCustomMethod(User user);
}

自定義倉庫功能的實現

class CustomizedUserRepositoryImpl implements CustomizedUserRepository {

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

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

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

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

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

實現本身不依賴於 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 {

  @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 的自定義倉庫介面

您的倉庫介面的變更

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

  @Override
  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>

使用 spring.factories 註冊片段

如配置部分已提及，基礎設施僅自動檢測倉庫基礎包內的片段。因此，位於其他位置或希望由外部檔案貢獻的片段，如果它們不共享公共名稱空間，則不會被找到。在 spring.factories 中註冊片段允許您規避此限制，如下一節所述。

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

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

片段介面

public interface SearchExtension<T> {

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

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

片段實現

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 暴露了附加到倉庫的資訊，例如域型別。在這種情況下，我們使用倉庫域型別來標識要搜尋的索引的名稱。

暴露呼叫元資料成本很高，因此預設情況下是停用的。要訪問 RepositoryMethodContext.getContext()，您需要通知負責建立實際倉庫的倉庫工廠暴露方法元資料。

暴露倉庫元資料

標記介面
Bean 後處理器

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

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 直接在倉庫工廠 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;
            }
        };
    }
}

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

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

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

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

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

使用它

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

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

}

自定義基本倉庫

當您想自定義基本倉庫行為以便所有倉庫都受到影響時，上一節中描述的方法需要自定義每個倉庫介面。為了改變所有倉庫的行為，您可以建立一個實現來擴充套件特定於持久化技術的基本倉庫類。然後，該類將作為倉庫代理的自定義基類，如下例所示

自定義倉庫基類

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

該類需要有一個由特定儲存倉庫工廠實現使用的超類建構函式。如果倉庫基類有多個建構函式，請覆蓋接受 EntityInformation 加上特定儲存基礎設施物件（例如 EntityManager 或模板類）的那個。

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

示例 4. 配置自定義倉庫基類

Java
XML

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

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