Skip to content

Commit 0086b38

Browse files
mp911demp911de
committed
Polishing.
Migrate configuration setters for repository instances into JpaRepositoryConfigurationAware interface. Revert ProjectionFactory propagation through CrudMethodMetadata. Original pull request: #3432 See: #3410
1 parent 0af9c62 commit 0086b38

File tree

11 files changed

+125
-91
lines changed

11 files changed

+125
-91
lines changed

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/CrudMethodMetadata.java‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
import java.util.Optional;
2222

2323
import org.springframework.data.jpa.repository.EntityGraph;
24-
import org.springframework.data.projection.ProjectionFactory;
2524
import org.springframework.lang.Nullable;
2625

2726
/**
@@ -87,10 +86,4 @@ public interface CrudMethodMetadata {
8786
*/
8887
Method getMethod();
8988

90-
/**
91-
* @return the {@link ProjectionFactory} to use or {@literal null} if not present.
92-
* @since ??
93-
*/
94-
@Nullable
95-
ProjectionFactory getProjectionFactory();
9689
}

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/CrudMethodMetadataPostProcessor.java‎

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
import java.util.concurrent.ConcurrentHashMap;
2626
import java.util.concurrent.ConcurrentMap;
2727
import java.util.function.Predicate;
28-
import java.util.function.Supplier;
2928

