Combined backport of Jackson configuration enhancements: Locale/TimeZone settings, refined module configuration

Issue: SPR-12594
Issue: SPR-12634

Author: jhoeller

build.gradle

@@ -697,6 +697,7 @@ project("spring-web") {
 		testCompile("org.apache.taglibs:taglibs-standard-jstlel:1.2.1") {
 			exclude group: "org.apache.taglibs", module: "taglibs-standard-spec"
 		}
+		testCompile("com.fasterxml.jackson.datatype:jackson-datatype-joda:${jackson2Version}")
 		testRuntime("com.sun.mail:javax.mail:1.5.2")
 	}
 

spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -18,11 +18,14 @@
 
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
+import java.util.TimeZone;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.core.JsonGenerator;
@@ -46,6 +49,7 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
+import org.springframework.util.StringUtils;
 
 /**
  * A builder used to create {@link ObjectMapper} instances with a fluent API.
@@ -75,6 +79,10 @@ public class Jackson2ObjectMapperBuilder {
 
 	private DateFormat dateFormat;
 
+	private Locale locale;
+
+	private TimeZone timeZone;
+
 	private AnnotationIntrospector annotationIntrospector;
 
 	private PropertyNamingStrategy propertyNamingStrategy;
@@ -91,9 +99,11 @@ public class Jackson2ObjectMapperBuilder {
 
 	private List<Module> modules;
 
-	private Class<? extends Module>[] modulesToInstall;
+	private Class<? extends Module>[] moduleClasses;
+
+	private boolean findModulesViaServiceLoader = false;
 
-	private boolean findModulesViaServiceLoader;
+	private boolean findWellKnownModules = true;
 
 	private ClassLoader moduleClassLoader = getClass().getClassLoader();
 
@@ -134,6 +144,48 @@ public Jackson2ObjectMapperBuilder simpleDateFormat(String format) {
 		return this;
 	}
 
+	/**
+	 * Override the default {@link Locale} to use for formatting.
+	 * Default value used is {@link Locale#getDefault()}.
+	 * @since 4.1.5
+	 */
+	public Jackson2ObjectMapperBuilder locale(Locale locale) {
+		this.locale = locale;
+		return this;
+	}
+
+	/**
+	 * Override the default {@link Locale} to use for formatting.
+	 * Default value used is {@link Locale#getDefault()}.
+	 * @param localeString the locale ID as a String representation
+	 * @since 4.1.5
+	 */
+	public Jackson2ObjectMapperBuilder locale(String localeString) {
+		this.locale = StringUtils.parseLocaleString(localeString);
+		return this;
+	}
+
+	/**
+	 * Override the default {@link TimeZone} to use for formatting.
+	 * Default value used is UTC (NOT local timezone).
+	 * @since 4.1.5
+	 */
+	public Jackson2ObjectMapperBuilder timeZone(TimeZone timeZone) {
+		this.timeZone = timeZone;
+		return this;
+	}
+
+	/**
+	 * Override the default {@link TimeZone} to use for formatting.
+	 * Default value used is UTC (NOT local timezone).
+	 * @param timeZoneString the zone ID as a String representation
+	 * @since 4.1.5
+	 */
+	public Jackson2ObjectMapperBuilder timeZone(String timeZoneString) {
+		this.timeZone = StringUtils.parseTimeZoneString(timeZoneString);
+		return this;
+	}
+
 	/**
 	 * Set an {@link AnnotationIntrospector} for both serialization and deserialization.
 	 */
@@ -337,31 +389,68 @@ public Jackson2ObjectMapperBuilder featuresToDisable(Object... featuresToDisable
 		return this;
 	}
 
+	/**
+	 * Specify one or more modules to be registered with the {@link ObjectMapper}.
+	 * <p>Note: If this is set, no finding of modules is going to happen - not by
+	 * Jackson, and not by Spring either (see {@link #findModulesViaServiceLoader}).
+	 * As a consequence, specifying an empty list here will suppress any kind of
+	 * module detection.
+	 * <p>Specify either this or {@link #modulesToInstall}, not both.
+	 * @since 4.1.5
+	 * @see #modules(List)
+	 * @see com.fasterxml.jackson.databind.Module
+	 */
+	public Jackson2ObjectMapperBuilder modules(Module... modules) {
+		return modules(Arrays.asList(modules));
+	}
+
 	/**
 	 * Set a complete list of modules to be registered with the {@link ObjectMapper}.
 	 * <p>Note: If this is set, no finding of modules is going to happen - not by
 	 * Jackson, and not by Spring either (see {@link #findModulesViaServiceLoader}).
 	 * As a consequence, specifying an empty list here will suppress any kind of
 	 * module detection.
 	 * <p>Specify either this or {@link #modulesToInstall}, not both.
+	 * @see #modules(Module...)
 	 * @see com.fasterxml.jackson.databind.Module
 	 */
 	public Jackson2ObjectMapperBuilder modules(List<Module> modules) {
 		this.modules = new LinkedList<Module>(modules);
+		this.findModulesViaServiceLoader = false;
+		this.findWellKnownModules = false;
+		return this;
+	}
+
+	/**
+	 * Specify one or more modules to be registered with the {@link ObjectMapper}.
+	 * <p>Modules specified here will be registered after
+	 * Spring's autodetection of JSR-310 and Joda-Time, or Jackson's
+	 * finding of modules (see {@link #findModulesViaServiceLoader}),
+	 * allowing to eventually override their configuration.
+	 * <p>Specify either this or {@link #modules}, not both.
+	 * @since 4.1.5
+	 * @see com.fasterxml.jackson.databind.Module
+	 */
+	public Jackson2ObjectMapperBuilder modulesToInstall(Module... modules) {
+		this.modules = Arrays.asList(modules);
+		this.findWellKnownModules = true;
 		return this;
 	}
 
 	/**
-	 * Specify one or more modules by class (or class name in XML),
-	 * to be registered with the {@link ObjectMapper}.
-	 * <p>Modules specified here will be registered in combination with
+	 * Specify one or more modules by class to be registered with
+	 * the {@link ObjectMapper}.
+	 * <p>Modules specified here will be registered after
 	 * Spring's autodetection of JSR-310 and Joda-Time, or Jackson's
-	 * finding of modules (see {@link #findModulesViaServiceLoader}).
+	 * finding of modules (see {@link #findModulesViaServiceLoader}),
+	 * allowing to eventually override their configuration.
 	 * <p>Specify either this or {@link #modules}, not both.
+	 * @see #modulesToInstall(Module...)
 	 * @see com.fasterxml.jackson.databind.Module
 	 */
 	public Jackson2ObjectMapperBuilder modulesToInstall(Class<? extends Module>... modules) {
-		this.modulesToInstall = modules;
+		this.moduleClasses = modules;
+		this.findWellKnownModules = true;
 		return this;
 	}
 
