Auto-configure SmileMapper.Builder and SmileMapper

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

Author: quaff

module/spring-boot-jackson/build.gradle

@@ -32,6 +32,7 @@ dependencies {
 	optional(project(":core:spring-boot-test-autoconfigure"))
 	optional("org.springframework:spring-web")
 	optional("tools.jackson.dataformat:jackson-dataformat-cbor")
+	optional("tools.jackson.dataformat:jackson-dataformat-smile")
 	optional("tools.jackson.dataformat:jackson-dataformat-xml")
 	optional("tools.jackson.module:jackson-module-jakarta-xmlbind-annotations")
 

module/spring-boot-jackson/src/main/java/org/springframework/boot/jackson/autoconfigure/JacksonAutoConfiguration.java

@@ -40,6 +40,7 @@
 import tools.jackson.databind.cfg.MapperBuilder;
 import tools.jackson.databind.json.JsonMapper;
 import tools.jackson.dataformat.cbor.CBORMapper;
+import tools.jackson.dataformat.smile.SmileMapper;
 import tools.jackson.dataformat.xml.XmlMapper;
 
 import org.springframework.aot.hint.ReflectionHints;
@@ -81,6 +82,7 @@
  * @author Phillip Webb
  * @author Eddú Meléndez
  * @author Ralf Ueberfuhr
+ * @author Yanming Zhou
  * @since 4.0.0
  */
 @AutoConfiguration
@@ -237,6 +239,61 @@ public void customize(CBORMapper.Builder builder) {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(SmileMapper.class)
+	@EnableConfigurationProperties(JacksonSmileProperties.class)
+	static class SmileConfiguration {
+
+		@Bean
+		@ConditionalOnMissingBean
+		SmileMapper smileMapper(SmileMapper.Builder builder) {
+			return builder.build();
+		}
+
+		@Bean
+		@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
+		@ConditionalOnMissingBean
+		SmileMapper.Builder smileMapperBuilder(List<SmileMapperBuilderCustomizer> customizers) {
+			SmileMapper.Builder builder = SmileMapper.builder();
+			customize(builder, customizers);
+			return builder;
+		}
+
+		private void customize(SmileMapper.Builder builder, List<SmileMapperBuilderCustomizer> customizers) {
+			for (SmileMapperBuilderCustomizer customizer : customizers) {
+				customizer.customize(builder);
+			}
+		}
+
+		@Bean
+		StandardSmileMapperBuilderCustomizer standardSmileMapperBuilderCustomizer(JacksonProperties jacksonProperties,
+				ObjectProvider<JacksonModule> modules, JacksonSmileProperties smileProperties) {
+			return new StandardSmileMapperBuilderCustomizer(jacksonProperties, modules.stream().toList(),
+					smileProperties);
+		}
+
+		static class StandardSmileMapperBuilderCustomizer extends AbstractMapperBuilderCustomizer<SmileMapper.Builder>
+				implements SmileMapperBuilderCustomizer {
+
+			private final JacksonSmileProperties smileProperties;
+
+			StandardSmileMapperBuilderCustomizer(JacksonProperties jacksonProperties, Collection<JacksonModule> modules,
+					JacksonSmileProperties smileProperties) {
+				super(jacksonProperties, modules);
+				this.smileProperties = smileProperties;
+			}
+
+			@Override
+			public void customize(SmileMapper.Builder builder) {
+				super.customize(builder);
+				configureFeatures(builder, this.smileProperties.getRead(), builder::configure);
+				configureFeatures(builder, this.smileProperties.getWrite(), builder::configure);
+			}
+
+		}
+
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	@ConditionalOnClass(XmlMapper.class)
 	@EnableConfigurationProperties(JacksonXmlProperties.class)

module/spring-boot-jackson/src/main/java/org/springframework/boot/jackson/autoconfigure/JacksonSmileProperties.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2012-present 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.jackson.autoconfigure;
+
+import java.util.EnumMap;
+import java.util.Map;
+
+import tools.jackson.dataformat.smile.SmileReadFeature;
+import tools.jackson.dataformat.smile.SmileWriteFeature;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Configuration properties to configure Jackson's Smile support.
+ *
+ * @author Yanming Zhou
+ * @since 4.0.0
+ */
+@ConfigurationProperties("spring.jackson.smile")
+public class JacksonSmileProperties {
+
+	/**
+	 * Jackson on/off token reader features that are specific to Smile.
+	 */
+	private final Map<SmileReadFeature, Boolean> read = new EnumMap<>(SmileReadFeature.class);
+
+	/**
+	 * Jackson on/off token writer features that are specific to Smile.
+	 */
+	private final Map<SmileWriteFeature, Boolean> write = new EnumMap<>(SmileWriteFeature.class);
+
+	public Map<SmileReadFeature, Boolean> getRead() {
+		return this.read;
+	}
+
+	public Map<SmileWriteFeature, Boolean> getWrite() {
+		return this.write;
+	}
+
+}

module/spring-boot-jackson/src/main/java/org/springframework/boot/jackson/autoconfigure/SmileMapperBuilderCustomizer.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2012-present 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.jackson.autoconfigure;
+
+import tools.jackson.dataformat.smile.SmileMapper;
+import tools.jackson.dataformat.smile.SmileMapper.Builder;
+
+/**
+ * Callback interface that can be implemented by beans wishing to further customize the
+ * {@link SmileMapper} through {@link Builder SmileMapper.Builder} to fine-tune its
+ * auto-configuration.
+ *
+ * @author Yanming Zhou
+ * @since 4.0.0
+ */
+@FunctionalInterface
+public interface SmileMapperBuilderCustomizer {
+
+	/**
+	 * Customize the SmileMapper.Builder.
+	 * @param smileMapperBuilder the builder to customize
+	 */
+	void customize(Builder smileMapperBuilder);
+
+}

module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/JacksonAutoConfigurationTests.java

@@ -57,6 +57,7 @@
 import tools.jackson.databind.module.SimpleModule;
 import tools.jackson.databind.util.StdDateFormat;
 import tools.jackson.dataformat.cbor.CBORMapper;
+import tools.jackson.dataformat.smile.SmileMapper;
 import tools.jackson.dataformat.xml.XmlMapper;
 import tools.jackson.module.kotlin.KotlinModule;
 
@@ -100,6 +101,7 @@
  * @author Grzegorz Poznachowski
  * @author Ralf Ueberfuhr
  * @author Eddú Meléndez
+ * @author Yanming Zhou
  */
 class JacksonAutoConfigurationTests {
 
@@ -647,6 +649,16 @@ void cborMapperBuilderIsNotSharedAcrossMultipleInjectionPoints() {
 		});
 	}
 
+	@Test
+	void smileMapperBuilderIsNotSharedAcrossMultipleInjectionPoints() {
+		this.contextRunner.withUserConfiguration(SmileMapperBuilderConsumerConfig.class).run((context) -> {
+			SmileMapperBuilderConsumerConfig consumer = context.getBean(SmileMapperBuilderConsumerConfig.class);
+			assertThat(consumer.builderOne).isNotNull();
+			assertThat(consumer.builderTwo).isNotNull();
+			assertThat(consumer.builderOne).isNotSameAs(consumer.builderTwo);
+		});
+	}
+
 	@Test
 	void xmlMapperBuilderIsNotSharedAcrossMultipleInjectionPoints() {
 		this.contextRunner.withUserConfiguration(XmlMapperBuilderConsumerConfig.class).run((context) -> {
@@ -725,6 +737,19 @@ void whenUsingJackson2DefaultsCborMapperShouldBeConfiguredUsingConfigureForJacks
 		});
 	}
 
+	@Test
+	void whenUsingJackson2DefaultsSmileMapperShouldBeConfiguredUsingConfigureForJackson2() {
+		this.contextRunner.withPropertyValues("spring.jackson.use-jackson2-defaults=true").run((context) -> {
+			SmileMapper smileMapper = context.getBean(SmileMapper.class);
+			SmileMapper jackson2ConfiguredSmileMapper = SmileMapper.builder().configureForJackson2().build();
+			assertCommonFeatureConfiguration(smileMapper, jackson2ConfiguredSmileMapper);
+			assertThat(smileMapper.deserializationConfig().getFormatReadFeatures())
+				.isEqualTo(jackson2ConfiguredSmileMapper.deserializationConfig().getFormatReadFeatures());
+			assertThat(smileMapper.serializationConfig().getFormatWriteFeatures())
+				.isEqualTo(jackson2ConfiguredSmileMapper.serializationConfig().getFormatWriteFeatures());
+		});
+	}
+
 	@Test
 	void whenUsingJackson2DefaultsXmlMapperShouldBeConfiguredUsingConfigureForJackson2() {
 		this.contextRunner.withPropertyValues("spring.jackson.use-jackson2-defaults=true").run((context) -> {
@@ -969,6 +994,27 @@ String consumerTwo(CBORMapper.Builder builder) {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	static class SmileMapperBuilderConsumerConfig {
+
+		SmileMapper.@Nullable Builder builderOne;
+
+		SmileMapper.@Nullable Builder builderTwo;
+
+		@Bean
+		String consumerOne(SmileMapper.Builder builder) {
+			this.builderOne = builder;
+			return "one";
+		}
+
+		@Bean
+		String consumerTwo(SmileMapper.Builder builder) {
+			this.builderTwo = builder;
+			return "two";
+		}
+
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class XmlMapperBuilderConsumerConfig {
 
@@ -1114,7 +1160,7 @@ static class CircularDependencySerializerConfiguration {
 	enum MapperType {
 
 		CBOR(CBORMapper.class, CBORMapper.Builder.class), JSON(JsonMapper.class, JsonMapper.Builder.class),
-		XML(XmlMapper.class, XmlMapper.Builder.class);
+		SMILE(SmileMapper.class, SmileMapper.Builder.class), XML(XmlMapper.class, XmlMapper.Builder.class);
 
 		private final Class<? extends ObjectMapper> mapperClass;