3029
import org.aopalliance.intercept.MethodInterceptor;
3130
import org.aopalliance.intercept.MethodInvocation;
31+
3232
import org.springframework.aop.TargetSource;
3333
import org.springframework.aop.framework.ProxyFactory;
3434
import org.springframework.beans.factory.BeanClassLoaderAware;
@@ -39,7 +39,6 @@
3939
import org.springframework.data.jpa.repository.Lock;
4040
import org.springframework.data.jpa.repository.Meta;
4141
import org.springframework.data.jpa.repository.QueryHints;
42-
import org.springframework.data.projection.ProjectionFactory;
4342
import org.springframework.data.repository.core.RepositoryInformation;
4443
import org.springframework.data.repository.core.support.RepositoryProxyPostProcessor;
4544
import org.springframework.lang.Nullable;
@@ -63,11 +62,6 @@
6362
class CrudMethodMetadataPostProcessor implements RepositoryProxyPostProcessor, BeanClassLoaderAware {
6463

6564
private @Nullable ClassLoader classLoader = ClassUtils.getDefaultClassLoader();
66-
private final Supplier<ProjectionFactory> projectionFactorySupplier;
67-
68-
CrudMethodMetadataPostProcessor(Supplier<ProjectionFactory> projectionFactorySupplier) {
69-
this.projectionFactorySupplier = projectionFactorySupplier;
70-
}
7165

7266
@Override
7367
public void setBeanClassLoader(ClassLoader classLoader) {
@@ -76,8 +70,7 @@ public void setBeanClassLoader(ClassLoader classLoader) {
7670

7771
@Override
7872
public void postProcess(ProxyFactory factory, RepositoryInformation repositoryInformation) {
79-
factory
80-
.addAdvice(new CrudMethodMetadataPopulatingMethodInterceptor(repositoryInformation, projectionFactorySupplier));
73+
factory.addAdvice(new CrudMethodMetadataPopulatingMethodInterceptor(repositoryInformation));
8174
}
8275

8376
/**
@@ -109,14 +102,11 @@ static class CrudMethodMetadataPopulatingMethodInterceptor implements MethodInte
109102

110103
private final ConcurrentMap<Method, CrudMethodMetadata> metadataCache = new ConcurrentHashMap<>();
111104
private final Set<Method> implementations = new HashSet<>();
112-
private final Supplier<ProjectionFactory> projectionFactory;
113105

114-
CrudMethodMetadataPopulatingMethodInterceptor(RepositoryInformation repositoryInformation,
115-
Supplier<ProjectionFactory> projectionFactory) {
106+
CrudMethodMetadataPopulatingMethodInterceptor(RepositoryInformation repositoryInformation) {
116107

117108
ReflectionUtils.doWithMethods(repositoryInformation.getRepositoryInterface(), implementations::add,
118109
method -> !repositoryInformation.isQueryMethod(method));
119-
this.projectionFactory = projectionFactory;
120110
}
121111

122112
/**
@@ -161,7 +151,7 @@ public Object invoke(MethodInvocation invocation) throws Throwable {
161151

162152
if (methodMetadata == null) {
163153

164-
methodMetadata = new DefaultCrudMethodMetadata(method, projectionFactory.get());
154+
methodMetadata = new DefaultCrudMethodMetadata(method);
165155
CrudMethodMetadata tmp = metadataCache.putIfAbsent(method, methodMetadata);
166156

167157
if (tmp != null) {
@@ -196,17 +186,15 @@ private static class DefaultCrudMethodMetadata implements CrudMethodMetadata {
196186
private final @Nullable String comment;
197187
private final Optional<EntityGraph> entityGraph;
198188
private final Method method;
199-
private ProjectionFactory projectionFactory;
200189

201190
/**
202191
* Creates a new {@link DefaultCrudMethodMetadata} for the given {@link Method}.
203192
*
204193
* @param method must not be {@literal null}.
205194
*/
206-
DefaultCrudMethodMetadata(Method method, ProjectionFactory projectionFactory) {
195+
DefaultCrudMethodMetadata(Method method) {
207196

208197
Assert.notNull(method, "Method must not be null");
209-
this.projectionFactory = projectionFactory;
210198

211199
this.lockModeType = findLockModeType(method);
212200
this.queryHints = findQueryHints(method, it -> true);
@@ -288,10 +276,6 @@ public Method getMethod() {
288276
return method;
289277
}
290278

291-
@Override
292-
public ProjectionFactory getProjectionFactory() {
293-
return projectionFactory;
294-
}
295279
}
296280

297281
private static class ThreadBoundTargetSource implements TargetSource {

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/FetchableFluentQueryByPredicate.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,7 @@ public FetchableFluentQuery<R> sortBy(Sort sort) {
9696
Assert.notNull(sort, "Sort must not be null");
9797

9898
return new FetchableFluentQueryByPredicate<>(predicate, entityType, resultType, this.sort.and(sort), limit,
99-
properties, finder, scroll, pagedFinder, countOperation, existsOperation, entityManager,
100-
getProjectionFactory());
99+
properties, finder, scroll, pagedFinder, countOperation, existsOperation, entityManager, projectionFactory);
101100
}
102101

103102
@Override
@@ -106,7 +105,7 @@ public FetchableFluentQuery<R> limit(int limit) {
106105
Assert.isTrue(limit >= 0, "Limit must not be negative");
107106

108107
return new FetchableFluentQueryByPredicate<>(predicate, entityType, resultType, sort, limit, properties, finder,
109-
scroll, pagedFinder, countOperation, existsOperation, entityManager, getProjectionFactory());
108+
scroll, pagedFinder, countOperation, existsOperation, entityManager, projectionFactory);
110109
}
111110

112111
@Override
@@ -119,15 +118,15 @@ public <NR> FetchableFluentQuery<NR> as(Class<NR> resultType) {
119118
}
120119

121120
return new FetchableFluentQueryByPredicate<>(predicate, entityType, resultType, sort, limit, properties, finder,
122-
scroll, pagedFinder, countOperation, existsOperation, entityManager, getProjectionFactory());
121+
scroll, pagedFinder, countOperation, existsOperation, entityManager, projectionFactory);
123122
}
124123

125124
@Override
126125
public FetchableFluentQuery<R> project(Collection<String> properties) {
127126

128127
return new FetchableFluentQueryByPredicate<>(predicate, entityType, resultType, sort, limit,
129128
mergeProperties(properties), finder, scroll, pagedFinder, countOperation, existsOperation, entityManager,
130-
getProjectionFactory());
129+
projectionFactory);
131130
}
132131

133132
@Override

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/FetchableFluentQueryBySpecification.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public FetchableFluentQuery<R> sortBy(Sort sort) {
9090
Assert.notNull(sort, "Sort must not be null");
9191

9292
return new FetchableFluentQueryBySpecification<>(spec, entityType, resultType, this.sort.and(sort), limit,
93-
properties, finder, scroll, countOperation, existsOperation, entityManager, getProjectionFactory());
93+
properties, finder, scroll, countOperation, existsOperation, entityManager, projectionFactory);
9494
}
9595

9696
@Override
@@ -99,7 +99,7 @@ public FetchableFluentQuery<R> limit(int limit) {
9999
Assert.isTrue(limit >= 0, "Limit must not be negative");
100100

101101
return new FetchableFluentQueryBySpecification<>(spec, entityType, resultType, this.sort.and(sort), limit,
102-
properties, finder, scroll, countOperation, existsOperation, entityManager, getProjectionFactory());
102+
properties, finder, scroll, countOperation, existsOperation, entityManager, projectionFactory);
103103
}
104104

105105
@Override
@@ -111,14 +111,14 @@ public <NR> FetchableFluentQuery<NR> as(Class<NR> resultType) {
111111
}
112112

