自定義倉庫實現

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

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

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