聊聊spring data jpa的JpaQueryLookupStrategy

最新推荐文章于 2024-05-31 17:30:19 发布
最新推荐文章于 2024-05-31 17:30:19 发布
阅读量405 收藏 1
点赞数
文章标签： java
原文链接：https://my.oschina.net/go4it/blog/3036959
版权

为什么80%的码农都做不了架构师？>>>   hot3.png

序

本文主要研究一下spring data jpa的JpaQueryLookupStrategy

QueryLookupStrategy

spring-data-commons-2.1.6.RELEASE-sources.jar!/org/springframework/data/repository/query/QueryLookupStrategy.java

public interface QueryLookupStrategy {

	public static enum Key {

		CREATE, USE_DECLARED_QUERY, CREATE_IF_NOT_FOUND;

		/**
		 * Returns a strategy key from the given XML value.
		 *
		 * @param xml
		 * @return a strategy key from the given XML value
		 */
		@Nullable
		public static Key create(String xml) {

			if (!StringUtils.hasText(xml)) {
				return null;
			}

			return valueOf(xml.toUpperCase(Locale.US).replace("-", "_"));
		}
	}

	/**
	 * Resolves a {@link RepositoryQuery} from the given {@link QueryMethod} that can be executed afterwards.
	 *
	 * @param method will never be {@literal null}.
	 * @param metadata will never be {@literal null}.
	 * @param factory will never be {@literal null}.
	 * @param namedQueries will never be {@literal null}.
	 * @return
	 */
	RepositoryQuery resolveQuery(Method method, RepositoryMetadata metadata, ProjectionFactory factory,
			NamedQueries namedQueries);
}
  • QueryLookupStrategy定义了Key枚举，有CREATE, USE_DECLARED_QUERY, CREATE_IF_NOT_FOUND这些类型
  • QueryLookupStrategy有一个抽象类为AbstractQueryLookupStrategy，它有三个实现子类，分别是CreateQueryLookupStrategy、DeclaredQueryLookupStrategy、CreateIfNotFoundQueryLookupStrategy
  • QueryLookupStrategy还定义了resolveQuery方法用于将QueryMethod解析为RepositoryQuery

RepositoryQuery

spring-data-commons-2.1.6.RELEASE-sources.jar!/org/springframework/data/repository/query/RepositoryQuery.java

public interface RepositoryQuery {

	/**
	 * Executes the {@link RepositoryQuery} with the given parameters.
	 *
	 * @param parameters must not be {@literal null}.
	 * @return execution result. Can be {@literal null}.
	 */
	@Nullable
	Object execute(Object[] parameters);

	/**
	 * Returns the related {@link QueryMethod}.
	 *
	 * @return never {@literal null}.
	 */
	QueryMethod getQueryMethod();
}
  • RepositoryQuery接口定义了两个方法分别是execute、getQueryMethod；它有2个抽象类，一个是AbstractJpaQuery、另外一个是继承AbstractJpaQuery的AbstractStringBasedJpaQuery；AbstractJpaQuery有3个实现子类，分别是NamedQuery、PartTreeJpaQuery、StoredProcedureJpaQuery；AbstractStringBasedJpaQuery有两个实现子类，分别是SimpleJpaQuery及NativeJpaQuery

AbstractQueryLookupStrategy