@@ -444,9 +533,35 @@ public <T extends ObjectMapper> T build() {
 	public void configure(ObjectMapper objectMapper) {
 		Assert.notNull(objectMapper, "ObjectMapper must not be null");
 
+		if (this.findModulesViaServiceLoader) {
+			// Jackson 2.2+
+			objectMapper.registerModules(ObjectMapper.findModules(this.moduleClassLoader));
+		}
+		else if (this.findWellKnownModules) {
+			registerWellKnownModulesIfAvailable(objectMapper);
+		}
+
+		if (this.modules != null) {
+			for (Module module : this.modules) {
+				// Using Jackson 2.0+ registerModule method, not Jackson 2.2+ registerModules
+				objectMapper.registerModule(module);
+			}
+		}
+		if (this.moduleClasses != null) {
+			for (Class<? extends Module> module : this.moduleClasses) {
+				objectMapper.registerModule(BeanUtils.instantiate(module));
+			}
+		}
+
 		if (this.dateFormat != null) {
 			objectMapper.setDateFormat(this.dateFormat);
 		}
+		if (this.locale != null) {
+			objectMapper.setLocale(this.locale);
+		}
+		if (this.timeZone != null) {
+			objectMapper.setTimeZone(this.timeZone);
+		}
 
 		if (this.annotationIntrospector != null) {
 			objectMapper.setAnnotationIntrospector(this.annotationIntrospector);
@@ -468,29 +583,6 @@ public void configure(ObjectMapper objectMapper) {
 			configureFeature(objectMapper, feature, this.features.get(feature));
 		}
 
-		if (this.modules != null) {
-			// Complete list of modules given
-			for (Module module : this.modules) {
-				// Using Jackson 2.0+ registerModule method, not Jackson 2.2+ registerModules
-				objectMapper.registerModule(module);
-			}
-		}
-		else {
-			// Combination of modules by class names specified and class presence in the classpath
-			if (this.modulesToInstall != null) {
-				for (Class<? extends Module> module : this.modulesToInstall) {
-					objectMapper.registerModule(BeanUtils.instantiate(module));
-				}
-			}
-			if (this.findModulesViaServiceLoader) {
-				// Jackson 2.2+
-				objectMapper.registerModules(ObjectMapper.findModules(this.moduleClassLoader));
-			}
-			else {
-				registerWellKnownModulesIfAvailable(objectMapper);
-			}
-		}
-
 		if (this.propertyNamingStrategy != null) {
 			objectMapper.setPropertyNamingStrategy(this.propertyNamingStrategy);
 		}

spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java

@@ -19,7 +19,9 @@
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
+import java.util.TimeZone;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.AnnotationIntrospector;
@@ -171,6 +173,24 @@ public void setSimpleDateFormat(String format) {
 		this.builder.simpleDateFormat(format);
 	}
 
+	/**
+	 * Override the default {@link Locale} to use for formatting.
+	 * Default value used is {@link Locale#getDefault()}.
+	 * @since 4.1.5
+	 */
+	public void setLocale(Locale locale) {
+		this.builder.locale(locale);
+	}
+
+	/**
+	 * Override the default {@link TimeZone} to use for formatting.
+	 * Default value used is UTC (NOT local timezone).
+	 * @since 4.1.5
+	 */
+	public void setTimeZone(TimeZone timeZone) {
+		this.builder.timeZone(timeZone);
+	}
+
 	/**
 	 * Set an {@link AnnotationIntrospector} for both serialization and deserialization.
 	 */
@@ -316,11 +336,12 @@ public void setModules(List<Module> modules) {
 	}
 
 	/**
-	 * Specify one or more modules by class (or class name in XML),
+	 * Specify one or more modules by class (or class name in XML)
 	 * to be registered with the {@link ObjectMapper}.
-	 * <p>Modules specified here will be registered in combination with
+	 * <p>Modules specified here will be registered after
 	 * Spring's autodetection of JSR-310 and Joda-Time, or Jackson's
-	 * finding of modules (see {@link #setFindModulesViaServiceLoader}).
+	 * finding of modules (see {@link #setFindModulesViaServiceLoader}),
+	 * allowing to eventually override their configuration.
 	 * <p>Specify either this or {@link #setModules}, not both.
 	 * @since 4.0.1
 	 * @see com.fasterxml.jackson.databind.Module