自定義倉庫實現

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

@EnableNeo4jRepositories(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. 歧義實現的解決

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 中為倉庫實現定義的名稱，並將使用它而不是第一個實現。

手動裝配

如果您的自定義實現僅使用基於註解的配置和自動裝配，則前面展示的方法效果很好，因為它被視為任何其他 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>，以便將片段與倉庫域型別對齊。

片段介面

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

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

暴露倉庫元資料

標記介面
Bean 後置處理器

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

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

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

使用它

package io.my.movies;

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
@EnableNeo4jRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

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