【源码】Spring Data JPA原理解析之Repository自定义方法命名规则执行原理（二）

JingAi_jia917

已于 2024-07-05 08:51:27 修改

阅读量994

点赞数 27

文章标签： JPA Spring Data JPA JPA源码 Repository实现原理 Repository源码 Spring源码

于 2024-05-30 10:05:03 首次发布

本文链接：https://blog.csdn.net/JingAi_jia917/article/details/139272676

版权

Spring Data JPA系列

1、SpringBoot集成JPA及基本使用

2、Spring Data JPA Criteria查询、部分字段查询

3、Spring Data JPA数据批量插入、批量更新真的用对了吗

4、Spring Data JPA的一对一、LazyInitializationException异常、一对多、多对多操作

5、Spring Data JPA自定义Id生成策略、复合主键配置、Auditing使用

6、【源码】Spring Data JPA原理解析之Repository的自动注入（一）

7、【源码】Spring Data JPA原理解析之Repository的自动注入（二）

8、【源码】Spring Data JPA原理解析之Repository执行过程及SimpleJpaRepository源码

9、【源码】Spring Data JPA原理解析之Repository自定义方法命名规则执行原理（一）

10、【源码】Spring Data JPA原理解析之Repository自定义方法命名规则执行原理（二）

11、【源码】Spring Data JPA原理解析之Repository自定义方法添加@Query注解的执行原理

12、【源码】SpringBoot事务注册原理

13、【源码】Spring Data JPA原理解析之事务注册原理

14、【源码】Spring Data JPA原理解析之事务执行原理

15、【源码】SpringBoot编程式事务使用及执行原理

16、【源码】Spring事务之传播特性的详解

17、【源码】Spring事务之事务失效及原理

18、【源码】Spring Data JPA原理解析之Hibernate EventListener使用及原理

19、【源码】Spring Data JPA原理解析之Auditing执行原理

20、Spring Data JPA使用及实现原理总结

前言

上一篇限于篇幅，只分享了Repository自定义方法命名规则的方法在QueryExecutorMethodInterceptor的构造方法中，通过查询查找策略CreateIfNotFoundQueryLookupStrategy创建一个PartTreeJpaQuery对象。该对象解析方法名称的关键字、查询属性、查询关键字，封装成PartTree。而后将Method和PartTreeJpaQuery组合存放在QueryExecutorMethodInterceptor的Map<Method, RepositoryQuery> queries中。

本篇继续往下分享Repository自定义方法命名规则的方法是如何调用执行的。

方法调用拦截

【源码】Spring Data JPA原理解析之Repository的自动注入（二）-CSDN博客

上面博文分享了Repository bean的创建。Respository的bean是一个通过ProxyFactory创建的动态代理对象，该代理对象添加了QueryExecutorMethodInterceptor拦截器。

【源码】Spring Data JPA原理解析之Repository执行过程及SimpleJpaRepository源码-CSDN博客

博客中介绍了动态代理拦截，当Repository中的接口被调用的时候，会执行ReflectiveMethodInvocation.proceed()的方法，在该方法中，循环遍历所有的拦截器，执行拦截器的invoke(MethodInvocation invocation)方法。

所以会执行QueryExecutorMethodInterceptor.invoke()方法。QueryExecutorMethodInterceptor的相关代码如下：

package org.springframework.data.repository.core.support;

/**
 * 此MethodInterceptor拦截对自定义实现的方法的调用，当自定义的方法被调用时，会被该类拦截。
 * 此外，它还解析对finder的方法调用，并触发它们的执行。如果返回true，则可以依赖于设置自定义存储库实现实例。
 */
class QueryExecutorMethodInterceptor implements MethodInterceptor {

