Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revise SpEL inline collection caching improvements

Browse Source 
This commit revises the contribution for gh-25921 in the following ways.

- Use instanceof pattern matching

- Use List.of() and Map.of()

- Add missing @⁠since tags

- Polish Javadoc

- Rename isNegativeNumber() to isNegativeNumberLiteral()

- Restructure InlineCollectionTests using @⁠Nested, etc.

- Fix testListWithVariableNotCached() test: it previously set a SpEL
  "variable" but tested a "property" in the root context object, which
  effectively did not test anything.

- Introduce additional tests: listWithPropertyAccessIsNotCached(),
  mapWithVariableIsNotCached(), and mapWithPropertyAccessIsNotCached().
This commit is contained in:
Sam Brannen
2023-09-13 12:41:32 +02:00
parent 2cc1ee78c1
commit e7cf54d4e2
5 changed files with 198 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-expression/src/main/java/org/springframework/expression/spel/ast/InlineList.java
View File

@@ -68,7 +68,7 @@ public class InlineList extends SpelNodeImpl {
return null;
}
}
else if (!(child instanceof OpMinus) || !((OpMinus) child).isNegativeNumber()) {
else if (!(child instanceof OpMinus opMinus) || !opMinus.isNegativeNumberLiteral()) {
return null;
}
}

2
spring-expression/src/main/java/org/springframework/expression/spel/ast/InlineMap.java
View File

@@ -71,7 +71,7 @@ public class InlineMap extends SpelNodeImpl {
}
}
else if (!(c % 2 == 0 && child instanceof PropertyOrFieldReference)) {
if (!(child instanceof OpMinus) || !((OpMinus) child).isNegativeNumber()) {
if (!(child instanceof OpMinus opMinus) || !opMinus.isNegativeNumberLiteral()) {
return null;
}
}

23
spring-expression/src/main/java/org/springframework/expression/spel/ast/Literal.java
View File

@@ -53,6 +53,18 @@ public abstract class Literal extends SpelNodeImpl {
return getLiteralValue();
}
/**
* Determine if this literal represents a number.
* @return {@code true} if this literal represents a number
* @since 6.1
*/
public boolean isNumberLiteral() {
return (this instanceof IntLiteral ||
this instanceof LongLiteral ||
this instanceof FloatLiteral ||
this instanceof RealLiteral);
}
@Override
public String toString() {
return String.valueOf(getLiteralValue().getValue());
@@ -111,15 +123,4 @@ public abstract class Literal extends SpelNodeImpl {
}
}
/**
* Check whether this literal is a number.
* @return true if this is a number
*/
public boolean isNumberLiteral() {
return this instanceof IntLiteral ||
this instanceof LongLiteral ||
this instanceof FloatLiteral ||
this instanceof RealLiteral;
}
}

22
spring-expression/src/main/java/org/springframework/expression/spel/ast/OpMinus.java
View File

@@ -54,6 +54,17 @@ public class OpMinus extends Operator {
}
/**
* Determine if this operator is a unary minus and its child is a
* {@linkplain Literal#isNumberLiteral() number literal}.
* @return {@code true} if it is a negative number literal
* @since 6.1
*/
public boolean isNegativeNumberLiteral() {
return (this.children.length == 1 && this.children[0] instanceof Literal literal &&
literal.isNumberLiteral());
}
@Override
public TypedValue getValueInternal(ExpressionState state) throws EvaluationException {
SpelNodeImpl leftOp = getLeftOperand();
@@ -206,15 +217,4 @@ public class OpMinus extends Operator {
cf.pushDescriptor(this.exitTypeDescriptor);
}
/**
* Check whether this operator is an unary minus and it's child is a number.
* @return true if it is a negative number
*/
public boolean isNegativeNumber() {
if (children.length == 1 && children[0] instanceof Literal) {
return ((Literal) children[0]).isNumberLiteral();
}
return false;
}
}

302
spring-expression/src/test/java/org/springframework/expression/spel/ast/InlineCollectionTests.java
View File

