Enforce using @ConfigurationProperties("xxx") instead of @ConfigurationProperties(prefix = "xxx")

Signed-off-by: Yanming Zhou <[email protected]>

Author: quaff

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the original author or authors.
+ * Copyright 2012-2025 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.
@@ -39,6 +39,7 @@
 import com.tngtech.archunit.core.domain.JavaParameter;
 import com.tngtech.archunit.core.domain.JavaType;
 import com.tngtech.archunit.core.domain.properties.CanBeAnnotated;
+import com.tngtech.archunit.core.domain.properties.HasAnnotations;
 import com.tngtech.archunit.core.domain.properties.HasName;
 import com.tngtech.archunit.core.domain.properties.HasOwner.Predicates.With;
 import com.tngtech.archunit.core.domain.properties.HasParameterTypes;
@@ -95,7 +96,9 @@ public ArchitectureCheck() {
 				noClassesShouldLoadResourcesUsingResourceUtils(), noClassesShouldCallStringToUpperCaseWithoutLocale(),
 				noClassesShouldCallStringToLowerCaseWithoutLocale(),
 				conditionalOnMissingBeanShouldNotSpecifyOnlyATypeThatIsTheSameAsMethodReturnType(),
-				enumSourceShouldNotSpecifyOnlyATypeThatIsTheSameAsMethodParameterType());
+				enumSourceShouldNotSpecifyOnlyATypeThatIsTheSameAsMethodParameterType(),
+				classLevelConfigurationPropertiesShouldNotSpecifyOnlyPrefixAttribute(),
+				methodLevelConfigurationPropertiesShouldNotSpecifyOnlyPrefixAttribute());
 		getRules().addAll(getProhibitObjectsRequireNonNull()
 			.map((prohibit) -> prohibit ? noClassesShouldCallObjectsRequireNonNull() : Collections.emptyList()));
 		getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));
@@ -329,6 +332,39 @@ public void check(JavaMethod item, ConditionEvents events) {
 		};
 	}
 
+	private ArchRule classLevelConfigurationPropertiesShouldNotSpecifyOnlyPrefixAttribute() {
+		return ArchRuleDefinition.classes()
+			.that()
+			.areAnnotatedWith("org.springframework.boot.context.properties.ConfigurationProperties")
+			.should(notSpecifyOnlyPrefixAttributeOfConfigurationProperties())
+			.allowEmptyShould(true);
+	}
+
+	private ArchRule methodLevelConfigurationPropertiesShouldNotSpecifyOnlyPrefixAttribute() {
+		return ArchRuleDefinition.methods()
+			.that()
+			.areAnnotatedWith("org.springframework.boot.context.properties.ConfigurationProperties")
+			.should(notSpecifyOnlyPrefixAttributeOfConfigurationProperties())
+			.allowEmptyShould(true);
+	}
+
+	private ArchCondition<? super HasAnnotations<?>> notSpecifyOnlyPrefixAttributeOfConfigurationProperties() {
+		return new ArchCondition<>("not specify only prefix attribute of @ConfigurationProperties") {
+
+			@Override
+			public void check(HasAnnotations<?> item, ConditionEvents events) {
+				JavaAnnotation<?> configurationProperties = item
+					.getAnnotationOfType("org.springframework.boot.context.properties.ConfigurationProperties");
+				Map<String, Object> properties = configurationProperties.getProperties();
+				if (properties.size() == 1 && properties.containsKey("prefix")) {
+					events.add(SimpleConditionEvent.violated(item, configurationProperties.getDescription()
+							+ " should specify implicit 'value' attribute other than explicit 'prefix' attribute"));
+				}
+			}
+
+		};
+	}
+
 	public void setClasses(FileCollection classes) {
 		this.classes = classes;
 	}