	// Repository信息，为DefaultRepositoryInformation对象。获取Repository信息，getRepositoryInformation()返回一个RepositoryInformation对象。
	// 如子类JpaRepositoryFactory，指定baseClass为SimpleJpaRepository.class
	private final RepositoryInformation repositoryInformation;
	// 方法缓存，key为方法，value为对应方法的查询解析信息
	private final Map<Method, RepositoryQuery> queries;
	// 方法调用缓存，key为方法，value为对应方法调用时要执行的执行器
	private final Map<Method, RepositoryMethodInvoker> invocationMetadataCache = new ConcurrentReferenceHashMap<>();
	// 查询执行结果处理器
	private final QueryExecutionResultHandler resultHandler;
	// 在实体类中添加@NamedQueries注解，配置相关查询信息，默认为空
	private final NamedQueries namedQueries;
	private final List<QueryCreationListener<?>> queryPostProcessors;
	private final RepositoryInvocationMulticaster invocationMulticaster;

    // 省略其他
	
	@Override
	@Nullable
	public Object invoke(@SuppressWarnings("null") MethodInvocation invocation) throws Throwable {

		Method method = invocation.getMethod();
		// 通过返回的返回值，获取执行适配器，默认都为null
		QueryExecutionConverters.ExecutionAdapter executionAdapter = QueryExecutionConverters //
				.getExecutionAdapter(method.getReturnType());

		if (executionAdapter == null) {
			return resultHandler.postProcessInvocationResult(doInvoke(invocation), method);
		}

		return executionAdapter //
				.apply(() -> resultHandler.postProcessInvocationResult(doInvoke(invocation), method));
	}

	@Nullable
	private Object doInvoke(MethodInvocation invocation) throws Throwable {

		Method method = invocation.getMethod();
		// 判断方法是否存在RepositoryQuery。在构造函数中，会解析Repository中的查询方法，并缓存到Map
		if (hasQueryFor(method)) {

			RepositoryMethodInvoker invocationMetadata = invocationMetadataCache.get(method);

			if (invocationMetadata == null) {
				// 首次执行对应方法，先创建一个RepositoryQueryMethodInvoker对象，保存方法即方法对应的RepositoryQuery
				invocationMetadata = RepositoryMethodInvoker.forRepositoryQuery(method, queries.get(method));
				// 加入缓存
				invocationMetadataCache.put(method, invocationMetadata);
			}
			// 获取方法所在的Repository类名、方法的参数值【invocation.getArguments()】，执行RepositoryQueryMethodInvoker.invoke()方法
			return invocationMetadata.invoke(repositoryInformation.getRepositoryInterface(), invocationMulticaster,
					invocation.getArguments());
		}
		// 如果能够处理该查询方法，则不执行invocation.proceed()，即结束拦截器链
		return invocation.proceed();
	}

	/**
	 * 判断是否为给定方法执行查询
	 */
	private boolean hasQueryFor(Method method) {
		return queries.containsKey(method);
	}

}

1.1 在QueryExecutorMethodInterceptor.invoke()中，核心功能如下：

1）执行doInvoke()方法，执行数据库相关操作，获取返回信息；

2）执行resultHandler.postProcessInvocationResult()，进行返回值类型转换；

1.2 在doInvoke()方法中，执行如下：

1）调用hasQueryFor()方法，判断当前方法是否有对应的RepositoryQuery对象。在上一篇博文中以及做了详细介绍，该对象是在QueryExecutorMethodInterceptor的构造方法中解析方法信息后封装的和查询相关的信息对象；

2）如果存在RepositoryQuery对象，则执行RepositoryMethodInvoker.forRepositoryQuery(method, queries.get(method))，创建一个RepositoryQueryMethodInvoker对象，然后执行RepositoryQueryMethodInvoker.invoke()方法；

3）如果不存在RepositoryQuery对象，则执行invocation.proceed()，执行ReflectiveMethodInvocation.proceed()方法，继续执行下一个拦截器或执行target的对应方法；

RepositoryQueryMethodInvoker

RepositoryQueryMethodInvoker查询方法回调类的核心代码如下：

abstract class RepositoryMethodInvoker {

	private final Method method;
	private final Class<?> returnedType;
	private final Invokable invokable;
	private final boolean suspendedDeclaredMethod;