@@ -16,10 +16,10 @@
package org.springframework.expression.spel.ast;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.springframework.expression.ExpressionParser;
@@ -32,144 +32,188 @@ import org.springframework.expression.spel.support.StandardEvaluationContext;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link InlineList} and {@link InlineMap}.
*
* @author Semyon Danilov
* @author Sam Brannen
* @since 6.1
*/
public class InlineCollectionTests {
class InlineCollectionTests {
private final ExpressionParser parser = new SpelExpressionParser();
@Nested
class InlineListTests {
@Test
void listIsCached() {
InlineList list = parseList("{1, -2, 3, 4}");
assertThat(list.isConstant()).isTrue();
assertThat(list.getConstantValue()).isEqualTo(List.of(1, -2, 3, 4));
}
@Test
void dynamicListIsNotCached() {
InlineList list = parseList("{1, (5 - 3), 3, 4}");
assertThat(list.isConstant()).isFalse();
assertThat(list.getValue(null)).isEqualTo(List.of(1, 2, 3, 4));
}
@Test
void listWithVariableIsNotCached() {
StandardEvaluationContext evaluationContext = new StandardEvaluationContext();
ExpressionState expressionState = new ExpressionState(evaluationContext);
InlineList list = parseList("{1, -#num, 3, 4}");
assertThat(list.isConstant()).isFalse();
evaluationContext.setVariable("num", 2);
assertThat(list.getValue(expressionState)).isEqualTo(List.of(1, -2, 3, 4));
}
@Test
void listWithPropertyAccessIsNotCached() {
StandardEvaluationContext evaluationContext = new StandardEvaluationContext(new NumberHolder());
ExpressionState expressionState = new ExpressionState(evaluationContext);
InlineList list = parseList("{1, -num, 3, 4}");
assertThat(list.isConstant()).isFalse();
assertThat(list.getValue(expressionState)).isEqualTo(List.of(1, -99, 3, 4));
parser.parseExpression("num = 2").getValue(evaluationContext);
assertThat(list.getValue(expressionState)).isEqualTo(List.of(1, -2, 3, 4));
}
@Test
void listCanBeCompiled() {
SpelExpression listExpression = parseExpression("{1, -2, 3, 4}");
assertThat(((SpelNodeImpl) listExpression.getAST()).isCompilable()).isTrue();
assertThat(SpelCompiler.compile(listExpression)).isTrue();
}
@Test
void dynamicListCannotBeCompiled() {
SpelExpression listExpression = parseExpression("{1, (5 - 3), 3, 4}");
assertThat(((SpelNodeImpl) listExpression.getAST()).isCompilable()).isFalse();
assertThat(SpelCompiler.compile(listExpression)).isFalse();
}
private InlineList parseList(String s) {
SpelExpression expression = parseExpression(s);
return (InlineList) expression.getAST();
}
@Test
void testListCached() {
InlineList list = parseList("{1, -2, 3, 4}");
assertThat(list.isConstant()).isTrue();
assertThat(list.getConstantValue()).isEqualTo(Arrays.asList(1, -2, 3, 4));
}
@Test
void testDynamicListNotCached() {
InlineList list = parseList("{1, 5-2, 3, 4}");
assertThat(list.isConstant()).isFalse();
assertThat(list.getValue(null)).isEqualTo(Arrays.asList(1, 3, 3, 4));
@Nested
class InlineMapTests {
@Test
void mapIsCached() {
InlineMap map = parseMap("{1 : 2, 3 : 4}");
assertThat(map.isConstant()).isTrue();
Map<Integer, Integer> expected = Map.of(1, 2, 3, 4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void dynamicMapIsNotCached() {
InlineMap map = parseMap("{-1 : 2, (-2 - 1) : -4}");
assertThat(map.isConstant()).isFalse();
Map<Integer, Integer> expected = Map.of(-1, 2, -3, -4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void mapWithVariableIsNotCached() {
StandardEvaluationContext evaluationContext = new StandardEvaluationContext();
ExpressionState expressionState = new ExpressionState(evaluationContext);
InlineMap map = parseMap("{-1 : 2, -3 : -#num}");
assertThat(map.isConstant()).isFalse();
evaluationContext.setVariable("num", 4);
assertThat(map.getValue(expressionState)).isEqualTo(Map.of(-1, 2, -3, -4));
}
@Test
void mapWithPropertyAccessIsNotCached() {
StandardEvaluationContext evaluationContext = new StandardEvaluationContext(new NumberHolder());
ExpressionState expressionState = new ExpressionState(evaluationContext);
InlineMap map = parseMap("{-1 : 2, -3 : -num}");
assertThat(map.isConstant()).isFalse();
assertThat(map.getValue(expressionState)).isEqualTo(Map.of(-1, 2, -3, -99));
parser.parseExpression("num = 4").getValue(evaluationContext);
assertThat(map.getValue(expressionState)).isEqualTo(Map.of(-1, 2, -3, -4));
}
@Test
void mapWithNegativeKeysIsCached() {
InlineMap map = parseMap("{-1 : 2, -3 : 4}");
assertThat(map.isConstant()).isTrue();
Map<Integer, Integer> expected = Map.of(-1, 2, -3, 4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void mapWithNegativeValuesIsCached() {
InlineMap map = parseMap("{1 : -2, 3 : -4}");
assertThat(map.isConstant()).isTrue();
Map<Integer, Integer> expected = Map.of(1, -2, 3, -4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void mapWithNegativeLongValuesIsCached() {
InlineMap map = parseMap("{1L : -2L, 3L : -4L}");
assertThat(map.isConstant()).isTrue();
Map<Long, Long> expected = Map.of(1L, -2L, 3L, -4L);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void mapWithNegativeFloatValuesIsCached() {
InlineMap map = parseMap("{-1.0f : -2.0f, -3.0f : -4.0f}");
assertThat(map.isConstant()).isTrue();
Map<Float, Float> expected = Map.of(-1.0f, -2.0f, -3.0f, -4.0f);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void mapWithNegativeRealValuesIsCached() {
InlineMap map = parseMap("{-1.0 : -2.0, -3.0 : -4.0}");
assertThat(map.isConstant()).isTrue();
Map<Double, Double> expected = Map.of(-1.0, -2.0, -3.0, -4.0);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void mapWithNegativeKeysAndNegativeValuesIsCached() {
InlineMap map = parseMap("{-1 : -2, -3 : -4}");
assertThat(map.isConstant()).isTrue();
Map<Integer, Integer> expected = Map.of(-1, -2, -3, -4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
private InlineMap parseMap(String s) {
SpelExpression expression = parseExpression(s);
return (InlineMap) expression.getAST();
}
}
@Test
void testListWithVariableNotCached() {
InlineList list = parseList("{1, -a, 3, 4}");
assertThat(list.isConstant()).isFalse();
final StandardEvaluationContext standardEvaluationContext = new StandardEvaluationContext(new AHolder());
standardEvaluationContext.setVariable("a", 2);
assertThat(list.getValue(new ExpressionState(standardEvaluationContext))).isEqualTo(Arrays.asList(1, -2, 3, 4));
}
@Test
void testListCanBeCompiled() {
SpelExpression listExpression = parseExpression("{1, -2, 3, 4}");
assertThat(((SpelNodeImpl) listExpression.getAST()).isCompilable()).isTrue();
assertThat(SpelCompiler.compile(listExpression)).isTrue();
}
@Test
void testDynamicListCantBeCompiled() {
SpelExpression listExpression = parseExpression("{1, 5-2, 3, 4}");
assertThat(((SpelNodeImpl) listExpression.getAST()).isCompilable()).isFalse();
assertThat(SpelCompiler.compile(listExpression)).isFalse();
}
@Test
void testMapCached() {
InlineMap map = parseMap("{1 : 2, 3 : 4}");
assertThat(map.isConstant()).isTrue();
final Map<Integer, Integer> expected = new HashMap<>();
expected.put(1, 2);
expected.put(3, 4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithNegativeKeyCached() {
InlineMap map = parseMap("{-1 : 2, -3 : 4}");
assertThat(map.isConstant()).isTrue();
final Map<Integer, Integer> expected = new HashMap<>();
expected.put(-1, 2);
expected.put(-3, 4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithNegativeValueCached() {
InlineMap map = parseMap("{1 : -2, 3 : -4}");
assertThat(map.isConstant()).isTrue();
final Map<Integer, Integer> expected = new HashMap<>();
expected.put(1, -2);
expected.put(3, -4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithNegativeLongTypesCached() {
InlineMap map = parseMap("{1L : -2L, 3L : -4L}");
assertThat(map.isConstant()).isTrue();
final Map<Long, Long> expected = new HashMap<>();
expected.put(1L, -2L);
expected.put(3L, -4L);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithNegativeFloatTypesCached() {
InlineMap map = parseMap("{-1.0f : -2.0f, -3.0f : -4.0f}");
assertThat(map.isConstant()).isTrue();
final Map<Float, Float> expected = new HashMap<>();
expected.put(-1.0f, -2.0f);
expected.put(-3.0f, -4.0f);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithNegativeRealTypesCached() {
InlineMap map = parseMap("{-1.0 : -2.0, -3.0 : -4.0}");
assertThat(map.isConstant()).isTrue();
final Map<Double, Double> expected = new HashMap<>();
expected.put(-1.0, -2.0);
expected.put(-3.0, -4.0);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithNegativeKeyAndValueCached() {
InlineMap map = parseMap("{-1 : -2, -3 : -4}");
assertThat(map.isConstant()).isTrue();
final Map<Integer, Integer> expected = new HashMap<>();
expected.put(-1, -2);
expected.put(-3, -4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
@Test
void testMapWithDynamicNotCached() {
InlineMap map = parseMap("{-1 : 2, -3+1 : -4}");
assertThat(map.isConstant()).isFalse();
final Map<Integer, Integer> expected = new HashMap<>();
expected.put(-1, 2);
expected.put(-2, -4);
assertThat(map.getValue(null)).isEqualTo(expected);
}
private InlineMap parseMap(String s) {
SpelExpression expression = parseExpression(s);
return (InlineMap) expression.getAST();
}
private InlineList parseList(String s) {
SpelExpression expression = parseExpression(s);
return (InlineList) expression.getAST();
}
private SpelExpression parseExpression(final String s) {
ExpressionParser parser = new SpelExpressionParser();
private SpelExpression parseExpression(String s) {
return (SpelExpression) parser.parseExpression(s);
}
private static class AHolder {
public int a = 2;
private static class NumberHolder {
@SuppressWarnings("unused")
public int num = 99;
}
}