Browse Source
Switch to Spring Framework duration formatting. Favour expireAfter with string parameter over the seconds based variant. Deprecate the existing expireAfterSeconds attribute of the Indexed annotation. Consider property value syntax when parsing timeout expressions. Remove DurationStyle (package visible). Update documentation. Original Pull Request: #4114pull/4007/merge
Christoph Strobl
3 years ago
committed by
Christoph Strobl
10 changed files with 236 additions and 444 deletions
@ -1,216 +0,0 @@
@@ -1,216 +0,0 @@
|
||||
/* |
||||
* Copyright 2012-2024 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
package org.springframework.data.mongodb.core.index; |
||||
|
||||
import java.time.Duration; |
||||
import java.time.temporal.ChronoUnit; |
||||
import java.util.function.Function; |
||||
import java.util.regex.Matcher; |
||||
import java.util.regex.Pattern; |
||||
|
||||
import org.springframework.lang.Nullable; |
||||
import org.springframework.util.Assert; |
||||
import org.springframework.util.StringUtils; |
||||
|
||||
/** |
||||
* Duration format styles. |
||||
* <br /> |
||||
* Fork of {@code org.springframework.boot.convert.DurationStyle}. |
||||
* |
||||
* @author Phillip Webb |
||||
* @since 2.2 |
||||
*/ |
||||
public enum DurationStyle { |
||||
|
||||
/** |
||||
* Simple formatting, for example '1s'. |
||||
*/ |
||||
SIMPLE("^([\\+\\-]?\\d+)([a-zA-Z]{0,2})$") { |
||||
|
||||
@Override |
||||
public Duration parse(String value, @Nullable ChronoUnit unit) { |
||||
try { |
||||
Matcher matcher = matcher(value); |
||||
Assert.state(matcher.matches(), "Does not match simple duration pattern"); |
||||
String suffix = matcher.group(2); |
||||
return (StringUtils.hasLength(suffix) ? Unit.fromSuffix(suffix) : Unit.fromChronoUnit(unit)) |
||||
.parse(matcher.group(1)); |
||||
} catch (Exception ex) { |
||||
throw new IllegalArgumentException("'" + value + "' is not a valid simple duration", ex); |
||||
} |
||||
} |
||||
}, |
||||
|
||||
/** |
||||
* ISO-8601 formatting. |
||||
*/ |
||||
ISO8601("^[\\+\\-]?P.*$") { |
||||
|
||||
@Override |
||||
public Duration parse(String value, @Nullable ChronoUnit unit) { |
||||
try { |
||||
return Duration.parse(value); |
||||
} catch (Exception ex) { |
||||
throw new IllegalArgumentException("'" + value + "' is not a valid ISO-8601 duration", ex); |
||||
} |
||||
} |
||||
}; |
||||
|
||||
private final Pattern pattern; |
||||
|
||||
DurationStyle(String pattern) { |
||||
this.pattern = Pattern.compile(pattern); |
||||
} |
||||
|
||||
protected final boolean matches(String value) { |
||||
return this.pattern.matcher(value).matches(); |
||||
} |
||||
|
||||
protected final Matcher matcher(String value) { |
||||
return this.pattern.matcher(value); |
||||
} |
||||
|
||||
/** |
||||
* Parse the given value to a duration. |
||||
* |
||||
* @param value the value to parse |
||||
* @return a duration |
||||
*/ |
||||
public Duration parse(String value) { |
||||
return parse(value, null); |
||||
} |
||||
|
||||
/** |
||||
* Parse the given value to a duration. |
||||
* |
||||
* @param value the value to parse |
||||
* @param unit the duration unit to use if the value doesn't specify one ({@code null} will default to ms) |
||||
* @return a duration |
||||
*/ |
||||
public abstract Duration parse(String value, @Nullable ChronoUnit unit); |
||||
|
||||
/** |
||||
* Detect the style then parse the value to return a duration. |
||||
* |
||||
* @param value the value to parse |
||||
* @return the parsed duration |
||||
* @throws IllegalStateException if the value is not a known style or cannot be parsed |
||||
*/ |
||||
public static Duration detectAndParse(String value) { |
||||
return detectAndParse(value, null); |
||||
} |
||||
|
||||
/** |
||||
* Detect the style then parse the value to return a duration. |
||||
* |
||||
* @param value the value to parse |
||||
* @param unit the duration unit to use if the value doesn't specify one ({@code null} will default to ms) |
||||
* @return the parsed duration |
||||
* @throws IllegalStateException if the value is not a known style or cannot be parsed |
||||
*/ |
||||
public static Duration detectAndParse(String value, @Nullable ChronoUnit unit) { |
||||
return detect(value).parse(value, unit); |
||||
} |
||||
|
||||
/** |
||||
* Detect the style from the given source value. |
||||
* |
||||
* @param value the source value |
||||
* @return the duration style |
||||
* @throws IllegalStateException if the value is not a known style |
||||
*/ |
||||
public static DurationStyle detect(String value) { |
||||
Assert.notNull(value, "Value must not be null"); |
||||
for (DurationStyle candidate : values()) { |
||||
if (candidate.matches(value)) { |
||||
return candidate; |
||||
} |
||||
} |
||||
throw new IllegalArgumentException("'" + value + "' is not a valid duration"); |
||||
} |
||||
|
||||
/** |
||||
* Units that we support. |
||||
*/ |
||||
enum Unit { |
||||
|
||||
/** |
||||
* Milliseconds. |
||||
*/ |
||||
MILLIS(ChronoUnit.MILLIS, "ms", Duration::toMillis), |
||||
|
||||
/** |
||||
* Seconds. |
||||
*/ |
||||
SECONDS(ChronoUnit.SECONDS, "s", Duration::getSeconds), |
||||
|
||||
/** |
||||
* Minutes. |
||||
*/ |
||||
MINUTES(ChronoUnit.MINUTES, "m", Duration::toMinutes), |
||||
|
||||
/** |
||||
* Hours. |
||||
*/ |
||||
HOURS(ChronoUnit.HOURS, "h", Duration::toHours), |
||||
|
||||
/** |
||||
* Days. |
||||
*/ |
||||
DAYS(ChronoUnit.DAYS, "d", Duration::toDays); |
||||
|
||||
private final ChronoUnit chronoUnit; |
||||
|
||||
private final String suffix; |
||||
|
||||
private final Function<Duration, Long> longValue; |
||||
|
||||
Unit(ChronoUnit chronoUnit, String suffix, Function<Duration, Long> toUnit) { |
||||
this.chronoUnit = chronoUnit; |
||||
this.suffix = suffix; |
||||
this.longValue = toUnit; |
||||
} |
||||
|
||||
public Duration parse(String value) { |
||||
return Duration.of(Long.parseLong(value), this.chronoUnit); |
||||
} |
||||
|
||||
public long longValue(Duration value) { |
||||
return this.longValue.apply(value); |
||||
} |
||||
|
||||
public static Unit fromChronoUnit(ChronoUnit chronoUnit) { |
||||
if (chronoUnit == null) { |
||||
return Unit.MILLIS; |
||||
} |
||||
for (Unit candidate : values()) { |
||||
if (candidate.chronoUnit == chronoUnit) { |
||||
return candidate; |
||||
} |
||||
} |
||||
throw new IllegalArgumentException("Unknown unit " + chronoUnit); |
||||
} |
||||
|
||||
public static Unit fromSuffix(String suffix) { |
||||
for (Unit candidate : values()) { |
||||
if (candidate.suffix.equalsIgnoreCase(suffix)) { |
||||
return candidate; |
||||
} |
||||
} |
||||
throw new IllegalArgumentException("Unknown unit '" + suffix + "'"); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,96 @@
@@ -0,0 +1,96 @@
|
||||
/* |
||||
* Copyright 2024 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
package org.springframework.data.mongodb.util; |
||||
|
||||
import java.time.Duration; |
||||
import java.util.function.Supplier; |
||||
|
||||
import org.springframework.core.env.Environment; |
||||
import org.springframework.data.expression.ValueEvaluationContext; |
||||
import org.springframework.data.expression.ValueExpression; |
||||
import org.springframework.data.expression.ValueExpressionParser; |
||||
import org.springframework.expression.EvaluationContext; |
||||
import org.springframework.expression.spel.standard.SpelExpressionParser; |
||||
import org.springframework.format.datetime.standard.DurationFormatterUtils; |
||||
import org.springframework.lang.Nullable; |
||||
|
||||
/** |
||||
* Helper to evaluate Duration from expressions. |
||||
* |
||||
* @author Christoph Strobl |
||||
* @since 4.4 |
||||
*/ |
||||
public class DurationUtil { |
||||
|
||||
private static final ValueExpressionParser PARSER = ValueExpressionParser.create(SpelExpressionParser::new); |
||||
|
||||
/** |
||||
* Evaluates and potentially parses the given string representation into a {@link Duration} value. |
||||
* |
||||
* @param value the {@link String} representation of the duration to evaluate. |
||||
* @param evaluationContext context supplier for property and expression language evaluation. |
||||
* @return the evaluated duration. |
||||
*/ |
||||
public static Duration evaluate(String value, ValueEvaluationContext evaluationContext) { |
||||
|
||||
ValueExpression expression = PARSER.parse(value); |
||||
Object evaluatedTimeout = expression.evaluate(evaluationContext); |
||||
|
||||
if (evaluatedTimeout == null) { |
||||
return Duration.ZERO; |
||||
} |
||||
|
||||
if (evaluatedTimeout instanceof Duration duration) { |
||||
return duration; |
||||
} |
||||
|
||||
return parse(evaluatedTimeout.toString()); |
||||
} |
||||
|
||||
/** |
||||
* Evaluates and potentially parses the given string representation into a {@link Duration} value. |
||||
* |
||||
* @param value the {@link String} representation of the duration to evaluate. |
||||
* @param evaluationContext context supplier for expression language evaluation. |
||||
* @return the evaluated duration. |
||||
*/ |
||||
public static Duration evaluate(String value, Supplier<EvaluationContext> evaluationContext) { |
||||
|
||||
return evaluate(value, new ValueEvaluationContext() { |
||||
@Nullable |
||||
@Override |
||||
public Environment getEnvironment() { |
||||
return null; |
||||
} |
||||
|
||||
@Nullable |
||||
@Override |
||||
public EvaluationContext getEvaluationContext() { |
||||
return evaluationContext.get(); |
||||
} |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* |
||||
* @param duration duration string to parse. |
||||
* @return parsed {@link Duration}. |
||||
* @see DurationFormatterUtils |
||||
*/ |
||||
public static Duration parse(String duration) { |
||||
return DurationFormatterUtils.detectAndParse(duration); |
||||
} |
||||
} |
||||
Loading…
Reference in new issue