Initial support for JSpecify (#1594)

ryanjbaxter · web-flow · commit f409a1c76f18 · 2025-10-31T11:06:03.000-04:00
diff --git a/.mvn/jvm.config b/.mvn/jvm.config
@@ -1 +1,11 @@
--Xmx1024m -XX:CICompilerCount=1 -XX:TieredStopAtLevel=1 -Djava.security.egd=file:/dev/./urandom
+-Xmx1024m -XX:CICompilerCount=1 -XX:TieredStopAtLevel=1 -Djava.security.egd=file:/dev/./urandom
+--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED
diff --git a/pom.xml b/pom.xml
@@ -87,6 +87,7 @@
 		<bintray.package>commons</bintray.package>
 		<evictor.version>1.0.0</evictor.version>
 		<bouncycastle-bcprov-jdk18on.version>1.81</bouncycastle-bcprov-jdk18on.version>
+		<jspecify.enabled>true</jspecify.enabled>
 	</properties>
 	<build>
 		<plugins>
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/ServiceInstance.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/ServiceInstance.java
@@ -19,6 +19,8 @@
 import java.net.URI;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Represents an instance of a service in a discovery system.
  *
@@ -30,7 +32,7 @@ public interface ServiceInstance {
 	/**
 	 * @return The unique instance ID as registered.
 	 */
-	default String getInstanceId() {
+	default @Nullable String getInstanceId() {
 		return null;
 	}
 
@@ -67,7 +69,7 @@ default String getInstanceId() {
 	/**
 	 * @return The scheme of the service instance.
 	 */
-	default String getScheme() {
+	default @Nullable String getScheme() {
 		return null;
 	}
 
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/ManagementServerPortUtils.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/ManagementServerPortUtils.java
@@ -16,6 +16,8 @@
 
 package org.springframework.cloud.client.discovery;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;
@@ -71,7 +73,7 @@ public static boolean isSame(BeanFactory beanFactory) {
 		return get(beanFactory) == ManagementServerPort.SAME;
 	}
 
-	public static Integer getPort(BeanFactory beanFactory) {
+	public static @Nullable Integer getPort(BeanFactory beanFactory) {
 		if (!hasActuator) {
 			return null;
 		}
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/package-info.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud service discovery abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.client.discovery;
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancedRetryFactory.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancedRetryFactory.java
@@ -16,6 +16,8 @@
 
 package org.springframework.cloud.client.loadbalancer;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.retry.RetryListener;
 import org.springframework.retry.backoff.BackOffPolicy;
 import org.springframework.retry.backoff.NoBackOffPolicy;
@@ -33,7 +35,8 @@ public interface LoadBalancedRetryFactory {
 	 * @param serviceInstanceChooser Used to get the next server from a load balancer.
 	 * @return A retry policy for the service.
 	 */
-	default LoadBalancedRetryPolicy createRetryPolicy(String service, ServiceInstanceChooser serviceInstanceChooser) {
+	default @Nullable LoadBalancedRetryPolicy createRetryPolicy(String service,
+			ServiceInstanceChooser serviceInstanceChooser) {
 		return null;
 	}
 
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/package-info.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud load balancer abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.client.loadbalancer;
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/reactive/ReactiveLoadBalancer.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/reactive/ReactiveLoadBalancer.java
@@ -18,6 +18,7 @@
 
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
 import org.reactivestreams.Publisher;
 
 import org.springframework.cloud.client.loadbalancer.DefaultRequest;
@@ -54,7 +55,7 @@ default Publisher<Response<T>> choose() { // conflicting name
 
 	interface Factory<T> {
 
-		default LoadBalancerProperties getProperties(String serviceId) {
+		default @Nullable LoadBalancerProperties getProperties(String serviceId) {
 			return null;
 		}
 
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/package-info.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud client abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.client;
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/serviceregistry/package-info.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/serviceregistry/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud service registry abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.client.serviceregistry;
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/config/CommonsConfigAutoConfiguration.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/config/CommonsConfigAutoConfiguration.java
@@ -19,10 +19,11 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.lang.Nullable;
 import org.springframework.util.ObjectUtils;
 
 /**
@@ -34,7 +35,7 @@ public class CommonsConfigAutoConfiguration {
 
 	@Bean
 	public DefaultsBindHandlerAdvisor defaultsBindHandlerAdvisor(
-			@Nullable DefaultsBindHandlerAdvisor.MappingsProvider[] providers) {
+			DefaultsBindHandlerAdvisor.@Nullable MappingsProvider @Nullable [] providers) {
 		Map<ConfigurationPropertyName, ConfigurationPropertyName> additionalMappings = new HashMap<>();
 		if (!ObjectUtils.isEmpty(providers)) {
 			for (DefaultsBindHandlerAdvisor.MappingsProvider mappingsProvider : providers) {
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/package-info.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud commons utilities and abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.commons;
diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/util/InetUtils.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/util/InetUtils.java
@@ -32,6 +32,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 /**
  * @author Spencer Gibb
@@ -71,7 +72,7 @@ public HostInfo findFirstNonLoopbackHostInfo() {
 		return hostInfo;
 	}
 
-	public InetAddress findFirstNonLoopbackAddress() {
+	public @Nullable InetAddress findFirstNonLoopbackAddress() {
 		InetAddress result = null;
 		try {
 			int lowest = Integer.MAX_VALUE;
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/autoconfigure/package-info.java b/spring-cloud-context/src/main/java/org/springframework/cloud/autoconfigure/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud auto-configuration classes.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.autoconfigure;
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/package-info.java b/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud bootstrap abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.bootstrap;
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/support/OriginTrackedCompositePropertySource.java b/spring-cloud-context/src/main/java/org/springframework/cloud/bootstrap/support/OriginTrackedCompositePropertySource.java
@@ -16,6 +16,8 @@
 
 package org.springframework.cloud.bootstrap.support;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.origin.Origin;
 import org.springframework.boot.origin.OriginLookup;
 import org.springframework.core.env.CompositePropertySource;
@@ -33,7 +35,7 @@ public OriginTrackedCompositePropertySource(String name) {
 
 	@Override
 	@SuppressWarnings("unchecked")
-	public Origin getOrigin(String name) {
+	public @Nullable Origin getOrigin(String name) {
 		for (PropertySource<?> propertySource : getPropertySources()) {
 			if (propertySource instanceof OriginLookup lookup) {
 				Origin origin = lookup.getOrigin(name);
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/context/named/ClientFactoryObjectProvider.java b/spring-cloud-context/src/main/java/org/springframework/cloud/context/named/ClientFactoryObjectProvider.java
@@ -22,9 +22,10 @@
 import java.util.function.Supplier;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.ObjectProvider;
-import org.springframework.lang.Nullable;
 
 /**
  * Special ObjectProvider that allows the actual ObjectProvider to be resolved later
@@ -54,8 +55,7 @@ public T getObject(Object... args) throws BeansException {
 	}
 
 	@Override
-	@Nullable
-	public T getIfAvailable() throws BeansException {
+	public @Nullable T getIfAvailable() throws BeansException {
 		return delegate().getIfAvailable();
 	}
 
@@ -70,8 +70,7 @@ public void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException {
 	}
 
 	@Override
-	@Nullable
-	public T getIfUnique() throws BeansException {
+	public @Nullable T getIfUnique() throws BeansException {
 		return delegate().getIfUnique();
 	}
 
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/context/package-info.java b/spring-cloud-context/src/main/java/org/springframework/cloud/context/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-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.
+ */
+
+/**
+ * Spring Cloud context abstractions.
+ */
+@org.jspecify.annotations.NullMarked
+package org.springframework.cloud.context;
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/context/restart/RestartEndpoint.java b/spring-cloud-context/src/main/java/org/springframework/cloud/context/restart/RestartEndpoint.java
@@ -24,7 +24,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-//
+
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.config.BeanPostProcessor;
 import org.springframework.boot.SpringApplication;
diff --git a/spring-cloud-context/src/main/java/org/springframework/cloud/util/random/CachedRandomPropertySource.java b/spring-cloud-context/src/main/java/org/springframework/cloud/util/random/CachedRandomPropertySource.java
@@ -19,6 +19,8 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.env.PropertySource;
 import org.springframework.util.StringUtils;
 
@@ -44,7 +46,7 @@ public CachedRandomPropertySource(PropertySource randomValuePropertySource) {
 	}
 
 	@Override
-	public Object getProperty(String name) {
+	public @Nullable Object getProperty(String name) {
 		if (!name.startsWith(PREFIX) || name.length() == PREFIX.length()) {
 			return null;
 		}
diff --git a/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/cache/DefaultLoadBalancerCache.java b/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/cache/DefaultLoadBalancerCache.java
diff --git a/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/cache/DefaultLoadBalancerCacheManager.java b/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/cache/DefaultLoadBalancerCacheManager.java
diff --git a/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/core/ServiceInstanceListSupplierBuilder.java b/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/core/ServiceInstanceListSupplierBuilder.java
diff --git a/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/core/package-info.java b/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/core/package-info.java
diff --git a/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/package-info.java b/spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/package-info.java

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`
`17`	`17`	`package org.springframework.cloud.client.discovery;`
`18`	`18`
	`19`	`+import org.jspecify.annotations.Nullable;`
	`20`	`+`
`19`	`21`	`import org.springframework.beans.factory.BeanFactory;`
`20`	`22`	`import org.springframework.beans.factory.NoSuchBeanDefinitionException;`
`21`	`23`	`import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;`
`@@ -71,7 +73,7 @@ public static boolean isSame(BeanFactory beanFactory) {`
`71`	`73`	`return get(beanFactory) == ManagementServerPort.SAME;`
`72`	`74`	`}`
`73`	`75`
`74`		`- public static Integer getPort(BeanFactory beanFactory) {`
	`76`	`+ public static @Nullable Integer getPort(BeanFactory beanFactory) {`
`75`	`77`	`if (!hasActuator) {`
`76`	`78`	`return null;`
`77`	`79`	`}`