聊聊spring data jpa的JpaQueryLookupStrategy

最新推荐文章于 2024-05-31 17:30:19 发布
最新推荐文章于 2024-05-31 17:30:19 发布
阅读量715 收藏
点赞数
文章标签： java 数据库
原文链接：https://juejin.im/post/5cb408c56fb9a068a4118277
版权

序

本文主要研究一下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://juejin.im/post/5cb408c56fb9a068a4118277

weixin_33811961
关注
springDataJpa的query使用
wang_yaqin的博客
04-26 621
一、根据方法命名规则自动生成 org.springframework.data.repository.query.parser.PartTree 源码里面定义的规则： private static final String KEYWORD_TEMPLATE = "(%s)(?=(\\p{Lu}|\\P{InBASIC_LATIN}))"; private static final Str...
jpa初探
C_H_K的博客
05-18 647
jpa jpa是Java Persistence API简称 主键生成策略GenerationType TABLE 使用一个特定的数据库表格来保存主键，这个策略可以由表模拟序列产生主键， 不依赖于数据库的具体实现，有利于数据库的移植。序列表有一个序列名和对应值两个字段，只需要一张序列就可以用于多张表的主键生成 SEQUENCE 根据底层数据库的序列来生成主键，条件是数...
Spring Data JPA 从入门到精通~方法的查询策略设置
小强快跑~~
01-10 215
方法的查询策略设置 通过下面的命令来配置方法的查询策略： @EnableJpaRepositories(queryLookupStrategy= QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND) 其中，QueryLookupStrategy.Key 的值一共就三个： Create：直接根据方法名进行创建，规则是根据方法名称的构造进行尝试，一般的方法是从方法名中删除给定的一组已知前缀，并解析该方法的其余部分。如果方法名不符合规则，启动的时候会报异常。 USE_
6.2 Spring Boot集成jpa
AI天才研究院
04-26 8545
6.2 Spring Boot集成jpa Java持久化API（JPA，Java Persistence API）是一个将对象映射为关系数据库的标准技术。JPA通过注解或XML描述ORM（Object Relationship Mapping，对象-关系表的映射关系），并将运行期的实体对象持久化到数据库中。 其中，SQL（结构化查询语言, Structur...
详解 spring data jpa，全方位总结
m0_54828003的博客
08-03 4421
jpa 的全称是 Java Persistence API , 中文的字面意思就是 java 的持久层 API , jpa 就是定义了一系列标准，让实体类和数据库中的表建立一个对应的关系，当我们在使用 java 操作实体类的时候能达到操作数据库中表的效果(不用写sql ,就可以达到效果），jpa 的实现思想即是 ORM （Object Relation Mapping），对象关系映射，用于在关系型数据库和业务实体对象之间作一个映射。在使用 jpa 的时候,这几个注解应该如何使用呢？...
我选择了MySQL和SpringData JPA
m0_68064743的博客
04-01 228
01、数据库选择 之前发了一张我可能要在austin项目上引入哪些技术栈的图，好多人问我分布式配置中心为什么不选择Nacos，而是用Apollo。却没人问我为什么数据库选择MySQL。 说起来MySQL，在网上看到的各类Java教程，几乎都是使用MySQL作为数据库。日常在群里聊各种数据库上的问题，也差不多都是MySQL，只有个别的可能用PostgreSQL和Oracle或其他 就连我在面试的时候，我也没被面试官问过：“你的数据库为什么选择MySQL啊？这块技术选型是怎么样的” 看到这里，是不是觉得我有答案
Spring Data JPA的一对一多表查询
m0_66884848的博客
03-22 6096
一、简单聊聊 我在写自己的课程设计的时候，用的持久层API就是JPA。整个项目给我带来的感受就是：低SQL语句开发，甚至是零SQL语句开发，使得我在开发过程中，不再关注SQL语句的书写问题与逻辑问题。这使得我在开发过程中，更加专注于自己的业务逻辑，而不在拘泥于SQL表和Java实体之间的映射。尤其在多表查询这一块，JPA以其超简洁的语法规则，给我们实现了表一对一乃至一对多的关系。那么今天想给大家分享的是，一对一的多表查询。 二、简单认识JPA 以下引用了网上对JPA的介绍： ...
还在用Mybatis? Spring Data JPA 让你的开发效率提升数倍！
公众号：微观技术
02-10 2340
1、前言 Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套 JPA 应用框架，底层使用了 Hibernate 的 JPA 技术实现，可使开发者用极简的代码即可实现对数据的访问和操作。它提供了包括增、删、改、查等在内的常用功能，易于扩展，极大提高开发效率。 Spring Data Common 是 Spring Data 所有模块的公共部分，该项目提供了基于 Spring 的共享基础设施，它提供了基于 repository 接口以 DB 操作的一些封装，
基于 Spring Data JPA 聊聊悲观锁和乐观锁
happyJared
03-01 1391
举个场景：多线程、多进程应用在对数据库的同一数据进行非幂等操作时，如果没有添加相应的锁机制进行校验、判断，通常会导致数据的脏写。抛开分布式锁这种解决思路，简单的来讲，可以优先考虑从数据库层面去解决这个问题。 数据库锁分为乐观锁和悲观锁，前者适合读多写少的场景，后者适合读少写多的场景。乐观锁的实现通常是采用加版本号的形式，即如果更新时版本号未发生改变，则本次操作是成功的，且当前版本号的信息也相应会发...
spring data jpa通过方法名称定义查询的实现机制解析
u013905744的专栏
09-27 2549
使用方法 spring data jpa其实体Repository继承Repository接口，如JpaRepository等接口，也可以选择JpaSpecificationExecutor，这样就可以使用方法名称，来定义查询 如 List<User> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname) List<User> findDistinctPeopleByLastnameOrFi
spring-data-jpa应用详细总结
yunduanyou的博客
07-28 373
零、前言 前面jpa详解 中也说了spring-data-jpa 秉承spring的优良传统（简化java开发），在jpa的基础上进一步抽象简化，下面就说说spring是如果简化jpa的。 简化思路： 我们平时开发持久化层（dao）时，都需要写一个个接口，例如findByName(String name), findByAddress(String address)，如果开发人员命名规范，我们即使...
Spring Data JDBC（二）
幽灵 逐梦--专栏
04-29 5399
Spring Data JDBC - Reference Documentation https://docs.spring.io/spring-data/jdbc/docs/1.0.6.RELEASE/reference/html/ 前言 Spring Data JDBC提供基于JDBC的存储库抽象。 项目元数据 版本控制:http://github.com/spring-pro...
JPA之JPQL查询缓存
u014268482的博客
07-03 2233
原始代码 String sql = "SELECT t FROM TestJPQL t WHERE id = ?"; Query setHint = entityManager.createQuery(sql); setHint.setParameter(1, 1); List resultList = setHint.getResultList(); System.out.println(...
关于jpa源码的初步了解
weixin_39654646的博客
12-21 747
关于jpa源码的初步了解jpa简介引入jpa基本概念源码debug总结扩展mybatis ,mybatis-plus 和 hibernate比较 jpa简介 Spring data JPA是Spring在ORM框架，以及JPA规范的基础上，封装的一套JPA应用框架，并提供了一整套的数据访问层解决方案。底层还是使用了 Hibernate 的 JPA 技术实现。 Hibernate是一个具体的ORM的...
【源码】Spring Data JPA原理解析之Repository自定义方法添加@Query注解的执行原理
最新发布
JingAi_jia917的博客
05-31 1303
本篇从源码角度分享Repository中自定义方法带@Query注解的接口的实现原理。重点分析了ExpressionBasedStringQuery、StringQuery和AbstractStringBasedJpaQuery的源码。
关于import org.springframework.data.*包找不到
yishengzhiaiyige的博客
07-12 911
关于import org.springframework.data.*包找不到，爆红
Spring学习笔记： Repository实现（一）
flyingpignj的博客
08-11 4092
在使用Spring的过程中， 可以定义自己的Repository接口，并不需要完成具体的实现，Spring会帮助创建具体的实例. 方法名应该遵循什么样的规则，Spring才能帮助实现呢。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值