|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Commons 3.5.3！ |
自定义存储库实现
Spring Data 提供了各种选项来创建几乎不需要编码的查询方法。 但是，当这些选项不符合您的需求时，您还可以为存储库方法提供自己的自定义实现。 本节介绍如何执行此作。
自定义单个存储库
要使用自定义功能扩充存储库，必须首先定义 fragment 接口和自定义功能的实现，如下所示：
interface CustomizedUserRepository {
void someCustomMethod(User user);
}class CustomizedUserRepositoryImpl implements CustomizedUserRepository {
@Override
public void someCustomMethod(User user) {
// Your custom implementation
}
}|
与片段接口相对应的类名中最重要的部分是 |
|
从历史上看，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.
以下示例显示了使用默认后缀的存储库和为后缀设置自定义值的存储库：
-
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名称来标识要使用的bean名称。
给定以下两个自定义实现CustomizedUserRepository前面显示，使用了第一个实现。
它的豆名是customizedUserRepositoryImpl，与片段接口（CustomizedUserRepository） 加上后缀Impl.
class CustomizedUserRepositoryImpl implements CustomizedUserRepository {
// Your custom implementation
}@Component("specialCustomImpl")
class CustomizedUserRepositoryImpl implements CustomizedUserRepository {
// Your custom implementation
}如果对UserRepository接口@Component("specialCustom")，bean 名称加Impl然后匹配为com.acme.impl.two，并且使用它代替第一个。
手动接线
如果您的自定义实现仅使用基于注释的配置和自动装配，则前面显示的方法效果很好，因为它被视为任何其他 Spring Bean。 如果实现片段 Bean 需要特殊连接，则可以声明 Bean 并根据上一节中描述的约定对其进行命名。 然后，基础架构按名称引用手动定义的 Bean 定义，而不是自己创建一个。 以下示例演示如何手动连接自定义实现：
-
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.factory 注册 Fragment
如配置部分所述，基础架构仅自动检测存储库基础包中的片段。
因此，如果驻留在另一个位置或希望由外部存档贡献的片段，如果它们不共享公共命名空间，则将找不到它们。
在spring.factories允许您规避此限制，如下一节所述。
假设你希望利用文本搜索索引为组织提供一些可在多个存储库中使用的自定义搜索功能。
首先，您需要的只是片段接口。
请注意通用<T>参数，使片段与存储库域类型保持一致。
public interface SearchExtension<T> {
List<T> search(String text, Limit limit);
}让我们假设实际的全文搜索可以通过SearchService注册为Bean在上下文中，以便您可以在我们的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()您需要建议负责创建实际存储库的存储库工厂公开方法元数据。
-
Marker Interface
-
Bean Post Processor
添加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 {
// ...
}这exposeMetadata标志可以通过BeanPostProcessor.
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.factoriescom.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，如以下示例所示：
-
Java
-
XML
@Configuration
@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
class ApplicationConfiguration { … }<repositories base-package="com.acme.repository"
base-class="….MyRepositoryImpl" />