	@SuppressWarnings("ReactiveStreamsUnusedPublisher")
	protected RepositoryMethodInvoker(Method method, Invokable invokable) {

		this.method = method;

		if (KotlinDetector.isKotlinReflectPresent()) {
			// 省略其他
		} else {
			this.suspendedDeclaredMethod = false;
			this.returnedType = method.getReturnType();
			this.invokable = invokable;
		}
	}

	static RepositoryQueryMethodInvoker forRepositoryQuery(Method declaredMethod, RepositoryQuery query) {
		return new RepositoryQueryMethodInvoker(declaredMethod, query);
	}
	
	@Nullable
	public Object invoke(Class<?> repositoryInterface, RepositoryInvocationMulticaster multicaster, Object[] args)
			throws Exception {
		return doInvoke(repositoryInterface, multicaster, args);
	}

	@Nullable
	private Object doInvoke(Class<?> repositoryInterface, RepositoryInvocationMulticaster multicaster, Object[] args)
			throws Exception {

		// 创建一个RepositoryMethodInvocationCaptor对象
		RepositoryMethodInvocationCaptor invocationResultCaptor = RepositoryMethodInvocationCaptor
				.captureInvocationOn(repositoryInterface);

		try {
			// 执行对应方法的RepositoryQuery的execute方法
			Object result = invokable.invoke(args);

			if (result != null && ReactiveWrappers.supports(result.getClass())) {
				return new ReactiveInvocationListenerDecorator().decorate(repositoryInterface, multicaster, args, result);
			}

			if (result instanceof Stream) {
				return ((Stream<?>) result).onClose(
						() -> multicaster.notifyListeners(method, args, computeInvocationResult(invocationResultCaptor.success())));
			}
			// 执行结果通知。回调RepositoryMethodInvocationListener.afterInvocation()
			multicaster.notifyListeners(method, args, computeInvocationResult(invocationResultCaptor.success()));

			return result;
		} catch (Exception e) {
			multicaster.notifyListeners(method, args, computeInvocationResult(invocationResultCaptor.error(e)));
			throw e;
		}
	}

	private RepositoryMethodInvocation computeInvocationResult(RepositoryMethodInvocationCaptor captured) {
		return new RepositoryMethodInvocation(captured.getRepositoryInterface(), method, captured.getCapturedResult(),
				captured.getDuration());
	}

	interface Invokable {

		@Nullable
		Object invoke(Object[] args) throws Exception;
	}

	private static class RepositoryQueryMethodInvoker extends RepositoryMethodInvoker {
		public RepositoryQueryMethodInvoker(Method method, RepositoryQuery repositoryQuery) {
			// repositoryQuery::execute方法回调声明作为参数赋值给invokable，当执行invokable.invoke()时，
			// 执行repositoryQuery.execute()方法
			super(method, repositoryQuery::execute);
		}
	}
	// 省略其他
}

RepositoryQueryMethodInvoker是私有静态内部类，父类为RepositoryMethodInvoker。

在上面讲解的1.2的2）中，通过RepositoryMethodInvoker.forRepositoryQuery(method, queries.get(method))，创建一个RepositoryQueryMethodInvoker对象，将repositoryQuery::execute方法回调声明作为参数赋值给invokable。

当执行RepositoryQueryMethodInvoker.invoke()时，执行doInvoke()方法，该方法执行如下：

1）创建一个RepositoryMethodInvocationCaptor对象；

2）执行invokable.invoke()，即执行对应方法的RepositoryQuery的execute方法，执行数据库操作；

RepositoryQuery.execute() -> AbstractJpaQuery.execute() -> AbstractJpaQuery.doExecute() -> JpaQueryExecution.execute() -> JpaQueryExecution.doExecute()。

3）执行结果通知。回调RepositoryMethodInvocationListener.afterInvocation()；

4）返回2）中的返回值；

第2）中调用的JpaQueryExecution.doExecute()是一个抽象方法，实现类如下：

针对数据库表操作后不同的返回值信息，使用不同的实现类，且实现类都是JpaQueryExecution的内部类。以下以SingleEntityExecution为例。