113113
return new FetchableFluentQueryBySpecification<>(spec, entityType, resultType, sort, limit, properties, finder,
114-
scroll, countOperation, existsOperation, entityManager, getProjectionFactory());
114+
scroll, countOperation, existsOperation, entityManager, projectionFactory);
115115
}
116116

117117
@Override
118118
public FetchableFluentQuery<R> project(Collection<String> properties) {
119119

120120
return new FetchableFluentQueryBySpecification<>(spec, entityType, resultType, sort, limit, properties, finder,
121-
scroll, countOperation, existsOperation, entityManager, getProjectionFactory());
121+
scroll, countOperation, existsOperation, entityManager, projectionFactory);
122122
}
123123

124124
@Override

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/FluentQuerySupport.java‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import org.springframework.data.domain.ScrollPosition;
2828
import org.springframework.data.domain.Sort;
2929
import org.springframework.data.projection.ProjectionFactory;
30-
import org.springframework.data.projection.SpelAwareProxyProjectionFactory;
3130
import org.springframework.lang.Nullable;
3231

3332
/**
@@ -47,8 +46,7 @@ abstract class FluentQuerySupport<S, R> {
4746
protected final int limit;
4847
protected final Set<String> properties;
4948
protected final Class<S> entityType;
50-
51-
private final ProjectionFactory projectionFactory;
49+
protected final ProjectionFactory projectionFactory;
5250

5351
FluentQuerySupport(Class<R> resultType, Sort sort, int limit, @Nullable Collection<String> properties,
5452
Class<S> entityType, ProjectionFactory projectionFactory) {
@@ -67,10 +65,6 @@ abstract class FluentQuerySupport<S, R> {
6765
this.projectionFactory = projectionFactory;
6866
}
6967

70-
ProjectionFactory getProjectionFactory() {
71-
return projectionFactory;
72-
}
73-
7468
final Collection<String> mergeProperties(Collection<String> additionalProperties) {
7569

7670
Set<String> newProperties = new HashSet<>();

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/JpaRepositoryConfigurationAware.java‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/*
2+
* Copyright 2024 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.data.jpa.repository.support;
17+
18+
import org.springframework.data.jpa.repository.query.EscapeCharacter;
19+
import org.springframework.data.projection.ProjectionFactory;
20+
21+
/**
22+
* Interface to be implemented by classes that want to be aware of their configuration in a JPA repository context.
23+
*
24+
* @author Mark Paluch
25+
* @since 3.3
26+
*/
27+
public interface JpaRepositoryConfigurationAware {
28+
29+
/**
30+
* Configures the {@link EscapeCharacter} to be used with the repository.
31+
*
32+
* @param escapeCharacter must not be {@literal null}.
33+
*/
34+
default void setEscapeCharacter(EscapeCharacter escapeCharacter) {
35+
36+
}
37+
38+
/**
39+
* Configures the {@link ProjectionFactory} to be used with the repository.
40+
*
41+
* @param projectionFactory must not be {@literal null}.
42+
*/
43+
default void setProjectionFactory(ProjectionFactory projectionFactory) {
44+
45+
}
46+
47+
/**
48+
* Configures the {@link CrudMethodMetadata} to be used with the repository.
49+
*
50+
* @param metadata must not be {@literal null}.
51+
*/
52+
default void setRepositoryMethodMetadata(CrudMethodMetadata metadata) {
53+
54+
}
55+
}

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/JpaRepositoryFactory.java‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ public class JpaRepositoryFactory extends RepositoryFactorySupport {
8383
private final EntityManager entityManager;
8484
private final QueryExtractor extractor;
8585
private final CrudMethodMetadataPostProcessor crudMethodMetadataPostProcessor;
86+
private final CrudMethodMetadata crudMethodMetadata;
8687

8788
private EntityPathResolver entityPathResolver;
8889
private EscapeCharacter escapeCharacter = EscapeCharacter.DEFAULT;
@@ -100,7 +101,7 @@ public JpaRepositoryFactory(EntityManager entityManager) {
100101

101102
this.entityManager = entityManager;
102103
this.extractor = PersistenceProvider.fromEntityManager(entityManager);
103-
this.crudMethodMetadataPostProcessor = new CrudMethodMetadataPostProcessor(() -> getProjectionFactory());
104+
this.crudMethodMetadataPostProcessor = new CrudMethodMetadataPostProcessor();
104105
this.entityPathResolver = SimpleEntityPathResolver.INSTANCE;
105106
this.queryMethodFactory = new DefaultJpaQueryMethodFactory(extractor);
106107
this.queryRewriterProvider = QueryRewriterProvider.simple();
@@ -116,6 +117,8 @@ public JpaRepositoryFactory(EntityManager entityManager) {
116117
if (extractor.equals(PersistenceProvider.ECLIPSELINK)) {
117118
addQueryCreationListener(new EclipseLinkProjectionQueryCreationListener(entityManager));
118119
}
120+
121+
this.crudMethodMetadata = crudMethodMetadataPostProcessor.getCrudMethodMetadata();
119122
}
120123

121124
@Override
@@ -192,8 +195,8 @@ public void setQueryRewriterProvider(QueryRewriterProvider queryRewriterProvider
192195
protected final JpaRepositoryImplementation<?, ?> getTargetRepository(RepositoryInformation information) {
193196

194197
JpaRepositoryImplementation<?, ?> repository = getTargetRepository(information, entityManager);
195-
repository.setRepositoryMethodMetadata(crudMethodMetadataPostProcessor.getCrudMethodMetadata());
196-
repository.setEscapeCharacter(escapeCharacter);
198+
199+
invokeAwareMethods(repository);
197200

198201
return repository;
199202
}
@@ -249,8 +252,7 @@ public <T, ID> JpaEntityInformation<T, ID> getEntityInformation(Class<T> domainC
249252
@Override
250253
protected RepositoryFragments getRepositoryFragments(RepositoryMetadata metadata) {
251254

252-
return getRepositoryFragments(metadata, entityManager, entityPathResolver,
253-
crudMethodMetadataPostProcessor.getCrudMethodMetadata());
255+
return getRepositoryFragments(metadata, entityManager, entityPathResolver, this.crudMethodMetadata);
254256
}
255257

256258
/**
@@ -279,13 +281,23 @@ protected RepositoryFragments getRepositoryFragments(RepositoryMetadata metadata
279281
"Cannot combine Querydsl and reactive repository support in a single interface");
280282
}
281283

282-
return RepositoryFragments.just(new QuerydslJpaPredicateExecutor<>(getEntityInformation(metadata.getDomainType()),
283-
entityManager, resolver, crudMethodMetadata));
284+
QuerydslJpaPredicateExecutor<?> querydslJpaPredicateExecutor = new QuerydslJpaPredicateExecutor<>(
285+
getEntityInformation(metadata.getDomainType()), entityManager, resolver, crudMethodMetadata);
286+
invokeAwareMethods(querydslJpaPredicateExecutor);
287+
288+
return RepositoryFragments.just(querydslJpaPredicateExecutor);
284289
}
285290

286291
return RepositoryFragments.empty();
287292
}
288293

294+
private void invokeAwareMethods(JpaRepositoryConfigurationAware repository) {
295+
296+
repository.setRepositoryMethodMetadata(crudMethodMetadata);
297+
repository.setEscapeCharacter(escapeCharacter);
298+
repository.setProjectionFactory(getProjectionFactory());
299+
}
300+
289301
private static boolean isTransactionNeeded(Class<?> repositoryClass) {
290302

291303
Method[] methods = ReflectionUtils.getAllDeclaredMethods(repositoryClass);

‎spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/JpaRepositoryImplementation.java‎

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717

1818
import org.springframework.data.jpa.repository.JpaRepository;
1919
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
20-
import org.springframework.data.jpa.repository.query.EscapeCharacter;
2120
import org.springframework.data.repository.NoRepositoryBean;
2221

2322
/**
@@ -28,21 +27,7 @@
2827
* @author Jens Schauder
2928
*/
3029
@NoRepositoryBean
31-
public interface JpaRepositoryImplementation<T, ID> extends JpaRepository<T, ID>, JpaSpecificationExecutor<T> {
30+
public interface JpaRepositoryImplementation<T, ID>
31+
extends JpaRepository<T, ID>, JpaSpecificationExecutor<T>, JpaRepositoryConfigurationAware {
3232

33-
/**
34-
* Configures the {@link CrudMethodMetadata} to be used with the repository.
35-
*
36-
* @param crudMethodMetadata must not be {@literal null}.
37-
*/
38-
void setRepositoryMethodMetadata(CrudMethodMetadata crudMethodMetadata);
39-
40-
/**
41-
* Configures the {@link EscapeCharacter} to be used with the repository.
42-
*
43-
* @param escapeCharacter Must not be {@literal null}.
44-
*/
45-
default void setEscapeCharacter(EscapeCharacter escapeCharacter) {
46-
47-
}
4833
}

0 commit comments

Comments
 (0)