OnPropertyCondition Class — spring-boot Architecture

Source Code

core/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/OnPropertyCondition.java lines 52–211

@Order(Ordered.HIGHEST_PRECEDENCE + 40)
class OnPropertyCondition extends SpringBootCondition {

	@Override
	public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
		MergedAnnotations mergedAnnotations = metadata.getAnnotations();
		List<MergedAnnotation<Annotation>> annotations = stream(mergedAnnotations).toList();
		List<ConditionMessage> noMatch = new ArrayList<>();
		List<ConditionMessage> match = new ArrayList<>();
		for (MergedAnnotation<Annotation> annotation : annotations) {
			ConditionOutcome outcome = determineOutcome(annotation, context.getEnvironment());
			(outcome.isMatch() ? match : noMatch).add(outcome.getConditionMessage());
		}
		if (!noMatch.isEmpty()) {
			return ConditionOutcome.noMatch(ConditionMessage.of(noMatch));
		}
		return ConditionOutcome.match(ConditionMessage.of(match));
	}

	private Stream<MergedAnnotation<Annotation>> stream(MergedAnnotations mergedAnnotations) {
		return Stream.concat(stream(mergedAnnotations, ConditionalOnProperty.class, ConditionalOnProperties.class),
				stream(mergedAnnotations, ConditionalOnBooleanProperty.class, ConditionalOnBooleanProperties.class));
	}

	private Stream<MergedAnnotation<Annotation>> stream(MergedAnnotations mergedAnnotations,
			Class<? extends Annotation> type, Class<? extends Annotation> containerType) {
		return Stream.concat(stream(mergedAnnotations, type), streamRepeated(mergedAnnotations, type, containerType));
	}

	private Stream<MergedAnnotation<Annotation>> streamRepeated(MergedAnnotations mergedAnnotations,
			Class<? extends Annotation> type, Class<? extends Annotation> containerType) {
		return stream(mergedAnnotations, containerType).flatMap((container) -> streamRepeated(container, type));
	}

	@SuppressWarnings("unchecked")
	private Stream<MergedAnnotation<Annotation>> streamRepeated(MergedAnnotation<Annotation> container,
			Class<? extends Annotation> type) {
		MergedAnnotation<? extends Annotation>[] repeated = container.getAnnotationArray(MergedAnnotation.VALUE, type);
		return Arrays.stream((MergedAnnotation<Annotation>[]) repeated);
	}

	private Stream<MergedAnnotation<Annotation>> stream(MergedAnnotations annotations,
			Class<? extends Annotation> type) {
		return annotations.stream(type.getName())
			.filter(MergedAnnotationPredicates.unique(MergedAnnotation::getMetaTypes));
	}

	private ConditionOutcome determineOutcome(MergedAnnotation<Annotation> annotation, PropertyResolver resolver) {
		Class<Annotation> annotationType = annotation.getType();
		Spec spec = new Spec(annotationType, annotation.asAnnotationAttributes());
		List<String> missingProperties = new ArrayList<>();
		List<String> nonMatchingProperties = new ArrayList<>();
		spec.collectProperties(resolver, missingProperties, nonMatchingProperties);
		if (!missingProperties.isEmpty()) {
			return ConditionOutcome.noMatch(ConditionMessage.forCondition(annotationType, spec)
				.didNotFind("property", "properties")
				.items(Style.QUOTE, missingProperties));
		}
		if (!nonMatchingProperties.isEmpty()) {
			return ConditionOutcome.noMatch(ConditionMessage.forCondition(annotationType, spec)
				.found("different value in property", "different value in properties")
				.items(Style.QUOTE, nonMatchingProperties));
		}
		return ConditionOutcome.match(ConditionMessage.forCondition(annotationType, spec).because("matched"));
	}

	private static class Spec {

		private final Class<? extends Annotation> annotationType;

		private final String prefix;

		private final String[] names;

		private final String havingValue;

		private final boolean matchIfMissing;

		Spec(Class<? extends Annotation> annotationType, AnnotationAttributes annotationAttributes) {
			this.annotationType = annotationType;
			this.prefix = (!annotationAttributes.containsKey("prefix")) ? "" : getPrefix(annotationAttributes);
			this.names = getNames(annotationAttributes);
			this.havingValue = getHavingValue(annotationAttributes);
			this.matchIfMissing = annotationAttributes.getBoolean("matchIfMissing");
		}

		private static String getHavingValue(AnnotationAttributes annotationAttributes) {
			Object havingValue = annotationAttributes.get("havingValue");
			Assert.state(havingValue != null, "'havingValue' must not be null");
			return havingValue.toString();
		}

		private String getPrefix(AnnotationAttributes annotationAttributes) {
			String prefix = annotationAttributes.getString("prefix").trim();
			if (StringUtils.hasText(prefix) && !prefix.endsWith(".")) {
				prefix = prefix + ".";
			}
			return prefix;
		}

		private String[] getNames(AnnotationAttributes annotationAttributes) {
			String[] value = (String[]) annotationAttributes.get("value");
			String[] name = (String[]) annotationAttributes.get("name");
			Assert.state(value != null, "'value' must not be null");
			Assert.state(name != null, "'name' must not be null");
			Assert.state(value.length > 0 || name.length > 0,
					() -> "The name or value attribute of @%s must be specified"
						.formatted(ClassUtils.getShortName(this.annotationType)));
			Assert.state(value.length == 0 || name.length == 0,
					() -> "The name and value attributes of @%s are exclusive"
						.formatted(ClassUtils.getShortName(this.annotationType)));
			return (value.length > 0) ? value : name;
		}

		private void collectProperties(PropertyResolver resolver, List<String> missing, List<String> nonMatching) {
			for (String name : this.names) {
				String key = this.prefix + name;
				if (resolver.containsProperty(key)) {
					if (!isMatch(resolver.getProperty(key), this.havingValue)) {
						nonMatching.add(name);
					}
				}
				else {
					if (!this.matchIfMissing) {
						missing.add(name);
					}
				}
			}
		}

		private boolean isMatch(@Nullable String value, String requiredValue) {
			if (StringUtils.hasLength(requiredValue)) {
				return requiredValue.equalsIgnoreCase(value);
			}
			return !"false".equalsIgnoreCase(value);
		}

		@Override
		public String toString() {
			StringBuilder result = new StringBuilder();
			result.append("(");
			result.append(this.prefix);
			if (this.names.length == 1) {
				result.append(this.names[0]);
			}
			else {
				result.append("[");
				result.append(StringUtils.arrayToCommaDelimitedString(this.names));
				result.append("]");
			}
			if (StringUtils.hasLength(this.havingValue)) {
				result.append("=").append(this.havingValue);
			}
			result.append(")");
			return result.toString();
		}

	}

}