public abstract class JpaQueryExecution {
    static class SingleEntityExecution extends JpaQueryExecution {

		@Override
		protected Object doExecute(AbstractJpaQuery query, JpaParametersParameterAccessor accessor) {

			return query.createQuery(accessor).getSingleResult();
		}
	}
}

执行AbstractJpaQuery.createQuery()，获取一个Query对象，最后调用Query.getSingleResult()，返回一个查询执行结果。其他的实现类处理类似，只是最后调用Query的不同方法，从数据库中查询不同的结果值。

AbstractJpaQuery

AbstractJpaQuery的相关代码如下：

/**
 * 记录Repository中每个方法解析后的信息
 */
public abstract class AbstractJpaQuery implements RepositoryQuery {

	private final JpaQueryMethod method;
	private final EntityManager em;
	private final JpaMetamodel metamodel;
	// 根据EntityManager，返回PersistenceProvider。PersistenceProvider是枚举类型，有HIBERNATE、ECLIPSELINK、GENERIC_JPA。
	// 不同的PersistenceProvider，extractQueryString、getIdentifierFrom等方式不一样
	private final PersistenceProvider provider;
	// 根据查询方法的返回值，使用不同的执行器
	private final Lazy<JpaQueryExecution> execution;
	// 参数绑定器
	final Lazy<ParameterBinder> parameterBinder = Lazy.of(this::createBinder);

	@Nullable
	@Override
	public Object execute(Object[] parameters) {
		return doExecute(getExecution(), parameters);
	}

	/**
	 * 执行查询
	 * @param execution 执行器。主要根据方法的返回值确定的执行器
	 * @param values 方法执行时的参数值
	 * @return
	 */
	@Nullable
	private Object doExecute(JpaQueryExecution execution, Object[] values) {
		// 创建一个JpaParametersParameterAccessor对象，保存方法的参数信息及本次查询的参数值
		JpaParametersParameterAccessor accessor = obtainParameterAccessor(values);
		// 执行数据库查询，获取返回值
		Object result = execution.execute(this, accessor);

		ResultProcessor withDynamicProjection = method.getResultProcessor().withDynamicProjection(accessor);
		return withDynamicProjection.processResult(result, new TupleConverter(withDynamicProjection.getReturnedType()));
	}

	private JpaParametersParameterAccessor obtainParameterAccessor(Object[] values) {

		if (method.isNativeQuery() && PersistenceProvider.HIBERNATE.equals(provider)) {
			return new HibernateJpaParametersParameterAccessor(method.getParameters(), values, em);
		}

		return new JpaParametersParameterAccessor(method.getParameters(), values);
	}

	/**
	 * 获取方法对应的查询执行器
	 */
	protected JpaQueryExecution getExecution() {

		// 获取根据返回值确定的查询的执行器
		JpaQueryExecution execution = this.execution.getNullable();

		if (execution != null) {
			return execution;
		}
		// 如果添加了@Modify注解，则返回
		if (method.isModifyingQuery()) {
			return new ModifyingExecution(method, em);
		}
		// 否则返回单个实体类的执行器
		return new SingleEntityExecution();
	}

	/**
	 * 为query添加定义的查询hint信息。方法中添加@QueryHints注解
	 */
	protected <T extends Query> T applyHints(T query, JpaQueryMethod method) {

		List<QueryHint> hints = method.getHints();

		if (!hints.isEmpty()) {
			for (QueryHint hint : hints) {
				applyQueryHint(query, hint);
			}
		}

		// Apply any meta-attributes that exist
		if (method.hasQueryMetaAttributes()) {

			if (provider.getCommentHintKey() != null) {
				query.setHint( //
						provider.getCommentHintKey(), provider.getCommentHintValue(method.getQueryMetaAttributes().getComment()));
			}
		}

		return query;
	}

	protected <T extends Query> void applyQueryHint(T query, QueryHint hint) {

		Assert.notNull(query, "Query must not be null");
		Assert.notNull(hint, "QueryHint must not be null");

		query.setHint(hint.name(), hint.value());
	}

