Skip to content

Commit 45fbd5c

Browse files
mp911demp911de
committed
Polishing.
Reuse existing EvaluationContextProvider infrastructure and static parser/parser context instances. Parse expressions early. Update Javadoc to reflect SpEL support. Reformat code to use tabs instead of spaces. Rename types for consistency. Rename SpelExpressionResultSanitizer to SqlIdentifierSanitizer to express its intended usage.
1 parent 3349032 commit 45fbd5c

File tree

13 files changed

+413
-293
lines changed

13 files changed

+413
-293
lines changed

‎spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/mapping/JdbcMappingContext.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,7 @@ protected RelationalPersistentProperty createPersistentProperty(Property propert
8181
RelationalPersistentEntity<?> owner, SimpleTypeHolder simpleTypeHolder) {
8282
BasicJdbcPersistentProperty persistentProperty = new BasicJdbcPersistentProperty(property, owner, simpleTypeHolder,
8383
this.getNamingStrategy());
84-
persistentProperty.setForceQuote(isForceQuote());
85-
persistentProperty.setSpelExpressionProcessor(getSpelExpressionProcessor());
84+
applyDefaults(persistentProperty);
8685
return persistentProperty;
8786
}
8887

‎spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/BasicRelationalPersistentEntity.java

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
/*
2+
* Copyright 2017-2023 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.relational.core.mapping;
17+
18+
import java.util.Optional;
19+
20+
import org.springframework.data.mapping.model.BasicPersistentEntity;
21+
import org.springframework.data.relational.core.sql.SqlIdentifier;
22+
import org.springframework.data.util.Lazy;
23+
import org.springframework.data.util.TypeInformation;
24+
import org.springframework.expression.Expression;
25+
import org.springframework.expression.ParserContext;
26+
import org.springframework.expression.common.LiteralExpression;
27+
import org.springframework.expression.spel.standard.SpelExpressionParser;
28+
import org.springframework.lang.Nullable;
29+
import org.springframework.util.StringUtils;
30+
31+
/**
32+
* SQL-specific {@link RelationalPersistentEntity} implementation that adds SQL-specific meta-data such as the table and
33+
* schema name.
34+
*
35+
* @author Jens Schauder
36+
* @author Greg Turnquist
37+
* @author Bastian Wilhelm
38+
* @author Mikhail Polivakha
39+
* @author Kurt Niemi
40+
*/
41+
class BasicRelationalPersistentEntity<T> extends BasicPersistentEntity<T, RelationalPersistentProperty>
42+
implements RelationalPersistentEntity<T> {
43+
44+
private static final SpelExpressionParser PARSER = new SpelExpressionParser();
45+
46+
private final NamingStrategy namingStrategy;
47+
48+
private final Lazy<SqlIdentifier> tableName;
49+
private final @Nullable Expression tableNameExpression;
50+
51+
private final Lazy<Optional<SqlIdentifier>> schemaName;
52+
private final ExpressionEvaluator expressionEvaluator;
53+
private boolean forceQuote = true;
54+
55+
/**
56+
* Creates a new {@link BasicRelationalPersistentEntity} for the given {@link TypeInformation}.
57+
*
58+
* @param information must not be {@literal null}.
59+
*/
60+
BasicRelationalPersistentEntity(TypeInformation<T> information, NamingStrategy namingStrategy,
61+
ExpressionEvaluator expressionEvaluator) {
62+
63+
super(information);
64+
65+
this.namingStrategy = namingStrategy;
66+
this.expressionEvaluator = expressionEvaluator;
67+
68+
Lazy<Optional<SqlIdentifier>> defaultSchema = Lazy.of(() -> {
69+
if (StringUtils.hasText(namingStrategy.getSchema())) {
70+
return Optional.of(createDerivedSqlIdentifier(namingStrategy.getSchema()));
71+
}
72+
return Optional.empty();
73+
});
74+
75+
if (isAnnotationPresent(Table.class)) {
76+
77+
Table table = getRequiredAnnotation(Table.class);
78+
79+
// TODO: support expressions for schema
80+
this.tableName = StringUtils.hasText(table.value()) ? Lazy.of(() -> createSqlIdentifier(table.value()))
81+
: Lazy.of(() -> createDerivedSqlIdentifier(namingStrategy.getTableName(getType())));
82+
this.tableNameExpression = detectExpression(table.value());
83+
84+
this.schemaName = StringUtils.hasText(table.schema())
85+
? Lazy.of(() -> Optional.of(createSqlIdentifier(table.schema())))
86+
: defaultSchema;
87+
88+
} else {
89+
90+
this.tableName = Lazy.of(() -> createDerivedSqlIdentifier(namingStrategy.getTableName(getType())));
91+
this.tableNameExpression = null;
92+
this.schemaName = defaultSchema;
93+
}
94+
}
95+
96+
/**
97+
* Returns a SpEL {@link Expression} if the given {@link String} is actually an expression that does not evaluate to a
98+
* {@link LiteralExpression} (indicating that no subsequent evaluation is necessary).
99+
*
100+
* @param potentialExpression can be {@literal null}
101+
* @return can be {@literal null}.
102+
*/
103+
@Nullable
104+
private static Expression detectExpression(@Nullable String potentialExpression) {
105+
106+
if (!StringUtils.hasText(potentialExpression)) {
107+
return null;
108+
}
109+
110+
Expression expression = PARSER.parseExpression(potentialExpression, ParserContext.TEMPLATE_EXPRESSION);
111+
return expression instanceof LiteralExpression ? null : expression;
112+
}
113+
114+
private SqlIdentifier createSqlIdentifier(String name) {
115+
return isForceQuote() ? SqlIdentifier.quoted(name) : SqlIdentifier.unquoted(name);
116+
}
117+
118+
private SqlIdentifier createDerivedSqlIdentifier(String name) {
119+
return new DerivedSqlIdentifier(name, isForceQuote());
120+
}
121+
122+
public boolean isForceQuote() {
123+
return forceQuote;
124+
}
125+
126+
public void setForceQuote(boolean forceQuote) {
127+
this.forceQuote = forceQuote;
128+
}
129+
130+
@Override
131+
public SqlIdentifier getTableName() {
132+
133+
if (tableNameExpression == null) {
134+
return tableName.get();
135+
}
136+
137+
return createSqlIdentifier(expressionEvaluator.evaluate(tableNameExpression));
138+
}
139+
140+
@Override
141+
public SqlIdentifier getQualifiedTableName() {
142+
143+
SqlIdentifier schema = schemaName.get().orElse(null);
144+
145+
if (schema == null) {
146+
return getTableName();
147+
}
148+
149+
return SqlIdentifier.from(schema, getTableName());
150+
}
151+
152+
@Override
153+
public SqlIdentifier getIdColumn() {
154+
return getRequiredIdProperty().getColumnName();
155+
}
156+
157+
@Override
158+
public String toString() {
159+
return String.format("BasicRelationalPersistentEntity<%s>", getType());
160+
}
161+
}

