DATACMNS-661 - Improvements in SpelAwareProxyProjectionFactory.

We now allow a SpelExpressionParser to be configured on the SpelAwareProxyProjectionFactory. This parser is then passed on to SpelEvaluatingMethodInterceptor. We also now eagerly pre-parse any SpEL expression in @Value annotations on methods of the projection interface. This avoids repeated evaluations during the actual method invocations.

Original pull request: #118.
This commit is contained in:
Thomas Darimont
2015-03-18 17:41:17 +01:00
committed by Oliver Gierke
parent 537fc430a9
commit 0cf395c1b1
4 changed files with 109 additions and 23 deletions

View File

@@ -27,6 +27,8 @@ import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.data.util.AnnotationDetectionMethodCallback;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.util.Assert;
import org.springframework.util.ReflectionUtils;
/**
@@ -34,6 +36,7 @@ import org.springframework.util.ReflectionUtils;
* to evaluate the contained SpEL expression to define the outcome of the method call.
*
* @author Oliver Gierke
* @author Thomas Darimont
* @since 1.10
*/
public class SpelAwareProxyProjectionFactory extends ProxyProjectionFactory implements BeanFactoryAware {
@@ -41,6 +44,7 @@ public class SpelAwareProxyProjectionFactory extends ProxyProjectionFactory impl
private final Map<Class<?>, Boolean> typeCache = new HashMap<Class<?>, Boolean>();
private BeanFactory beanFactory;
private SpelExpressionParser parser = new SpelExpressionParser();
/*
* (non-Javadoc)
@@ -51,13 +55,25 @@ public class SpelAwareProxyProjectionFactory extends ProxyProjectionFactory impl
this.beanFactory = beanFactory;
}
/**
* Set the {@link SpelExpressionParser} to use.
*
* @param parser must not be {@literal null}
*/
public void setParser(SpelExpressionParser parser) {
Assert.notNull(parser, "Parser must not be null!");
this.parser = parser;
}
/**
* Inspects the given target type for methods with {@link Value} annotations and caches the result. Will create a
* {@link SpelEvaluatingMethodInterceptor} if an annotation was found or return the delegate as is if not.
*
* @param interceptor the root {@link MethodInterceptor}.
* @param source The backing source object.
* @param projectionType the proxy target type.
* @param delegate the root {@link MethodInterceptor}.
* @return
*/
@Override
@@ -72,8 +88,8 @@ public class SpelAwareProxyProjectionFactory extends ProxyProjectionFactory impl
typeCache.put(projectionType, callback.hasFoundAnnotation());
}
return typeCache.get(projectionType) ? new SpelEvaluatingMethodInterceptor(interceptor, source, beanFactory)
: interceptor;
return typeCache.get(projectionType) ? new SpelEvaluatingMethodInterceptor(interceptor, source, beanFactory,
parser, projectionType) : interceptor;
}
/*

View File

@@ -16,6 +16,8 @@
package org.springframework.data.projection;
import java.lang.reflect.Method;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.aopalliance.intercept.MethodInterceptor;
@@ -38,14 +40,15 @@ import org.springframework.util.StringUtils;
* delegate {@link MethodInterceptor} if no {@link Value} annotation is found.
*
* @author Oliver Gierke
* @author Thomas Darimont
* @see 1.10
*/
class SpelEvaluatingMethodInterceptor implements MethodInterceptor {
private final SpelExpressionParser parser;
private final ParserContext parserContext;
private static final ParserContext PARSER_CONTEXT = new TemplateParserContext();
private final EvaluationContext evaluationContext;
private final MethodInterceptor delegate;
private final Map<Integer, Expression> expressions;
/**
* Creates a new {@link SpelEvaluatingMethodInterceptor} delegating to the given {@link MethodInterceptor} as fallback
@@ -55,11 +58,16 @@ class SpelEvaluatingMethodInterceptor implements MethodInterceptor {
* @param delegate must not be {@literal null}.
* @param target must not be {@literal null}.
* @param beanFactory can be {@literal null}.
* @param parser must not be {@literal null}.
* @param targetInterface must not be {@literal null}.
*/
public SpelEvaluatingMethodInterceptor(MethodInterceptor delegate, Object target, BeanFactory beanFactory) {
public SpelEvaluatingMethodInterceptor(MethodInterceptor delegate, Object target, BeanFactory beanFactory,
SpelExpressionParser parser, Class<?> targetInterface) {
Assert.notNull(delegate, "Delegate MethodInterceptor must not be null!");
Assert.notNull(target, "TargetObject must not be null!");
Assert.notNull(parser, "TargetObject must not be null!");
Assert.notNull(targetInterface, "TargetInterface must not be null!");
StandardEvaluationContext evaluationContext = new StandardEvaluationContext(new TargetWrapper(target));
@@ -71,12 +79,45 @@ class SpelEvaluatingMethodInterceptor implements MethodInterceptor {
evaluationContext.setBeanResolver(new BeanFactoryResolver(beanFactory));
}
this.expressions = potentiallyCreateExpressionsForMethodsOnTargetInterface(parser, targetInterface);
this.evaluationContext = evaluationContext;
this.parser = new SpelExpressionParser();
this.parserContext = new TemplateParserContext();
this.delegate = delegate;
}
/**
* Eagerly parses {@link Expression} defined on {@link Value} annotations. Returns a map with
* {@code method.hashCode()} as key and the parsed {@link Expression} or an {@link Collections#emptyMap()} if no
* {@code Expressions} were found.
*
* @param parser
* @param targetInterface
* @return
*/
private Map<Integer, Expression> potentiallyCreateExpressionsForMethodsOnTargetInterface(SpelExpressionParser parser,
Class<?> targetInterface) {
Map<Integer, Expression> expressions = new HashMap<Integer, Expression>();
for (Method method : targetInterface.getMethods()) {
if (!method.isAnnotationPresent(Value.class)) {
continue;
}
Value value = method.getAnnotation(Value.class);
if (!StringUtils.hasText(value.value())) {
throw new IllegalStateException(String.format("@Value annotation on %s contains empty expression!", method));
}
Expression expression = parser.parseExpression(value.value(), PARSER_CONTEXT);
expressions.put(method.hashCode(), expression);
}
return expressions.isEmpty() ? Collections.<Integer, Expression> emptyMap() : expressions;
}
/*
* (non-Javadoc)
* @see org.aopalliance.intercept.MethodInterceptor#invoke(org.aopalliance.intercept.MethodInvocation)
@@ -84,18 +125,12 @@ class SpelEvaluatingMethodInterceptor implements MethodInterceptor {
@Override
public Object invoke(MethodInvocation invocation) throws Throwable {
Method method = invocation.getMethod();
Value annotation = method.getAnnotation(Value.class);
Expression expression = expressions.get(invocation.getMethod().hashCode());
if (annotation == null) {
if (expression == null) {
return delegate.invoke(invocation);
}
if (!StringUtils.hasText(annotation.value())) {
throw new IllegalStateException(String.format("@Value annotation on %s contains empty expression!", method));
}
Expression expression = parser.parseExpression(annotation.value(), parserContext);
return expression.getValue(evaluationContext);
}