spring-data-jpa-2.1.6.RELEASE-sources.jar!/org/springframework/data/jpa/repository/query/JpaQueryLookupStrategy.java

	/**
	 * Base class for {@link QueryLookupStrategy} implementations that need access to an {@link EntityManager}.
	 *
	 * @author Oliver Gierke
	 * @author Thomas Darimont
	 */
	private abstract static class AbstractQueryLookupStrategy implements QueryLookupStrategy {

		private final EntityManager em;
		private final QueryExtractor provider;

		/**
		 * Creates a new {@link AbstractQueryLookupStrategy}.
		 *
		 * @param em
		 * @param extractor
		 */
		public AbstractQueryLookupStrategy(EntityManager em, QueryExtractor extractor) {

			this.em = em;
			this.provider = extractor;
		}

		/*
		 * (non-Javadoc)
		 * @see org.springframework.data.repository.query.QueryLookupStrategy#resolveQuery(java.lang.reflect.Method, org.springframework.data.repository.core.RepositoryMetadata, org.springframework.data.projection.ProjectionFactory, org.springframework.data.repository.core.NamedQueries)
		 */
		@Override
		public final RepositoryQuery resolveQuery(Method method, RepositoryMetadata metadata, ProjectionFactory factory,
				NamedQueries namedQueries) {
			return resolveQuery(new JpaQueryMethod(method, metadata, factory, provider), em, namedQueries);
		}

		protected abstract RepositoryQuery resolveQuery(JpaQueryMethod method, EntityManager em, NamedQueries namedQueries);
	}
  • AbstractQueryLookupStrategy实现了QueryLookupStrategy接口定义的resolveQuery方法，不过它调用了自己定义的抽象方法resolveQuery

CreateQueryLookupStrategy

spring-data-jpa-2.1.6.RELEASE-sources.jar!/org/springframework/data/jpa/repository/query/JpaQueryLookupStrategy.java

	/**
	 * {@link QueryLookupStrategy} to create a query from the method name.
	 *
	 * @author Oliver Gierke
	 * @author Thomas Darimont
	 */
	private static class CreateQueryLookupStrategy extends AbstractQueryLookupStrategy {

		private final PersistenceProvider persistenceProvider;
		private final EscapeCharacter escape;

		public CreateQueryLookupStrategy(EntityManager em, QueryExtractor extractor, EscapeCharacter escape) {

			super(em, extractor);

			this.persistenceProvider = PersistenceProvider.fromEntityManager(em);
			this.escape = escape;
		}

		@Override
		protected RepositoryQuery resolveQuery(JpaQueryMethod method, EntityManager em, NamedQueries namedQueries) {
			return new PartTreeJpaQuery(method, em, persistenceProvider, escape);
		}
	}
  • CreateQueryLookupStrategy继承了AbstractQueryLookupStrategy，其resolveQuery方法创建的是PartTreeJpaQuery

DeclaredQueryLookupStrategy

spring-data-jpa-2.1.6.RELEASE-sources.jar!/org/springframework/data/jpa/repository/query/JpaQueryLookupStrategy.java

	/**
	 * {@link QueryLookupStrategy} that tries to detect a declared query declared via {@link Query} annotation followed by
	 * a JPA named query lookup.
	 *
	 * @author Oliver Gierke
	 * @author Thomas Darimont
	 */
	private static class DeclaredQueryLookupStrategy extends AbstractQueryLookupStrategy {

		private final QueryMethodEvaluationContextProvider evaluationContextProvider;

		/**
		 * Creates a new {@link DeclaredQueryLookupStrategy}.
		 *
		 * @param em
		 * @param extractor
		 * @param evaluationContextProvider
		 */
		public DeclaredQueryLookupStrategy(EntityManager em, QueryExtractor extractor,
				QueryMethodEvaluationContextProvider evaluationContextProvider) {

			super(em, extractor);
			this.evaluationContextProvider = evaluationContextProvider;
		}

		/*
		 * (non-Javadoc)
		 * @see org.springframework.data.jpa.repository.query.JpaQueryLookupStrategy.AbstractQueryLookupStrategy#resolveQuery(org.springframework.data.jpa.repository.query.JpaQueryMethod, javax.persistence.EntityManager, org.springframework.data.repository.core.NamedQueries)
		 */
		@Override
		protected RepositoryQuery resolveQuery(JpaQueryMethod method, EntityManager em, NamedQueries namedQueries) {

			RepositoryQuery query = JpaQueryFactory.INSTANCE.fromQueryAnnotation(method, em, evaluationContextProvider);

			if (null != query) {
				return query;
			}

			query = JpaQueryFactory.INSTANCE.fromProcedureAnnotation(method, em);

			if (null != query) {
				return query;
			}

			String name = method.getNamedQueryName();
			if (namedQueries.hasQuery(name)) {
				return JpaQueryFactory.INSTANCE.fromMethodWithQueryString(method, em, namedQueries.getQuery(name),
						evaluationContextProvider);
			}

			query = NamedQuery.lookupFrom(method, em);

			if (null != query) {
				return query;
			}

			throw new IllegalStateException(
					String.format("Did neither find a NamedQuery nor an annotated query for method %s!", method));
		}
	}
  • DeclaredQueryLookupStrategy继承了AbstractQueryLookupStrategy，其resolveQuery方法借助JpaQueryFactory.INSTANCE.fromQueryAnnotation、JpaQueryFactory.INSTANCE.fromProcedureAnnotation、NamedQuery.lookupFrom来生成

