Provide hints when template auto-config is excluded

Fixes gh-35682

Author: wilkinsona

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2023 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.
@@ -29,7 +29,6 @@
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Import;
-import org.springframework.context.annotation.ImportRuntimeHints;
 import org.springframework.ui.freemarker.FreeMarkerConfigurationFactory;
 
 /**
@@ -45,7 +44,6 @@
 @EnableConfigurationProperties(FreeMarkerProperties.class)
 @Import({ FreeMarkerServletWebConfiguration.class, FreeMarkerReactiveWebConfiguration.class,
 		FreeMarkerNonWebConfiguration.class })
-@ImportRuntimeHints(FreeMarkerRuntimeHints.class)
 public class FreeMarkerAutoConfiguration {
 
 	private static final Log logger = LogFactory.getLog(FreeMarkerAutoConfiguration.class);

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerRuntimeHints.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2023 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.
@@ -20,8 +20,11 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.boot.autoconfigure.template.PathBasedTemplateAvailabilityProvider;
 import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProvider;
+import org.springframework.boot.context.properties.bind.BindableRuntimeHintsRegistrar;
+import org.springframework.util.ClassUtils;
 
 /**
  * {@link TemplateAvailabilityProvider} that provides availability information for
@@ -32,8 +35,10 @@
  */
 public class FreeMarkerTemplateAvailabilityProvider extends PathBasedTemplateAvailabilityProvider {
 
+	private static final String REQUIRED_CLASS_NAME = "freemarker.template.Configuration";
+
 	public FreeMarkerTemplateAvailabilityProvider() {
-		super("freemarker.template.Configuration", FreeMarkerTemplateAvailabilityProperties.class, "spring.freemarker");
+		super(REQUIRED_CLASS_NAME, FreeMarkerTemplateAvailabilityProperties.class, "spring.freemarker");
 	}
 
 	protected static final class FreeMarkerTemplateAvailabilityProperties extends TemplateAvailabilityProperties {
@@ -60,4 +65,19 @@ public void setTemplateLoaderPath(List<String> templateLoaderPath) {
 
 	}
 
+	static class FreeMarkerTemplateAvailabilityRuntimeHints extends BindableRuntimeHintsRegistrar {
+
+		FreeMarkerTemplateAvailabilityRuntimeHints() {
+			super(FreeMarkerTemplateAvailabilityProperties.class);
+		}
+
+		@Override
+		public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+			if (ClassUtils.isPresent(REQUIRED_CLASS_NAME, classLoader)) {
+				super.registerHints(hints, classLoader);
+			}
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerTemplateAvailabilityProvider.java

@@ -38,7 +38,6 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.ImportRuntimeHints;
 import org.springframework.context.i18n.LocaleContextHolder;
 import org.springframework.core.log.LogMessage;
 import org.springframework.web.servlet.view.UrlBasedViewResolver;
@@ -60,7 +59,6 @@
 @AutoConfiguration(after = WebMvcAutoConfiguration.class)
 @ConditionalOnClass(MarkupTemplateEngine.class)
 @EnableConfigurationProperties(GroovyTemplateProperties.class)
-@ImportRuntimeHints(GroovyTemplateRuntimeHints.class)
 public class GroovyTemplateAutoConfiguration {
 
 	private static final Log logger = LogFactory.getLog(GroovyTemplateAutoConfiguration.class);

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2023 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.
@@ -20,8 +20,11 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.boot.autoconfigure.template.PathBasedTemplateAvailabilityProvider;
 import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProvider;
+import org.springframework.boot.context.properties.bind.BindableRuntimeHintsRegistrar;
+import org.springframework.util.ClassUtils;
 
 /**
  * {@link TemplateAvailabilityProvider} that provides availability information for Groovy
@@ -32,8 +35,10 @@
  */
 public class GroovyTemplateAvailabilityProvider extends PathBasedTemplateAvailabilityProvider {
 
+	private static final String REQUIRED_CLASS_NAME = "groovy.text.TemplateEngine";
+
 	public GroovyTemplateAvailabilityProvider() {
-		super("groovy.text.TemplateEngine", GroovyTemplateAvailabilityProperties.class, "spring.groovy.template");
+		super(REQUIRED_CLASS_NAME, GroovyTemplateAvailabilityProperties.class, "spring.groovy.template");
 	}
 
 	protected static final class GroovyTemplateAvailabilityProperties extends TemplateAvailabilityProperties {
@@ -60,4 +65,19 @@ public void setResourceLoaderPath(List<String> resourceLoaderPath) {
 
 	}
 
+	static class GroovyTemplateAvailabilityRuntimeHints extends BindableRuntimeHintsRegistrar {
+
+		GroovyTemplateAvailabilityRuntimeHints() {
+			super(GroovyTemplateAvailabilityProperties.class);
+		}
+
+		@Override
+		public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+			if (ClassUtils.isPresent(REQUIRED_CLASS_NAME, classLoader)) {
+				super.registerHints(hints, classLoader);
+			}
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateAvailabilityProvider.java

@@ -1,4 +1,6 @@
 org.springframework.aot.hint.RuntimeHintsRegistrar=\
+org.springframework.boot.autoconfigure.freemarker.FreeMarkerTemplateAvailabilityProvider.FreeMarkerTemplateAvailabilityRuntimeHints,\
+org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAvailabilityProvider.GroovyTemplateAvailabilityRuntimeHints,\
 org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration.JacksonAutoConfigurationRuntimeHints,\
 org.springframework.boot.autoconfigure.template.TemplateRuntimeHints
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateRuntimeHints.java

@@ -18,6 +18,12 @@
 
 import org.junit.jupiter.api.Test;
 
+import org.springframework.aot.hint.RuntimeHints;
+import org.springframework.aot.hint.RuntimeHintsRegistrar;
+import org.springframework.aot.hint.TypeHint;
+import org.springframework.beans.factory.aot.AotServices;
+import org.springframework.boot.autoconfigure.freemarker.FreeMarkerTemplateAvailabilityProvider.FreeMarkerTemplateAvailabilityProperties;
+import org.springframework.boot.autoconfigure.freemarker.FreeMarkerTemplateAvailabilityProvider.FreeMarkerTemplateAvailabilityRuntimeHints;
 import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProvider;
 import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.core.io.ResourceLoader;
@@ -84,4 +90,14 @@ void availabilityOfTemplateWithCustomSuffix() {
 			.isTrue();
 	}
 
+	@Test
+	void shouldRegisterFreeMarkerTemplateAvailabilityPropertiesRuntimeHints() {
+		assertThat(AotServices.factories().load(RuntimeHintsRegistrar.class))
+			.hasAtLeastOneElementOfType(FreeMarkerTemplateAvailabilityRuntimeHints.class);
+		RuntimeHints hints = new RuntimeHints();
+		new FreeMarkerTemplateAvailabilityRuntimeHints().registerHints(hints, getClass().getClassLoader());
+		TypeHint typeHint = hints.reflection().getTypeHint(FreeMarkerTemplateAvailabilityProperties.class);
+		assertThat(typeHint).isNotNull();
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/spring/aot.factories

@@ -18,6 +18,12 @@
 
 import org.junit.jupiter.api.Test;
 
+import org.springframework.aot.hint.RuntimeHints;
+import org.springframework.aot.hint.RuntimeHintsRegistrar;
+import org.springframework.aot.hint.TypeHint;
+import org.springframework.beans.factory.aot.AotServices;
+import org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAvailabilityProvider.GroovyTemplateAvailabilityProperties;
+import org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAvailabilityProvider.GroovyTemplateAvailabilityRuntimeHints;
 import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProvider;
 import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.core.io.ResourceLoader;
@@ -84,4 +90,14 @@ void availabilityOfTemplateWithCustomSuffix() {
 			.isTrue();
 	}
 
+	@Test
+	void shouldRegisterGroovyTemplateAvailabilityPropertiesRuntimeHints() {
+		assertThat(AotServices.factories().load(RuntimeHintsRegistrar.class))
+			.hasAtLeastOneElementOfType(GroovyTemplateAvailabilityRuntimeHints.class);
+		RuntimeHints hints = new RuntimeHints();
+		new GroovyTemplateAvailabilityRuntimeHints().registerHints(hints, getClass().getClassLoader());
+		TypeHint typeHint = hints.reflection().getTypeHint(GroovyTemplateAvailabilityProperties.class);
+		assertThat(typeHint).isNotNull();
+	}
+
 }