自定義倉庫實現

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

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

手動注入

如果你的自定義實現僅使用基於註解的配置和自動注入，前面展示的方法效果很好，因為它被視作任何其他 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
@EnableLdapRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }

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