Merge pull request #46854 from wonyongg

* pr/46854:
  Polish "Support additional nullness signal for Actuator endpoints"
  Support additional nullness signal for Actuator endpoints

Closes gh-46854

Author: snicoll

configuration-metadata/spring-boot-configuration-processor/build.gradle

@@ -36,6 +36,7 @@ architectureCheck {
 
 dependencies {
 	testCompileOnly("com.google.code.findbugs:jsr305:3.0.2")
+	testCompileOnly("org.jspecify:jspecify")
 
 	testImplementation(enforcedPlatform(project(":platform:spring-boot-dependencies")))
 	testImplementation(project(":test-support:spring-boot-test-support"))

configuration-metadata/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/MetadataGenerationEnvironment.java

@@ -55,7 +55,7 @@
  */
 class MetadataGenerationEnvironment {
 
-	private static final String NULLABLE_ANNOTATION = "org.springframework.lang.Nullable";
+	private static final String NULLABLE_ANNOTATION = "org.jspecify.annotations.Nullable";
 
 	private static final Set<String> TYPE_EXCLUDES = Set.of("com.zaxxer.hikari.IConnectionCustomizer",
 			"groovy.lang.MetaClass", "groovy.text.markup.MarkupTemplateEngine", "java.io.Writer", "java.io.PrintWriter",
@@ -269,6 +269,17 @@ AnnotationMirror getAnnotation(Element element, String type) {
 		return null;
 	}
 
+	private AnnotationMirror getTypeUseAnnotation(Element element, String type) {
+		if (element != null) {
+			for (AnnotationMirror annotation : element.asType().getAnnotationMirrors()) {
+				if (type.equals(annotation.getAnnotationType().toString())) {
+					return annotation;
+				}
+			}
+		}
+		return null;
+	}
+
 	/**
 	 * Collect the annotations that are annotated or meta-annotated with the specified
 	 * {@link TypeElement annotation}.
@@ -368,7 +379,7 @@ AnnotationMirror getNameAnnotation(Element element) {
 	}
 
 	boolean hasNullableAnnotation(Element element) {
-		return getAnnotation(element, NULLABLE_ANNOTATION) != null;
+		return getTypeUseAnnotation(element, NULLABLE_ANNOTATION) != null;
 	}
 
 	boolean hasOptionalParameterAnnotation(Element element) {

configuration-metadata/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/EndpointMetadataGenerationTests.java

@@ -28,6 +28,8 @@
 import org.springframework.boot.configurationsample.endpoint.CustomPropertiesEndpoint;
 import org.springframework.boot.configurationsample.endpoint.EnabledEndpoint;
 import org.springframework.boot.configurationsample.endpoint.NoAccessEndpoint;
+import org.springframework.boot.configurationsample.endpoint.NullableParameterEndpoint;
+import org.springframework.boot.configurationsample.endpoint.OptionalParameterEndpoint;
 import org.springframework.boot.configurationsample.endpoint.ReadOnlyAccessEndpoint;
 import org.springframework.boot.configurationsample.endpoint.SimpleEndpoint;
 import org.springframework.boot.configurationsample.endpoint.SimpleEndpoint2;
@@ -45,6 +47,7 @@
  * @author Stephane Nicoll
  * @author Scott Frederick
  * @author Moritz Halbritter
+ * @author Wonyong Hwang
  */
 class EndpointMetadataGenerationTests extends AbstractMetadataGenerationTests {
 
@@ -192,6 +195,26 @@ void shouldFailIfEndpointWithSameIdButWithConflictingEnabledByDefaultSetting() {
 					"Existing property 'management.endpoint.simple.access' from type org.springframework.boot.configurationsample.endpoint.SimpleEndpoint has a conflicting value. Existing value: unrestricted, new value from type org.springframework.boot.configurationsample.endpoint.SimpleEndpoint3: none");
 	}
 
+	@Test
+	void endpointWithNullableParameter() {
+		ConfigurationMetadata metadata = compile(NullableParameterEndpoint.class);
+		assertThat(metadata)
+			.has(Metadata.withGroup("management.endpoint.nullable").fromSource(NullableParameterEndpoint.class));
+		assertThat(metadata).has(access("nullable", Access.UNRESTRICTED));
+		assertThat(metadata).has(cacheTtl("nullable"));
+		assertThat(metadata.getItems()).hasSize(3);
+	}
+
+	@Test
+	void endpointWithOptionalParameter() {
+		ConfigurationMetadata metadata = compile(OptionalParameterEndpoint.class);
+		assertThat(metadata)
+			.has(Metadata.withGroup("management.endpoint.optional").fromSource(OptionalParameterEndpoint.class));
+		assertThat(metadata).has(access("optional", Access.UNRESTRICTED));
+		assertThat(metadata).has(cacheTtl("optional"));
+		assertThat(metadata.getItems()).hasSize(3);
+	}
+
 	private Metadata.MetadataItemCondition access(String endpointId, Access defaultValue) {
 		return defaultAccess(endpointId, endpointId, defaultValue);
 	}

configuration-metadata/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/NullableParameterEndpoint.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2012-present 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.boot.configurationsample.endpoint;
+
+import org.jspecify.annotations.Nullable;
+
+import org.springframework.boot.configurationsample.Endpoint;
+import org.springframework.boot.configurationsample.ReadOperation;
+
+/**
+ * An endpoint that uses {@code Nullable} to signal an optional parameter.
+ *
+ * @author Wonyong Hwang
+ */
+@Endpoint(id = "nullable")
+public class NullableParameterEndpoint {
+
+	@ReadOperation
+	public String invoke(@Nullable String parameter) {
+		return "test with " + parameter;
+	}
+
+}

configuration-metadata/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/OptionalParameterEndpoint.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2012-present 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.boot.configurationsample.endpoint;
+
+import org.springframework.boot.configurationsample.Endpoint;
+import org.springframework.boot.configurationsample.OptionalParameter;
+import org.springframework.boot.configurationsample.ReadOperation;
+
+/**
+ * An endpoint that uses {@code OptionalParameter} to signal an optional parameter.
+ *
+ * @author Wonyong Hwang
+ */
+@Endpoint(id = "optional")
+public class OptionalParameterEndpoint {
+
+	@ReadOperation
+	public String invoke(@OptionalParameter String parameter) {
+		return "test with " + parameter;
+	}
+
+}