CreateIfNotFoundQueryLookupStrategy

spring-data-jpa-2.1.6.RELEASE-sources.jar!/org/springframework/data/jpa/repository/query/JpaQueryLookupStrategy.java

	/**
	 * {@link QueryLookupStrategy} to try to detect a declared query first (
	 * {@link org.springframework.data.jpa.repository.Query}, JPA named query). In case none is found we fall back on
	 * query creation.
	 *
	 * @author Oliver Gierke
	 * @author Thomas Darimont
	 */
	private static class CreateIfNotFoundQueryLookupStrategy extends AbstractQueryLookupStrategy {

		private final DeclaredQueryLookupStrategy lookupStrategy;
		private final CreateQueryLookupStrategy createStrategy;

		/**
		 * Creates a new {@link CreateIfNotFoundQueryLookupStrategy}.
		 *
		 * @param em
		 * @param extractor
		 * @param createStrategy
		 * @param lookupStrategy
		 */
		public CreateIfNotFoundQueryLookupStrategy(EntityManager em, QueryExtractor extractor,
				CreateQueryLookupStrategy createStrategy, DeclaredQueryLookupStrategy lookupStrategy) {

			super(em, extractor);

			this.createStrategy = createStrategy;
			this.lookupStrategy = lookupStrategy;
		}

		/*
		 * (non-Javadoc)
		 * @see org.springframework.data.jpa.repository.query.JpaQueryLookupStrategy.AbstractQueryLookupStrategy#resolveQuery(org.springframework.data.jpa.repository.query.JpaQueryMethod, javax.persistence.EntityManager, org.springframework.data.repository.core.NamedQueries)
		 */
		@Override
		protected RepositoryQuery resolveQuery(JpaQueryMethod method, EntityManager em, NamedQueries namedQueries) {

			try {
				return lookupStrategy.resolveQuery(method, em, namedQueries);
			} catch (IllegalStateException e) {
				return createStrategy.resolveQuery(method, em, namedQueries);
			}
		}
	}
  • CreateIfNotFoundQueryLookupStrategy继承了AbstractQueryLookupStrategy，它的构造器要求传入DeclaredQueryLookupStrategy、CreateQueryLookupStrategy参数，其resolveQuery方法先是借助DeclaredQueryLookupStrategy来创建RepositoryQuery，如果抛出的是IllegalStateException，再借助CreateQueryLookupStrategy来创建RepositoryQuery

JpaQueryLookupStrategy

spring-data-jpa-2.1.6.RELEASE-sources.jar!/org/springframework/data/jpa/repository/query/JpaQueryLookupStrategy.java

public final class JpaQueryLookupStrategy {

	/**
	 * Private constructor to prevent instantiation.
	 */
	private JpaQueryLookupStrategy() {}

	//......