‎spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/BasicRelationalPersistentProperty.java

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,19 @@
2525
import org.springframework.data.mapping.model.SimpleTypeHolder;
2626
import org.springframework.data.relational.core.mapping.Embedded.OnEmpty;
2727
import org.springframework.data.relational.core.sql.SqlIdentifier;
28+
import org.springframework.data.spel.EvaluationContextProvider;
2829
import org.springframework.data.util.Lazy;
2930
import org.springframework.data.util.Optionals;
31+
import org.springframework.expression.Expression;
32+
import org.springframework.expression.ParserContext;
33+
import org.springframework.expression.common.LiteralExpression;
34+
import org.springframework.expression.spel.standard.SpelExpressionParser;
35+
import org.springframework.lang.Nullable;
3036
import org.springframework.util.Assert;
3137
import org.springframework.util.StringUtils;
3238

3339
/**
34-
* Meta data about a property to be used by repository implementations.
40+
* SQL-specific {@link org.springframework.data.mapping.PersistentProperty} implementation.
3541
*
3642
* @author Jens Schauder
3743
* @author Greg Turnquist
@@ -42,14 +48,17 @@
4248
public class BasicRelationalPersistentProperty extends AnnotationBasedPersistentProperty<RelationalPersistentProperty>
4349
implements RelationalPersistentProperty {
4450

51+
private static final SpelExpressionParser PARSER = new SpelExpressionParser();
52+
4553
private final Lazy<SqlIdentifier> columnName;
54+
private final @Nullable Expression columnNameExpression;
4655
private final Lazy<Optional<SqlIdentifier>> collectionIdColumnName;
4756
private final Lazy<SqlIdentifier> collectionKeyColumnName;
4857
private final Lazy<Boolean> isEmbedded;
4958
private final Lazy<String> embeddedPrefix;
5059
private final NamingStrategy namingStrategy;
5160
private boolean forceQuote = true;
52-
private SpelExpressionProcessor spelExpressionProcessor = new SpelExpressionProcessor();
61+
private ExpressionEvaluator spelExpressionProcessor = new ExpressionEvaluator(EvaluationContextProvider.DEFAULT);
5362

5463
/**
5564
* Creates a new {@link BasicRelationalPersistentProperty}.
@@ -90,13 +99,20 @@ public BasicRelationalPersistentProperty(Property property, PersistentEntity<?,
9099
.map(Embedded::prefix) //
91100
.orElse(""));
92101

93-
this.columnName = Lazy.of(() -> Optional.ofNullable(findAnnotation(Column.class)) //
94-
.map(Column::value) //
95-
.map(spelExpressionProcessor::applySpelExpression) //
96-
.filter(StringUtils::hasText) //
97-
.map(this::createSqlIdentifier) //
98-
.orElseGet(() -> createDerivedSqlIdentifier(namingStrategy.getColumnName(this))));
102+
if (isAnnotationPresent(Column.class)) {
103+
104+
Column column = getRequiredAnnotation(Column.class);
105+
106+
columnName = StringUtils.hasText(column.value()) ? Lazy.of(() -> createSqlIdentifier(column.value()))
107+
: Lazy.of(() -> createDerivedSqlIdentifier(namingStrategy.getColumnName(this)));
108+
columnNameExpression = detectExpression(column.value());
99109

110+
} else {
111+
columnName = Lazy.of(() -> createDerivedSqlIdentifier(namingStrategy.getColumnName(this)));
112+
columnNameExpression = null;
113+
}
114+
115+
// TODO: support expressions for MappedCollection
100116
this.collectionIdColumnName = Lazy.of(() -> Optionals
101117
.toStream(Optional.ofNullable(findAnnotation(MappedCollection.class)) //
102118
.map(MappedCollection::idColumn), //
@@ -112,14 +128,30 @@ public BasicRelationalPersistentProperty(Property property, PersistentEntity<?,
112128
.map(this::createSqlIdentifier) //
113129
.orElseGet(() -> createDerivedSqlIdentifier(namingStrategy.getKeyColumn(this))));
114130
}
115-
public SpelExpressionProcessor getSpelExpressionProcessor() {
116-
return spelExpressionProcessor;
117-
}
118131

119-
public void setSpelExpressionProcessor(SpelExpressionProcessor spelExpressionProcessor) {
132+
void setSpelExpressionProcessor(ExpressionEvaluator spelExpressionProcessor) {
120133
this.spelExpressionProcessor = spelExpressionProcessor;
121134
}
122135

136+
/**
137+
* Returns a SpEL {@link Expression} if the given {@link String} is actually an expression that does not evaluate to a
138+
* {@link LiteralExpression} (indicating that no subsequent evaluation is necessary).
139+
*
140+
* @param potentialExpression can be {@literal null}
141+
* @return can be {@literal null}.
142+
*/
143+
@Nullable
144+
private static Expression detectExpression(@Nullable String potentialExpression) {
145+
146+
if (!StringUtils.hasText(potentialExpression)) {
147+
return null;
148+
}
149+
150+
Expression expression = PARSER.parseExpression(potentialExpression, ParserContext.TEMPLATE_EXPRESSION);
151+
return expression instanceof LiteralExpression ? null : expression;
152+
}
153+
154+
123155
private SqlIdentifier createSqlIdentifier(String name) {
124156
return isForceQuote() ? SqlIdentifier.quoted(name) : SqlIdentifier.unquoted(name);
125157
}
@@ -148,7 +180,12 @@ public boolean isEntity() {
148180

149181
@Override
150182
public SqlIdentifier getColumnName() {
151-
return columnName.get();
183+
184+
if (columnNameExpression == null) {
185+
return columnName.get();
186+
}
187+
188+
return createSqlIdentifier(spelExpressionProcessor.evaluate(columnNameExpression));
152189
}
153190

154191
@Override

‎spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/Column.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
public @interface Column {
3535

3636
/**
37-
* The mapping column name.
37+
* The column name. The attribute supports SpEL expressions to dynamically calculate the column name on a
38+
* per-operation basis.
3839
*/
3940
String value() default "";
4041

‎spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/ExpressionEvaluator.java

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
package org.springframework.data.relational.core.mapping;
2+
3+
import org.springframework.data.spel.EvaluationContextProvider;
4+
import org.springframework.expression.EvaluationException;
5+
import org.springframework.expression.Expression;
6+
import org.springframework.util.Assert;
7+
8+
/**
9+
* Provide support for processing SpEL expressions in @Table and @Column annotations, or anywhere we want to use SpEL
10+
* expressions and sanitize the result of the evaluated SpEL expression. The default sanitization allows for digits,
11+
* alphabetic characters and _ characters and strips out any other characters. Custom sanitization (if desired) can be
12+
* achieved by creating a class that implements the {@link SqlIdentifierSanitizer} interface and then invoking the
13+
* {@link #setSpelExpressionResultSanitizer(SqlIdentifierSanitizer)} method.
14+
*
15+
* @author Kurt Niemi
16+
* @see SqlIdentifierSanitizer
17+
* @since 3.1
18+
*/
19+
class ExpressionEvaluator {
20+
21+
private EvaluationContextProvider provider;
22+
23+
private SqlIdentifierSanitizer sanitizer = SqlIdentifierSanitizer.words();
24+
25+
public ExpressionEvaluator(EvaluationContextProvider provider) {
26+
this.provider = provider;
27+
}
28+
29+
public String evaluate(Expression expression) throws EvaluationException {
30+
31+
Assert.notNull(expression, "Expression must not be null.");
32+
33+
String result = expression.getValue(provider.getEvaluationContext(null), String.class);
34+
35+
return sanitizer.sanitize(result);
36+
}
37+
38+
public void setSanitizer(SqlIdentifierSanitizer sanitizer) {
39+
40+
Assert.notNull(sanitizer, "SqlIdentifierSanitizer must not be null");
41+
42+
this.sanitizer = sanitizer;
43+
}
44+
45+
public void setProvider(EvaluationContextProvider provider) {
46+
this.provider = provider;
47+
}
48+
}

0 commit comments

Comments
 (0)