	/**
	 * 为query应用锁模式
	 */
	private Query applyLockMode(Query query, JpaQueryMethod method) {

		LockModeType lockModeType = method.getLockModeType();
		return lockModeType == null ? query : query.setLockMode(lockModeType);
	}

	protected Query createQuery(JpaParametersParameterAccessor parameters) {
		return applyLockMode(applyEntityGraphConfiguration(applyHints(doCreateQuery(parameters), method), method), method);
	}

	/**
	 * 如果方法添加@EntityGraph注解，在query中添加对应的Hint
	 * @param query
	 * @param method
	 * @return
	 */
	private Query applyEntityGraphConfiguration(Query query, JpaQueryMethod method) {

		JpaEntityGraph entityGraph = method.getEntityGraph();

		if (entityGraph != null) {
			QueryHints hints = Jpa21Utils.getFetchGraphHint(em, method.getEntityGraph(),
					getQueryMethod().getEntityInformation().getJavaType());

			hints.forEach(query::setHint);
		}

		return query;
	}


	/**
	 * 为查询创建一个Query，并调用query.setParameter()设置参数值及分页信息
	 */
	protected abstract Query doCreateQuery(JpaParametersParameterAccessor accessor);

	// 省略其他
}

在createQuery()方法中，执行如下：

1）调用抽象方法doCreateQuery()，获取一个Query；

对于自定义方法命名规则的方法，实现在PartTreeJpaQuery类。

2）执行applyHints()，在query中添加对应的Hint；

3）执行applyEntityGraphConfiguration()，如果方法添加@EntityGraph注解，在query中添加对应的Hint；

4）执行applyLockMode()，为query应用锁模式；

PartTreeJpaQuery

PartTreeJpaQuery的相关代码如下：

package org.springframework.data.jpa.repository.query;

/**
 * 保存了方法信息，包括方法、方法参数、方法名称解析后的Part树、对应的查询query、查询计数countQuery等信息
 */
public class PartTreeJpaQuery extends AbstractJpaQuery {

	private final PartTree tree;
	private final JpaParameters parameters;

	private final QueryPreparer query;
	private final QueryPreparer countQuery;
	private final EntityManager em;
	private final EscapeCharacter escape;
	private final JpaMetamodelEntityInformation<?, Object> entityInformation;

	/**
	 * 为查询创建一个Query，并调用query.setParameter()设置参数值及分页信息
	 */
	@Override
	public Query doCreateQuery(JpaParametersParameterAccessor accessor) {
		return query.createQuery(accessor);
	}

	@Override
	@SuppressWarnings("unchecked")
	public TypedQuery<Long> doCreateCountQuery(JpaParametersParameterAccessor accessor) {
		return (TypedQuery<Long>) countQuery.createQuery(accessor);
	}

	private class QueryPreparer {
		// 缓存创建的对象
		private final @Nullable CriteriaQuery<?> cachedCriteriaQuery;
		private final @Nullable ParameterBinder cachedParameterBinder;
		private final QueryParameterSetter.QueryMetadataCache metadataCache = new QueryParameterSetter.QueryMetadataCache();

		QueryPreparer(boolean recreateQueries) {

			JpaQueryCreator creator = createCreator(null);

			if (recreateQueries) {
				this.cachedCriteriaQuery = null;
				this.cachedParameterBinder = null;
			} else {
				// 子类CountQueryPreparer的createQuery()，执行JpaCountQueryCreator重写的complete()方法，
				// 执行query.select()，select为builder.count()，并加上predicate条件信息
				this.cachedCriteriaQuery = creator.createQuery();
				this.cachedParameterBinder = getBinder(creator.getParameterExpressions());
			}
		}