	/**
	 * Creates a {@link QueryLookupStrategy} for the given {@link EntityManager} and {@link Key}.
	 *
	 * @param em must not be {@literal null}.
	 * @param key may be {@literal null}.
	 * @param extractor must not be {@literal null}.
	 * @param evaluationContextProvider must not be {@literal null}.
	 * @param escape
	 * @return
	 */
	public static QueryLookupStrategy create(EntityManager em, @Nullable Key key, QueryExtractor extractor,
			QueryMethodEvaluationContextProvider evaluationContextProvider, EscapeCharacter escape) {

		Assert.notNull(em, "EntityManager must not be null!");
		Assert.notNull(extractor, "QueryExtractor must not be null!");
		Assert.notNull(evaluationContextProvider, "EvaluationContextProvider must not be null!");

		switch (key != null ? key : Key.CREATE_IF_NOT_FOUND) {
			case CREATE:
				return new CreateQueryLookupStrategy(em, extractor, escape);
			case USE_DECLARED_QUERY:
				return new DeclaredQueryLookupStrategy(em, extractor, evaluationContextProvider);
			case CREATE_IF_NOT_FOUND:
				return new CreateIfNotFoundQueryLookupStrategy(em, extractor,
						new CreateQueryLookupStrategy(em, extractor, escape),
						new DeclaredQueryLookupStrategy(em, extractor, evaluationContextProvider));
			default:
				throw new IllegalArgumentException(String.format("Unsupported query lookup strategy %s!", key));
		}
	}
}
  • JpaQueryLookupStrategy提供一个静态方法create用于根据不同的QueryLookupStrategy.Key来创建不同的QueryLookupStrategy，默认是Key.CREATE_IF_NOT_FOUND，即创建CreateIfNotFoundQueryLookupStrategy

小结

  • QueryLookupStrategy定义了Key枚举，有CREATE, USE_DECLARED_QUERY, CREATE_IF_NOT_FOUND这些类型；QueryLookupStrategy有一个抽象类为AbstractQueryLookupStrategy，它有三个实现子类，分别是CreateQueryLookupStrategy、DeclaredQueryLookupStrategy、CreateIfNotFoundQueryLookupStrategy；QueryLookupStrategy还定义了resolveQuery方法用于将QueryMethod解析为RepositoryQuery
  • AbstractQueryLookupStrategy实现了QueryLookupStrategy接口定义的resolveQuery方法，不过它调用了自己定义的抽象方法resolveQuery
    • CreateQueryLookupStrategy继承了AbstractQueryLookupStrategy，其resolveQuery方法创建的是PartTreeJpaQuery(解析方法名)；
    • DeclaredQueryLookupStrategy继承了AbstractQueryLookupStrategy，其resolveQuery方法借助JpaQueryFactory.INSTANCE.fromQueryAnnotation(解析@Query注解)、JpaQueryFactory.INSTANCE.fromProcedureAnnotation(解析@Procedure注解)、NamedQuery.lookupFrom(解析@NamedQuery注解)来生成；
    • CreateIfNotFoundQueryLookupStrategy继承了AbstractQueryLookupStrategy，它的构造器要求传入DeclaredQueryLookupStrategy、CreateQueryLookupStrategy参数，其resolveQuery方法先是借助DeclaredQueryLookupStrategy来创建RepositoryQuery，如果抛出的是IllegalStateException，再借助CreateQueryLookupStrategy来创建RepositoryQuery
  • JpaQueryLookupStrategy提供一个静态方法create用于根据不同的QueryLookupStrategy.Key来创建不同的QueryLookupStrategy，默认是Key.CREATE_IF_NOT_FOUND，即创建CreateIfNotFoundQueryLookupStrategy

doc

转载于:https://my.oschina.net/go4it/blog/3036959

