Move SpelTagValueExpressionResolver to metrics package. Fix checkstyle.

doumdoum · doumdoum · commit e908e8828513 · 2025-06-25T23:51:38.000+02:00
Signed-off-by: Dominique Villard &lt;dominique.villard@doctolib.com&gt;
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsAspectsAutoConfiguration.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsAspectsAutoConfiguration.java
@@ -24,7 +24,6 @@
 import org.aspectj.weaver.Advice;
 
 import org.springframework.beans.factory.BeanFactory;
-import org.springframework.boot.actuate.autoconfigure.tracing.SpelTagValueExpressionResolver;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -38,6 +37,7 @@
  * aspects.
  *
  * @author Jonatan Ivanov
+ * @author Dominique Villard
  * @since 3.2.0
  */
 @AutoConfiguration(after = { MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class })
@@ -48,33 +48,34 @@ public class MetricsAspectsAutoConfiguration {
 
 	@Bean
 	@ConditionalOnMissingBean
-	CountedAspect countedAspect(MeterRegistry registry, CountedMeterTagAnnotationHandler countedMeterTagAnnotationHandler) {
+	CountedAspect countedAspect(MeterRegistry registry,
+			CountedMeterTagAnnotationHandler countedMeterTagAnnotationHandler) {
 		CountedAspect countedAspect = new CountedAspect(registry);
 		countedAspect.setMeterTagAnnotationHandler(countedMeterTagAnnotationHandler);
 		return countedAspect;
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	TimedAspect timedAspect(MeterRegistry registry,
-			MeterTagAnnotationHandler meterTagAnnotationHandler) {
+	TimedAspect timedAspect(MeterRegistry registry, MeterTagAnnotationHandler meterTagAnnotationHandler) {
 		TimedAspect timedAspect = new TimedAspect(registry);
 		timedAspect.setMeterTagAnnotationHandler(meterTagAnnotationHandler);
 		return timedAspect;
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	CountedMeterTagAnnotationHandler countedMeterTagAnnotationHandler(
-			BeanFactory beanFactory, SpelTagValueExpressionResolver metricsTagValueExpressionResolver) {
-		return new CountedMeterTagAnnotationHandler(beanFactory::getBean, ignored -> metricsTagValueExpressionResolver);
+	CountedMeterTagAnnotationHandler countedMeterTagAnnotationHandler(BeanFactory beanFactory,
+			SpelTagValueExpressionResolver metricsTagValueExpressionResolver) {
+		return new CountedMeterTagAnnotationHandler(beanFactory::getBean,
+				(ignored) -> metricsTagValueExpressionResolver);
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	MeterTagAnnotationHandler meterTagAnnotationHandler(
-			BeanFactory beanFactory, SpelTagValueExpressionResolver meterTagValueExpressionResolver) {
-		return new MeterTagAnnotationHandler(beanFactory::getBean, ignored -> meterTagValueExpressionResolver);
+	MeterTagAnnotationHandler meterTagAnnotationHandler(BeanFactory beanFactory,
+			SpelTagValueExpressionResolver meterTagValueExpressionResolver) {
+		return new MeterTagAnnotationHandler(beanFactory::getBean, (ignored) -> meterTagValueExpressionResolver);
 	}
 
 	@Bean
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/SpelTagValueExpressionResolver.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/SpelTagValueExpressionResolver.java
@@ -14,25 +14,35 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.tracing;
+package org.springframework.boot.actuate.autoconfigure.metrics;
 
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
 import io.micrometer.common.annotation.ValueExpressionResolver;
+import io.micrometer.core.aop.MeterTag;
+import io.micrometer.tracing.annotation.SpanTag;
 
 import org.springframework.expression.Expression;
 import org.springframework.expression.spel.standard.SpelExpressionParser;
 import org.springframework.expression.spel.support.SimpleEvaluationContext;
 
+/**
+ * Evaluates a Spel expression applied to a parameter for use in {@link MeterTag}
+ * {@link SpanTag} Micrometer annotations.
+ *
+ * @author Dominique Villard
+ * @since 3.5.1
+ */
 public class SpelTagValueExpressionResolver implements ValueExpressionResolver {
 
 	private final Map<String, Expression> expressionMap = new ConcurrentHashMap<>();
 
 	@Override
 	public String resolve(String expression, Object parameter) {
 		try {
-			Expression expressionValue = this.expressionMap.computeIfAbsent(expression, SpelTagValueExpressionResolver::parseExpression);
+			Expression expressionValue = this.expressionMap.computeIfAbsent(expression,
+					SpelTagValueExpressionResolver::parseExpression);
 			SimpleEvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();
 			return expressionValue.getValue(context, parameter, String.class);
 		}
@@ -44,4 +54,5 @@ public String resolve(String expression, Object parameter) {
 	private static Expression parseExpression(String expression) {
 		return new SpelExpressionParser().parseExpression(expression);
 	}
+
 }
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/MicrometerTracingAutoConfiguration.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/MicrometerTracingAutoConfiguration.java
@@ -30,6 +30,7 @@
 import org.aspectj.weaver.Advice;
 
 import org.springframework.beans.factory.BeanFactory;
+import org.springframework.boot.actuate.autoconfigure.metrics.SpelTagValueExpressionResolver;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -114,7 +115,8 @@ SpelTagValueExpressionResolver spanTagValueExpressionResolver() {
 
 		@Bean
 		@ConditionalOnMissingBean
-		SpanTagAnnotationHandler spanTagAnnotationHandler(BeanFactory beanFactory, SpelTagValueExpressionResolver spanTagValueExpressionResolver) {
+		SpanTagAnnotationHandler spanTagAnnotationHandler(BeanFactory beanFactory,
+				SpelTagValueExpressionResolver spanTagValueExpressionResolver) {
 			return new SpanTagAnnotationHandler(beanFactory::getBean, (ignored) -> spanTagValueExpressionResolver);
 		}
 
@@ -132,4 +134,5 @@ SpanAspect spanAspect(MethodInvocationProcessor methodInvocationProcessor) {
 		}
 
 	}
+
 }
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsAspectsAutoConfigurationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsAspectsAutoConfigurationTests.java
@@ -77,7 +77,7 @@ void shouldConfigureCounterMeterTagAnnotationHandler() {
 		this.contextRunner.withUserConfiguration(MeterTagAnnotationHandlerConfiguration.class).run((context) -> {
 			assertThat(context).hasSingleBean(CountedAspect.class);
 			assertThat(ReflectionTestUtils.getField(context.getBean(CountedAspect.class), "meterTagAnnotationHandler"))
-					.isSameAs(context.getBean(CountedMeterTagAnnotationHandler.class));
+				.isSameAs(context.getBean(CountedMeterTagAnnotationHandler.class));
 		});
 	}
 
@@ -142,6 +142,7 @@ MeterTagAnnotationHandler meterTagAnnotationHandler() {
 		CountedMeterTagAnnotationHandler countedMeterTagAnnotationHandler() {
 			return new CountedMeterTagAnnotationHandler(null, null);
 		}
+
 	}
 
 }
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/SpelTagValueExpressionResolverTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/SpelTagValueExpressionResolverTests.java
@@ -16,6 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics;
 
+import java.util.Collections;
 import java.util.Map;
 import java.util.stream.Stream;
 
@@ -24,14 +25,13 @@
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 
-import org.springframework.boot.actuate.autoconfigure.tracing.SpelTagValueExpressionResolver;
 import org.springframework.data.util.Pair;
 import org.springframework.test.util.ReflectionTestUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
 
-class SpelTagValueExpressionResolverTest {
+class SpelTagValueExpressionResolverTests {
 
 	final SpelTagValueExpressionResolver resolver = new SpelTagValueExpressionResolver();
 
@@ -42,9 +42,7 @@ void checkValidExpression(Object value, String expression, String expected) {
 	}
 
 	static Stream<Arguments> checkValidExpression() {
-		return Stream.of(
-				Arguments.of("foo", "length", "3"),
-				Arguments.of("foo", "isEmpty", "false"),
+		return Stream.of(Arguments.of("foo", "length", "3"), Arguments.of("foo", "isEmpty", "false"),
 				Arguments.of(Pair.of("left", "right"), "first", "left"),
 				Arguments.of(Map.of("foo", "bar"), "['foo']", "bar"),
 				Arguments.of(Map.of("foo", "bar"), "['baz']", null),
@@ -55,20 +53,18 @@ static Stream<Arguments> checkValidExpression() {
 	@ParameterizedTest
 	@MethodSource
 	void checkInvalidExpression(Object value, String expression) {
-		assertThatExceptionOfType(IllegalStateException.class).isThrownBy(() -> this.resolver.resolve(expression, value));
+		assertThatIllegalStateException().isThrownBy(() -> this.resolver.resolve(expression, value));
 	}
 
 	static Stream<Arguments> checkInvalidExpression() {
-		return Stream.of(
-				Arguments.of("foo", "unknownMethod"),
-				Arguments.of(null, "length"),
+		return Stream.of(Arguments.of("foo", "unknownMethod"), Arguments.of(null, "length"),
 				Arguments.of(Map.of("foo", Pair.of(1, 2)), "['bar'].first"),
-				Arguments.of(Map.of(), "invalid expression"));
+				Arguments.of(Collections.emptyMap(), "invalid expression"));
 	}
 
 	@Test
 	void checkParserReuse() {
-		var map = (Map<?, ?>) ReflectionTestUtils.getField(this.resolver,"expressionMap");
+		var map = (Map<?, ?>) ReflectionTestUtils.getField(this.resolver, "expressionMap");
 
 		this.resolver.resolve("length", "foo");
 		this.resolver.resolve("length", "bar");
@@ -78,4 +74,5 @@ void checkParserReuse() {
 		this.resolver.resolve("isEmpty", "foo");
 		assertThat(map).hasSize(2);
 	}
-}
+
+}
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/MicrometerTracingAutoConfigurationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/MicrometerTracingAutoConfigurationTests.java
@@ -35,6 +35,7 @@
 import org.aspectj.weaver.Advice;
 import org.junit.jupiter.api.Test;
 
+import org.springframework.boot.actuate.autoconfigure.metrics.SpelTagValueExpressionResolver;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -245,6 +246,7 @@ SpanTagAnnotationHandler customSpanTagAnnotationHandler() {
 		SpelTagValueExpressionResolver customMetricsTagValueExpressionResolver() {
 			return mock(SpelTagValueExpressionResolver.class);
 		}
+
 	}
 
 	@Configuration(proxyBeanMethods = false)

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@`
`30`	`30`	`import org.aspectj.weaver.Advice;`
`31`	`31`
`32`	`32`	`import org.springframework.beans.factory.BeanFactory;`
	`33`	`+import org.springframework.boot.actuate.autoconfigure.metrics.SpelTagValueExpressionResolver;`
`33`	`34`	`import org.springframework.boot.autoconfigure.AutoConfiguration;`
`34`	`35`	`import org.springframework.boot.autoconfigure.EnableAutoConfiguration;`
`35`	`36`	`import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;`
`@@ -114,7 +115,8 @@ SpelTagValueExpressionResolver spanTagValueExpressionResolver() {`
`114`	`115`
`115`	`116`	`@Bean`
`116`	`117`	`@ConditionalOnMissingBean`
`117`		`- SpanTagAnnotationHandler spanTagAnnotationHandler(BeanFactory beanFactory, SpelTagValueExpressionResolver spanTagValueExpressionResolver) {`
	`118`	`+ SpanTagAnnotationHandler spanTagAnnotationHandler(BeanFactory beanFactory,`
	`119`	`+ SpelTagValueExpressionResolver spanTagValueExpressionResolver) {`
`118`	`120`	`return new SpanTagAnnotationHandler(beanFactory::getBean, (ignored) -> spanTagValueExpressionResolver);`
`119`	`121`	`}`
`120`	`122`
`@@ -132,4 +134,5 @@ SpanAspect spanAspect(MethodInvocationProcessor methodInvocationProcessor) {`
`132`	`134`	`}`
`133`	`135`
`134`	`136`	`}`
	`137`	`+`
`135`	`138`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ void shouldConfigureCounterMeterTagAnnotationHandler() {`
`77`	`77`	`this.contextRunner.withUserConfiguration(MeterTagAnnotationHandlerConfiguration.class).run((context) -> {`
`78`	`78`	`assertThat(context).hasSingleBean(CountedAspect.class);`
`79`	`79`	`assertThat(ReflectionTestUtils.getField(context.getBean(CountedAspect.class), "meterTagAnnotationHandler"))`
`80`		`- .isSameAs(context.getBean(CountedMeterTagAnnotationHandler.class));`
	`80`	`+ .isSameAs(context.getBean(CountedMeterTagAnnotationHandler.class));`
`81`	`81`	`});`
`82`	`82`	`}`
`83`	`83`
`@@ -142,6 +142,7 @@ MeterTagAnnotationHandler meterTagAnnotationHandler() {`
`142`	`142`	`CountedMeterTagAnnotationHandler countedMeterTagAnnotationHandler() {`
`143`	`143`	`return new CountedMeterTagAnnotationHandler(null, null);`
`144`	`144`	`}`
	`145`	`+`
`145`	`146`	`}`
`146`	`147`
`147`	`148`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@`
`35`	`35`	`import org.aspectj.weaver.Advice;`
`36`	`36`	`import org.junit.jupiter.api.Test;`
`37`	`37`
	`38`	`+import org.springframework.boot.actuate.autoconfigure.metrics.SpelTagValueExpressionResolver;`
`38`	`39`	`import org.springframework.boot.autoconfigure.AutoConfigurations;`
`39`	`40`	`import org.springframework.boot.test.context.FilteredClassLoader;`
`40`	`41`	`import org.springframework.boot.test.context.runner.ApplicationContextRunner;`
`@@ -245,6 +246,7 @@ SpanTagAnnotationHandler customSpanTagAnnotationHandler() {`
`245`	`246`	`SpelTagValueExpressionResolver customMetricsTagValueExpressionResolver() {`
`246`	`247`	`return mock(SpelTagValueExpressionResolver.class);`
`247`	`248`	`}`
	`249`	`+`
`248`	`250`	`}`
`249`	`251`
`250`	`252`	`@Configuration(proxyBeanMethods = false)`