		/**
		 * 为查询创建一个Query，并调用query.setParameter()设置参数值及分页信息
		 */
		public Query createQuery(JpaParametersParameterAccessor accessor) {

			CriteriaQuery<?> criteriaQuery = cachedCriteriaQuery;
			ParameterBinder parameterBinder = cachedParameterBinder;

			if (cachedCriteriaQuery == null || accessor.hasBindableNullValue()) {
				JpaQueryCreator creator = createCreator(accessor);
				criteriaQuery = creator.createQuery(getDynamicSort(accessor));
				List<ParameterMetadata<?>> expressions = creator.getParameterExpressions();
				parameterBinder = getBinder(expressions);
			}

			if (parameterBinder == null) {
				throw new IllegalStateException("ParameterBinder is null");
			}

			// 通过EntityManager.createQuery(criteriaQuery)，返回TypedQuery
			TypedQuery<?> query = createQuery(criteriaQuery);

			ScrollPosition scrollPosition = accessor.getParameters().hasScrollPositionParameter()
					? accessor.getScrollPosition()
					: null;
			// 调用invokeBinding()执行query.setParameter()方法，设置查询的条件参数值，如果有分页，设置分页信息
			// 如果有需要，设置返回最大值信息
			return restrictMaxResultsIfNecessary(invokeBinding(parameterBinder, query, accessor, this.metadataCache),
					scrollPosition);
		}

		@SuppressWarnings("ConstantConditions")
		private Query restrictMaxResultsIfNecessary(Query query, @Nullable ScrollPosition scrollPosition) {

			if (scrollPosition instanceof OffsetScrollPosition offset && !offset.isInitial()) {
				query.setFirstResult(Math.toIntExact(offset.getOffset()) + 1);
			}

			if (tree.isLimiting()) {

				if (query.getMaxResults() != Integer.MAX_VALUE) {
					if (query.getMaxResults() > tree.getMaxResults() && query.getFirstResult() > 0) {
						query.setFirstResult(query.getFirstResult() - (query.getMaxResults() - tree.getMaxResults()));
					}
				}

				query.setMaxResults(tree.getMaxResults());
			}

			if (tree.isExistsProjection()) {
				query.setMaxResults(1);
			}

			return query;
		}

		/**
		 * 通过EntityManager.createQuery(criteriaQuery)，返回TypedQuery
		 */
		private TypedQuery<?> createQuery(CriteriaQuery<?> criteriaQuery) {

			if (this.cachedCriteriaQuery != null) {
				synchronized (this.cachedCriteriaQuery) {
					return getEntityManager().createQuery(criteriaQuery);
				}
			}

			return getEntityManager().createQuery(criteriaQuery);
		}

		protected JpaQueryCreator createCreator(@Nullable JpaParametersParameterAccessor accessor) {

			EntityManager entityManager = getEntityManager();

			CriteriaBuilder builder = entityManager.getCriteriaBuilder();
			ResultProcessor processor = getQueryMethod().getResultProcessor();

			ParameterMetadataProvider provider;
			ReturnedType returnedType;

			if (accessor != null) {
				provider = new ParameterMetadataProvider(builder, accessor, escape);
				returnedType = processor.withDynamicProjection(accessor).getReturnedType();
			} else {
				provider = new ParameterMetadataProvider(builder, parameters, escape);
				returnedType = processor.getReturnedType();
			}

			if (accessor != null && accessor.getScrollPosition() instanceof KeysetScrollPosition keyset) {
				return new JpaKeysetScrollQueryCreator(tree, returnedType, builder, provider, entityInformation, keyset);
			}

			return new JpaQueryCreator(tree, returnedType, builder, provider);
		}

		/**
		 * 调用query.setParameter()方法，设置查询的条件参数值，如果有分页，设置分页信息
		 */
		protected Query invokeBinding(ParameterBinder binder, TypedQuery<?> query, JpaParametersParameterAccessor accessor,
				QueryParameterSetter.QueryMetadataCache metadataCache) {

			// 将query查询添加到缓存
			QueryParameterSetter.QueryMetadata metadata = metadataCache.getMetadata("query", query);

			return binder.bindAndPrepare(query, metadata, accessor);
		}

		private ParameterBinder getBinder(List<ParameterMetadata<?>> expressions) {
			return ParameterBinderFactory.createCriteriaBinder(parameters, expressions);
		}