weixin_34380296
关注
spring-data-jpa的@Query运行机制
qq_40223554的博客
12-16 2952
** spring-data-jpa对与@Query运行机制 ** 我们可以使用@Query注解符给Repository中的方法加入自定义sql，使得方法能按照我们自己想要的方式搜索或修改数据。 关于这个@Query的注解符我们可以看到有一个参数nativeQuery默认值为false，当nativeQuery为false时我们需要给value一个Hql（Hibernate Query Language），当nativeQuery为true时我们需要给value一个Sql。 下面来看一下nativeQuer
详解 spring data jpa，全方位总结
m0_54828003的博客
08-03 4449
jpa 的全称是 Java Persistence API , 中文的字面意思就是 java 的持久层 API , jpa 就是定义了一系列标准，让实体类和数据库中的表建立一个对应的关系，当我们在使用 java 操作实体类的时候能达到操作数据库中表的效果(不用写sql ,就可以达到效果），jpa 的实现思想即是 ORM （Object Relation Mapping），对象关系映射，用于在关系型数据库和业务实体对象之间作一个映射。在使用 jpa 的时候,这几个注解应该如何使用呢？...
Spring Data JPA 从入门到精通~方法的查询策略设置
小强快跑~~
01-10 231
方法的查询策略设置 通过下面的命令来配置方法的查询策略： @EnableJpaRepositories(queryLookupStrategy= QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND) 其中，QueryLookupStrategy.Key 的值一共就三个： Create：直接根据方法名进行创建，规则是根据方法名称的构造进行尝试，一般的方法是从方法名中删除给定的一组已知前缀，并解析该方法的其余部分。如果方法名不符合规则，启动的时候会报异常。 USE_
org.springframework.data.repository.query.QueryByExampleExecutor cannot be resolved.
zhouzhiwengang的专栏
09-04 1254
SpringBoot 集成JPA提示如下错误信息： The type org.springframework.data.repository.query.QueryByExampleExecutor cannot be resolved. It is indirectly referenced from required .class files 从上述的错误信息可以得知Spring-data-jpa 间接依赖org.springframework.data.repository.query.Quer
SpringDataJpa：JpaRepository增删改查
卢卢在路上
09-06 4905
Jpa查询 1. JpaRepository简单查询 基本查询也分为两种，一种是spring data默认已经实现，一种是根据查询的方法来自动解析成SQL。 预先生成方法 spring data jpa 默认预先生成了一些基本的CURD的方法，例如：增、删、改等等 继承JpaRepository public interface UserRepository extends JpaRepo......
我选择了MySQL和SpringData JPA
m0_68064743的博客
04-01 240
01、数据库选择 之前发了一张我可能要在austin项目上引入哪些技术栈的图，好多人问我分布式配置中心为什么不选择Nacos，而是用Apollo。却没人问我为什么数据库选择MySQL。 说起来MySQL，在网上看到的各类Java教程，几乎都是使用MySQL作为数据库。日常在群里聊各种数据库上的问题，也差不多都是MySQL，只有个别的可能用PostgreSQL和Oracle或其他 就连我在面试的时候，我也没被面试官问过：“你的数据库为什么选择MySQL啊？这块技术选型是怎么样的” 看到这里，是不是觉得我有答案
还在用Mybatis? Spring Data JPA 让你的开发效率提升数倍！
公众号：微观技术
02-10 2361
1、前言 Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套 JPA 应用框架，底层使用了 Hibernate 的 JPA 技术实现，可使开发者用极简的代码即可实现对数据的访问和操作。它提供了包括增、删、改、查等在内的常用功能，易于扩展，极大提高开发效率。 Spring Data Common 是 Spring Data 所有模块的公共部分，该项目提供了基于 Spring 的共享基础设施，它提供了基于 repository 接口以 DB 操作的一些封装，
Spring Data JPA的一对一多表查询
m0_66884848的博客
03-22 6123
一、简单聊聊 我在写自己的课程设计的时候，用的持久层API就是JPA。整个项目给我带来的感受就是：低SQL语句开发，甚至是零SQL语句开发，使得我在开发过程中，不再关注SQL语句的书写问题与逻辑问题。这使得我在开发过程中，更加专注于自己的业务逻辑，而不在拘泥于SQL表和Java实体之间的映射。尤其在多表查询这一块，JPA以其超简洁的语法规则，给我们实现了表一对一乃至一对多的关系。那么今天想给大家分享的是，一对一的多表查询。 二、简单认识JPA 以下引用了网上对JPA的介绍： ...
Spring Data JPA系列4——Spring声明式数事务处理与多数据源支持
「 虚幻私塾」
06-26 242
大家好，又见面了。到这里呢，已经是本系列文档的第四篇了，先来回顾下前面三篇：本篇在前面几篇的基础上，再来聊一下数据库相关操作经常会涉及的事务问题与多数据源支持问题。在大部分涉及到数据库操作的项目里面，事务控制、事务处理都是一个无法回避的问题。得益于Spring框架的封装，业务代码中进行事务控制操作起来也很简单，直接加个@Transactional注解即可，大大简化了对业务代码的侵入性。那么对@Transactional事务注解了解的够全面吗？知道有哪些场景可能会导致@Transactional注解并不会如你
6.2 Spring Boot集成jpa
AI天才研究院
04-26 8547
6.2 Spring Boot集成jpa Java持久化API（JPA，Java Persistence API）是一个将对象映射为关系数据库的标准技术。JPA通过注解或XML描述ORM（Object Relationship Mapping，对象-关系表的映射关系），并将运行期的实体对象持久化到数据库中。 其中，SQL（结构化查询语言, Structur...
spring data jpa通过方法名称定义查询的实现机制解析
u013905744的专栏
09-27 2596
使用方法 spring data jpa其实体Repository继承Repository接口，如JpaRepository等接口，也可以选择JpaSpecificationExecutor，这样就可以使用方法名称，来定义查询 如 List<User> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname) List<User> findDistinctPeopleByLastnameOrFi
Spring学习笔记： Repository实现（一）
flyingpignj的博客
08-11 4093
在使用Spring的过程中， 可以定义自己的Repository接口，并不需要完成具体的实现，Spring会帮助创建具体的实例. 方法名应该遵循什么样的规则，Spring才能帮助实现呢。
data jpa扩展支持动态sql
lgxzzz的博客
08-10 668
data jpa扩展支持动态sql 更多干货 分布式实战（干货） spring cloud 实战（干货） mybatis 实战（干货） spring boot 实战（干货） React 入门实战（干货） 构建中小型互联网企业架构（干货） 前言 一般在写业务接口的过程中，很有可能需要实现可以动态组合各种查询条件的接口。如果我们根据一种查询条件组合一个方法的做法来写，那么将会有大量方法存在，繁琐，维护起来相当困难。想要实现动态查询，其实就是要实现拼接SQL语句。 spring data .
Spring Data JPA 查询方法的命名语法与参数
曾小二的博客
05-04 3226
3 Spring Data JPA 查询方法的命名语法与参数 在⼯作中，你是否经常为⽅法名的语义、命名规范⽽发愁？是否要为不同的查询条件写各种的 SQL 语句？是否为同⼀个实体的查询，写⼀个超级通⽤的查询⽅法或者 SQL？如果其他开发同事不查看你写的 SQL 语句，⽽直接看⽅法名的话，却不知道你想查什么⽽郁闷？Spring Data JPA 的 Defining Query Methods（DQM）通过⽅法名和参数，可以很好地解决上⾯的问题，也能让我们的⽅法名的语义更加清晰，开发效率也会提升很多。DQM 语
【源码】Spring Data JPA原理解析之Repository自定义方法添加@Query注解的执行原理
最新发布
JingAi_jia917的博客
05-31 1341
本篇从源码角度分享Repository中自定义方法带@Query注解的接口的实现原理。重点分析了ExpressionBasedStringQuery、StringQuery和AbstractStringBasedJpaQuery的源码。
spring data jdbc的简单教程
做你想做的人，没有时间的限制，只要愿意，什么时候都可以start。
04-12 5869
你需要先做一番配置，跟我来！ 目录 配置springconfig 数据库和实体类配置。 数据库:就俩字段，一个是userid,一个是username 实体类： DAO层接口： 开始测试： 其他一些事项: 结语： 配置springconfig import javax.sql.DataSource; import org.springframework.context...
06 Spring Data JPA查询操作
仙贝儿
09-17 263
Spring Data JPA查询操作 Spring Data JPA的实现原理是采用动态代理机制，所以将介绍两种查询方式 从方法名称中可以指定特定用于存储的查询和更新 通过使用@Query手动定义查询 想要以上操作，只需要实体Repository继承Spring Data Common里面的Repository接口即可。 方法的查询策略设置 通过@EnableJpaRepositories...
SpringDataJPA入门与实战指南
"本文是关于Spring Data JPA的开发指南，由张建平撰写，适合初级开发者，旨在通过从简单的JPA示例入手，逐步引导读者理解并使用Spring Data JPA框架。文中首先简述JPA的基本概念，然后通过重构示例引入Spring框架，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值