ConditionEvaluationReportMessage Class — spring-boot Architecture

Source Code

core/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/logging/ConditionEvaluationReportMessage.java lines 43–207

public class ConditionEvaluationReportMessage {

	private final StringBuilder message;

	public ConditionEvaluationReportMessage(ConditionEvaluationReport report) {
		this(report, "CONDITIONS EVALUATION REPORT");
	}

	public ConditionEvaluationReportMessage(ConditionEvaluationReport report, String title) {
		this.message = getLogMessage(report, title);
	}

	private StringBuilder getLogMessage(ConditionEvaluationReport report, String title) {
		String separator = "=".repeat(title.length());
		StringBuilder message = new StringBuilder();
		message.append(String.format("%n%n%n"));
		message.append(String.format("%s%n", separator));
		message.append(String.format("%s%n", title));
		message.append(String.format("%s%n%n%n", separator));
		Map<String, ConditionAndOutcomes> shortOutcomes = orderByName(report.getConditionAndOutcomesBySource());
		logPositiveMatches(message, shortOutcomes);
		logNegativeMatches(message, shortOutcomes);
		logExclusions(report, message);
		logUnconditionalClasses(report, message);
		message.append(String.format("%n%n"));
		return message;
	}

	private void logPositiveMatches(StringBuilder message, Map<String, ConditionAndOutcomes> shortOutcomes) {
		message.append(String.format("Positive matches:%n"));
		message.append(String.format("-----------------%n"));
		List<Entry<String, ConditionAndOutcomes>> matched = shortOutcomes.entrySet()
			.stream()
			.filter((entry) -> entry.getValue().isFullMatch())
			.toList();
		if (matched.isEmpty()) {
			message.append(String.format("%n    None%n"));
		}
		else {
			matched.forEach((entry) -> addMatchLogMessage(message, entry.getKey(), entry.getValue()));
		}
		message.append(String.format("%n%n"));
	}

	private void logNegativeMatches(StringBuilder message, Map<String, ConditionAndOutcomes> shortOutcomes) {
		message.append(String.format("Negative matches:%n"));
		message.append(String.format("-----------------%n"));
		List<Entry<String, ConditionAndOutcomes>> nonMatched = shortOutcomes.entrySet()
			.stream()
			.filter((entry) -> !entry.getValue().isFullMatch())
			.toList();
		if (nonMatched.isEmpty()) {
			message.append(String.format("%n    None%n"));
		}
		else {
			nonMatched.forEach((entry) -> addNonMatchLogMessage(message, entry.getKey(), entry.getValue()));
		}
		message.append(String.format("%n%n"));
	}

	private void logExclusions(ConditionEvaluationReport report, StringBuilder message) {
		message.append(String.format("Exclusions:%n"));
		message.append(String.format("-----------%n"));
		if (report.getExclusions().isEmpty()) {
			message.append(String.format("%n    None%n"));
		}
		else {
			for (String exclusion : report.getExclusions()) {
				message.append(String.format("%n    %s%n", exclusion));
			}
		}
		message.append(String.format("%n%n"));
	}

	private void logUnconditionalClasses(ConditionEvaluationReport report, StringBuilder message) {
		message.append(String.format("Unconditional classes:%n"));
		message.append(String.format("----------------------%n"));
		if (report.getUnconditionalClasses().isEmpty()) {
			message.append(String.format("%n    None%n"));
		}
		else {
			for (String unconditionalClass : report.getUnconditionalClasses()) {
				message.append(String.format("%n    %s%n", unconditionalClass));
			}
		}
	}

	private Map<String, ConditionAndOutcomes> orderByName(Map<String, ConditionAndOutcomes> outcomes) {
		MultiValueMap<String, String> map = mapToFullyQualifiedNames(outcomes.keySet());
		List<String> shortNames = new ArrayList<>(map.keySet());
		Collections.sort(shortNames);
		Map<String, ConditionAndOutcomes> result = new LinkedHashMap<>();
		for (String shortName : shortNames) {
			List<String> fullyQualifiedNames = map.get(shortName);
			Assert.state(fullyQualifiedNames != null, "'fullyQualifiedNames' must not be null");
			if (fullyQualifiedNames.size() > 1) {
				fullyQualifiedNames
					.forEach((fullyQualifiedName) -> result.put(fullyQualifiedName, outcomes.get(fullyQualifiedName)));
			}
			else {
				result.put(shortName, outcomes.get(fullyQualifiedNames.get(0)));
			}
		}
		return result;
	}

	private MultiValueMap<String, String> mapToFullyQualifiedNames(Set<String> keySet) {
		LinkedMultiValueMap<String, String> map = new LinkedMultiValueMap<>();
		keySet
			.forEach((fullyQualifiedName) -> map.add(ClassUtils.getShortName(fullyQualifiedName), fullyQualifiedName));
		return map;
	}

	private void addMatchLogMessage(StringBuilder message, String source, ConditionAndOutcomes matches) {
		message.append(String.format("%n   %s matched:%n", source));
		for (ConditionAndOutcome match : matches) {
			logConditionAndOutcome(message, "      ", match);
		}
	}

	private void addNonMatchLogMessage(StringBuilder message, String source,
			ConditionAndOutcomes conditionAndOutcomes) {
		message.append(String.format("%n   %s:%n", source));
		List<ConditionAndOutcome> matches = new ArrayList<>();
		List<ConditionAndOutcome> nonMatches = new ArrayList<>();
		for (ConditionAndOutcome conditionAndOutcome : conditionAndOutcomes) {
			if (conditionAndOutcome.getOutcome().isMatch()) {
				matches.add(conditionAndOutcome);
			}
			else {
				nonMatches.add(conditionAndOutcome);
			}
		}
		message.append(String.format("      Did not match:%n"));
		for (ConditionAndOutcome nonMatch : nonMatches) {
			logConditionAndOutcome(message, "         ", nonMatch);
		}
		if (!matches.isEmpty()) {
			message.append(String.format("      Matched:%n"));
			for (ConditionAndOutcome match : matches) {
				logConditionAndOutcome(message, "         ", match);
			}
		}
	}

	private void logConditionAndOutcome(StringBuilder message, String indent, ConditionAndOutcome conditionAndOutcome) {
		message.append(String.format("%s- ", indent));
		String outcomeMessage = conditionAndOutcome.getOutcome().getMessage();
		if (StringUtils.hasLength(outcomeMessage)) {
			message.append(outcomeMessage);
		}
		else {
			message.append(conditionAndOutcome.getOutcome().isMatch() ? "matched" : "did not match");
		}
		message.append(" (");
		message.append(ClassUtils.getShortName(conditionAndOutcome.getCondition().getClass()));
		message.append(String.format(")%n"));
	}

	@Override
	public String toString() {
		return this.message.toString();
	}

}