		private Sort getDynamicSort(JpaParametersParameterAccessor accessor) {

			return parameters.potentiallySortsDynamically() //
					? accessor.getSort() //
					: Sort.unsorted();
		}
	}

	private class CountQueryPreparer extends QueryPreparer {

		CountQueryPreparer(boolean recreateQueries) {
			super(recreateQueries);
		}

		/**
		 * 创建一个JpaCountQueryCreator
		 */
		@Override
		protected JpaQueryCreator createCreator(@Nullable JpaParametersParameterAccessor accessor) {

			EntityManager entityManager = getEntityManager();
			CriteriaBuilder builder = entityManager.getCriteriaBuilder();

			ParameterMetadataProvider provider;

			if (accessor != null) {
				provider = new ParameterMetadataProvider(builder, accessor, escape);
			} else {
				provider = new ParameterMetadataProvider(builder, parameters, escape);
			}

			return new JpaCountQueryCreator(tree, getQueryMethod().getResultProcessor().getReturnedType(), builder, provider);
		}

		@Override
		protected Query invokeBinding(ParameterBinder binder, TypedQuery<?> query, JpaParametersParameterAccessor accessor,
				QueryParameterSetter.QueryMetadataCache metadataCache) {

			QueryParameterSetter.QueryMetadata metadata = metadataCache.getMetadata("countquery", query);

			return binder.bind(query, metadata, accessor);
		}
	}
}

1）在PartTreeJpaQuery.doCreateQuery()方法，执行QueryPreparer.createQuery()方法。

2）QueryPreparer.createQuery()方法先调用createQuery()，执行如下：

2.1）通过EntityManager.createQuery(criteriaQuery)，返回TypedQuery；

2.2）执行invokeBinding()，在TypedQuery对象中，调用query.setParameter()绑定查询条件的参数值，如果有分页，设置分页信息；

通过执行ParameterBinder.bindAndPrepare()方法，调用query.setParameter()绑定查询条件的参数值，如果有分页，设置分页信息。

2.3）执行restrictMaxResultsIfNecessary()，如果有需要，设置返回最大值信息；

ParameterBinder

ParameterBinder的代码如下：

package org.springframework.data.jpa.repository.query;

/**
 * ParameterBinder用于将方法参数绑定到Query。通常在执行AbstractJpaQuery时执行。
 */
public class ParameterBinder {

	static final String PARAMETER_NEEDS_TO_BE_NAMED = "For queries with named parameters you need to provide names for method parameters; Use @Param for query method parameters, or when on Java 8+ use the javac flag -parameters";

	private final JpaParameters parameters;
	// 查询方法对应的参数设置器
	private final Iterable<QueryParameterSetter> parameterSetters;
	private final boolean useJpaForPaging;

	ParameterBinder(JpaParameters parameters, Iterable<QueryParameterSetter> parameterSetters) {
		this(parameters, parameterSetters, true);
	}

	public ParameterBinder(JpaParameters parameters, Iterable<QueryParameterSetter> parameterSetters,
			boolean useJpaForPaging) {

		Assert.notNull(parameters, "JpaParameters must not be null");
		Assert.notNull(parameterSetters, "Parameter setters must not be null");

		this.parameters = parameters;
		this.parameterSetters = parameterSetters;
		this.useJpaForPaging = useJpaForPaging;
	}

	public <T extends Query> T bind(T jpaQuery, QueryParameterSetter.QueryMetadata metadata,
			JpaParametersParameterAccessor accessor) {
		// 绑定参数值
		bind(metadata.withQuery(jpaQuery), accessor, ErrorHandling.STRICT);
		return jpaQuery;
	}

	public void bind(QueryParameterSetter.BindableQuery query, JpaParametersParameterAccessor accessor,
			ErrorHandling errorHandling) {
		// 遍历方法的参数设置器，调用QueryParameterSetter.setParameter() -> query.setParameter()为查询语句赋值
		for (QueryParameterSetter setter : parameterSetters) {
			setter.setParameter(query, accessor, errorHandling);
		}
	}

