Add rule to prevent calls to Objects.requireNonNull()

Author: ivamly

buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java

@@ -23,6 +23,7 @@
 import java.nio.file.Files;
 import java.nio.file.StandardOpenOption;
 import java.util.List;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 import com.tngtech.archunit.base.DescribedPredicate;
@@ -83,7 +84,7 @@ public ArchitectureCheck() {
 				noClassesShouldCallStepVerifierStepVerifyComplete(),
 				noClassesShouldConfigureDefaultStepVerifierTimeout(), noClassesShouldCallCollectorsToList(),
 				noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding(),
-				noClassesShouldLoadResourcesUsingResourceUtils());
+				noClassesShouldLoadResourcesUsingResourceUtils(), noClassesShouldCallObjectsRequireNonNull());
 		getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));
 	}
 
@@ -228,6 +229,15 @@ private ArchRule noClassesShouldLoadResourcesUsingResourceUtils() {
 			.because("org.springframework.boot.io.ApplicationResourceLoader should be used instead");
 	}
 
+	private ArchRule noClassesShouldCallObjectsRequireNonNull() {
+		return ArchRuleDefinition.noClasses()
+			.should()
+			.callMethod(Objects.class, "requireNonNull", Object.class)
+			.orShould()
+			.callMethod(Objects.class, "requireNonNull", Object.class, String.class)
+			.because("org.springframework.utils.Assert.notNull() should be used instead");
+	}
+
 	public void setClasses(FileCollection classes) {
 		this.classes = classes;
 	}

buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java

@@ -138,6 +138,22 @@ void whenClassUsesResourceUtilsWithoutLoadingResourcesTaskSucceedsAndWritesAnEmp
 		});
 	}
 
+	@Test
+	void whenClassCallsObjectsRequireNonNullTaskFailsAndWritesReport() throws Exception {
+		prepareTask("objects/requireNonNull", (architectureCheck) -> {
+			assertThatExceptionOfType(GradleException.class).isThrownBy(architectureCheck::checkArchitecture);
+			assertThat(failureReport(architectureCheck)).isNotEmpty();
+		});
+	}
+
+	@Test
+	void whenClassDoesNotCallObjectsRequireNonNullTaskSucceedsAndWritesAnEmptyReport() throws Exception {
+		prepareTask("objects/noRequireNonNull", (architectureCheck) -> {
+			architectureCheck.checkArchitecture();
+			assertThat(failureReport(architectureCheck)).isEmpty();
+		});
+	}
+
 	private void prepareTask(String classes, Callback<ArchitectureCheck> callback) throws Exception {
 		File projectDir = new File(this.temp, "project");
 		projectDir.mkdirs();

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/noRequireNonNull/AssertNotNullUsage.java

@@ -0,0 +1,38 @@
+/*
+ * 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.boot.build.architecture.objects.noRequireNonNull;
+
+import org.springframework.util.Assert;
+
+/**
+ * This class is used to test the use of `Assert.notNull` for null-checking. It is
+ * intended to demonstrate an acceptable approach according to the architecture check
+ * rules.
+ *
+ * @author Ivan Malutin
+ */
+public class AssertNotNullUsage {
+
+	/**
+	 * Validates that the provided object is not null using `Assert.notNull`. This method
+	 * is compliant with the architecture check rules.
+	 */
+	public void ensureObjectNotNull() {
+		Assert.notNull(new Object(), "The object must not be null");
+	}
+
+}

buildSrc/src/test/java/org/springframework/boot/build/architecture/objects/requireNonNull/RequireNonNullUsage.java

@@ -0,0 +1,38 @@
+/*
+ * 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.boot.build.architecture.objects.requireNonNull;
+
+import java.util.Objects;
+
+/**
+ * This class is used to test the use of `Objects.requireNonNull` for null-checking. It is
+ * intended to demonstrate a scenario that should trigger a failure in the architecture
+ * check.
+ *
+ * @author Ivan Malutin
+ */
+public class RequireNonNullUsage {
+
+	/**
+	 * Validates that the provided object is not null using `Objects.requireNonNull`. This
+	 * method is expected to trigger a failure according to the architecture check rules.
+	 */
+	public void validateObject() {
+		Objects.requireNonNull(new Object(), "The object cannot be null");
+	}
+
+}