	Query bindAndPrepare(Query query, QueryParameterSetter.QueryMetadata metadata,
			JpaParametersParameterAccessor accessor) {
		// 绑定参数。调用query.setParameter()，为查询赋值
		bind(query, metadata, accessor);

		// 如果没有分页，直接返回
		if (!useJpaForPaging || !parameters.hasLimitingParameters() || accessor.getPageable().isUnpaged()) {
			return query;
		}

		// 设置分页信息
		query.setFirstResult(PageableUtils.getOffsetAsInteger(accessor.getPageable()));
		query.setMaxResults(accessor.getPageable().getPageSize());

		return query;
	}
}

小结

限于篇幅，本篇先分享到这里。结合上一篇【源码】Spring Data JPA原理解析之Repository自定义方法命名规则执行原理（一）一起做一个小结：

1）Repository的代理类中，会添加QueryExecutorMethodInterceptor方法拦截器；

2）QueryExecutorMethodInterceptor方法拦截器的构造方法中，会根据查询查找策略CreateIfNotFoundQueryLookupStrategy，获得RepositoryQuery对象，解析方法。对于按方法命名规则实现的方法，使用的RepositoryQuery对象为PartTreeJpaQuery；

3）在PartTreeJpaQuery构造方法中，创建一个PartTree对象，解析方法名称中的起始关键字【如：findBy、readBy、deleteBy等】、条件属性【实体类中的属性】、查询关键字【Between、In、Equals等】；

4）创建对应方法的countQuery和query，将解析出的查询的基础信息封装在QueryPreparer对象中，根据解析出的查询信息，创建CriteriaQuery对象；

5）解析完方法信息，保存在PartTreeJpaQuery后，保存到QueryExecutorMethodInterceptor的Map<Method, RepositoryQuery> queries中；

6）当Repository的接口被调用的时候，在ReflectiveMethodInvocation.proceed()中，先执行QueryExecutorMethodInterceptor.invoke()方法；

6.1）调用doInvoke()方法，获取数据库执行后的数据；

6.1.1）调用RepositoryQueryMethodInvoker.invoke() -> RepositoryQuery.execute() -> AbstractJpaQuery.execute() -> AbstractJpaQuery.doExecute() -> JpaQueryExecution.execute() -> JpaQueryExecution.doExecute()；

6.1.2）doExecute()是一个抽象方法，针对不同的数据库查询返回值信息，使用不同的实现类。所有的实现类都会先调用AbstractJpaQuery.createQuery()，获取一个Query对象；

6.1.3）在AbstractJpaQuery.createQuery()中，调用抽象方法doCreateQuery()。对于按方法命名规则的Repository接口，实现类为PartTreeJpaQuery；

6.1.4）在PartTreeJpaQuery.coCreateQuery()方法中，通过EntityManager.createQuery(criteriaQuery)返回TypedQuery，然后执行invokeBinding()，在TypedQuery对象中，调用query.setParameter()绑定查询条件的参数值，如果有分页，设置分页信息；

6.1.5）参数完参数，在6.1.3中设置hint等。然后执行6.1.2中的具体实现类，执行数据库查询。如SingleEntityExecution实现类，执行TypeQuery.getSingleResult()，然后单个结果；

6.2）调用resultHandler.postProcessInvocationResult()，对数据库查询后的值进行返回值类型转换；

关于本篇内容你有什么自己的想法或独到见解，欢迎在评论区一起交流探讨下吧。

JingAi_jia917

关注

27
点赞
踩
29

收藏

觉得还不错? 一键收藏
0
评论
【源码】Spring Data JPA原理解析之Repository自定义方法命名规则执行原理（二）

本篇继上一篇的Repository自定义命名规则的方法名称解析，从源码角度分享了方法调用时，如何实现数据库访问过程。重点分析了QueryExecutorMethodInterceptor、RepositoryQueryMethodInvoker、AbstractJpaQuery、PartTreeJpaQuery、ParameterBinder的源码
复制链接

扫一扫