MessageSource.getMessage returns null default message as-is (again)

jhoeller · jhoeller · commit e5c8dc0d6594 · 2017-10-31T11:06:42.000+01:00
Issue: SPR-16127
diff --git a/spring-context/src/main/java/org/springframework/context/MessageSource.java b/spring-context/src/main/java/org/springframework/context/MessageSource.java
@@ -53,6 +53,7 @@ public interface MessageSource {
 	 * otherwise the default message passed as a parameter
 	 * @see java.text.MessageFormat
 	 */
+	@Nullable
 	String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale);
 
 	/**
diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractMessageSource.java b/spring-context/src/main/java/org/springframework/context/support/AbstractMessageSource.java
@@ -143,8 +143,7 @@ public final String getMessage(String code, @Nullable Object[] args, @Nullable S
 			return msg;
 		}
 		if (defaultMessage == null) {
-			String fallback = getDefaultMessage(code);
-			return (fallback != null ? fallback : "");
+			return getDefaultMessage(code);
 		}
 		return renderDefaultMessage(defaultMessage, args, locale);
 	}
@@ -264,8 +263,7 @@ protected String getMessageFromParent(String code, @Nullable Object[] args, Loca
 			else {
 				// Check parent MessageSource, returning null if not found there.
 				// Covers custom MessageSource impls and DelegatingMessageSource.
-				String msg = parent.getMessage(code, args, null, locale);
-				return ("".equals(msg) ? null : msg);
+				return parent.getMessage(code, args, null, locale);
 			}
 		}
 		// Not found in parent either.
diff --git a/spring-context/src/main/java/org/springframework/context/support/DelegatingMessageSource.java b/spring-context/src/main/java/org/springframework/context/support/DelegatingMessageSource.java
@@ -54,6 +54,7 @@ public MessageSource getParentMessageSource() {
 
 
 	@Override
+	@Nullable
 	public String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale) {
 		if (this.parentMessageSource != null) {
 			return this.parentMessageSource.getMessage(code, args, defaultMessage, locale);
@@ -62,7 +63,7 @@ else if (defaultMessage != null) {
 			return renderDefaultMessage(defaultMessage, args, locale);
 		}
 		else {
-			return "";
+			return null;
 		}
 	}
 
diff --git a/spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java b/spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java
@@ -84,7 +84,8 @@ protected Locale getDefaultLocale() {
 	 * @return the message
 	 */
 	public String getMessage(String code, String defaultMessage) {
-		return this.messageSource.getMessage(code, null, defaultMessage, getDefaultLocale());
+		String msg = this.messageSource.getMessage(code, null, defaultMessage, getDefaultLocale());
+		return (msg != null ? msg : "");
 	}
 
 	/**
@@ -95,7 +96,8 @@ public String getMessage(String code, String defaultMessage) {
 	 * @return the message
 	 */
 	public String getMessage(String code, String defaultMessage, Locale locale) {
-		return this.messageSource.getMessage(code, null, defaultMessage, locale);
+		String msg = this.messageSource.getMessage(code, null, defaultMessage, locale);
+		return (msg != null ? msg : "");
 	}
 
 	/**
@@ -106,7 +108,8 @@ public String getMessage(String code, String defaultMessage, Locale locale) {
 	 * @return the message
 	 */
 	public String getMessage(String code, @Nullable Object[] args, String defaultMessage) {
-		return this.messageSource.getMessage(code, args, defaultMessage, getDefaultLocale());
+		String msg = this.messageSource.getMessage(code, args, defaultMessage, getDefaultLocale());
+		return (msg != null ? msg : "");
 	}
 
 	/**
@@ -118,7 +121,8 @@ public String getMessage(String code, @Nullable Object[] args, String defaultMes
 	 * @return the message
 	 */
 	public String getMessage(String code, @Nullable Object[] args, String defaultMessage, Locale locale) {
-		return this.messageSource.getMessage(code, args, defaultMessage, locale);
+		String msg = this.messageSource.getMessage(code, args, defaultMessage, locale);
+		return (msg != null ? msg : "");
 	}
 
 	/**
diff --git a/spring-context/src/test/java/org/springframework/context/support/ResourceBundleMessageSourceTests.java b/spring-context/src/test/java/org/springframework/context/support/ResourceBundleMessageSourceTests.java
@@ -162,6 +162,7 @@ protected void doTestMessageAccess(
 		assertEquals("Hello, message1", ac.getMessage("hello", args, Locale.ENGLISH));
 
 		// test default message without and with args
+		assertNull(ac.getMessage(null, null, null, Locale.ENGLISH));
 		assertEquals("default", ac.getMessage(null, null, "default", Locale.ENGLISH));
 		assertEquals("default", ac.getMessage(null, args, "default", Locale.ENGLISH));
 		assertEquals("{0}, default", ac.getMessage(null, null, "{0}, default", Locale.ENGLISH));
diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java
@@ -282,6 +282,9 @@ public String getMessage(String code, @Nullable List<?> args, String defaultMess
 	 */
 	public String getMessage(String code, @Nullable Object[] args, String defaultMessage, boolean htmlEscape) {
 		String msg = this.messageSource.getMessage(code, args, defaultMessage, this.locale);
+		if (msg == null) {
+			return "";
+		}
 		return (htmlEscape ? HtmlUtils.htmlEscape(msg) : msg);
 	}
 
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/RequestContext.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/RequestContext.java
@@ -653,6 +653,9 @@ public String getMessage(String code, @Nullable List<?> args, String defaultMess
 	 */
 	public String getMessage(String code, @Nullable Object[] args, String defaultMessage, boolean htmlEscape) {
 		String msg = this.webApplicationContext.getMessage(code, args, defaultMessage, getLocale());
+		if (msg == null) {
+			return "";
+		}
 		return (htmlEscape ? HtmlUtils.htmlEscape(msg) : msg);
 	}
 
@@ -732,7 +735,8 @@ public String getMessage(MessageSourceResolvable resolvable, boolean htmlEscape)
 	 * @return the message
 	 */
 	public String getThemeMessage(String code, String defaultMessage) {
-		return getTheme().getMessageSource().getMessage(code, null, defaultMessage, getLocale());
+		String msg = getTheme().getMessageSource().getMessage(code, null, defaultMessage, getLocale());
+		return (msg != null ? msg : "");
 	}
 
 	/**
@@ -745,7 +749,8 @@ public String getThemeMessage(String code, String defaultMessage) {
 	 * @return the message
 	 */
 	public String getThemeMessage(String code, @Nullable Object[] args, String defaultMessage) {
-		return getTheme().getMessageSource().getMessage(code, args, defaultMessage, getLocale());
+		String msg = getTheme().getMessageSource().getMessage(code, args, defaultMessage, getLocale());
+		return (msg != null ? msg : "");
 	}
 
 	/**
@@ -758,8 +763,9 @@ public String getThemeMessage(String code, @Nullable Object[] args, String defau
 	 * @return the message
 	 */
 	public String getThemeMessage(String code, @Nullable List<?> args, String defaultMessage) {
-		return getTheme().getMessageSource().getMessage(code, (args != null ? args.toArray() : null),
+		String msg = getTheme().getMessageSource().getMessage(code, (args != null ? args.toArray() : null),
 				defaultMessage, getLocale());
+		return (msg != null ? msg : "");
 	}
 
 	/**
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/MessageTag.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/MessageTag.java
@@ -300,6 +300,7 @@ public void release() {
 		this.arguments = null;
 	}
 
+
 	/**
 	 * Resolve the specified message into a concrete message String.
 	 * The returned message String should be unescaped.
@@ -322,8 +323,9 @@ protected String resolveMessage() throws JspException, NoSuchMessageException {
 
 			if (this.text != null) {
 				// We have a fallback text to consider.
-				return messageSource.getMessage(
+				String msg = messageSource.getMessage(
 						this.code, argumentsArray, this.text, getRequestContext().getLocale());
+				return (msg != null ? msg : "");
 			}
 			else {
 				// We have no fallback text to consider.

Original file line number	Diff line number	Diff line change
`@@ -143,8 +143,7 @@ public final String getMessage(String code, @Nullable Object[] args, @Nullable S`
`143`	`143`	`return msg;`
`144`	`144`	`}`
`145`	`145`	`if (defaultMessage == null) {`
`146`		`- String fallback = getDefaultMessage(code);`
`147`		`- return (fallback != null ? fallback : "");`
	`146`	`+ return getDefaultMessage(code);`
`148`	`147`	`}`
`149`	`148`	`return renderDefaultMessage(defaultMessage, args, locale);`
`150`	`149`	`}`
`@@ -264,8 +263,7 @@ protected String getMessageFromParent(String code, @Nullable Object[] args, Loca`
`264`	`263`	`else {`
`265`	`264`	`// Check parent MessageSource, returning null if not found there.`
`266`	`265`	`// Covers custom MessageSource impls and DelegatingMessageSource.`
`267`		`- String msg = parent.getMessage(code, args, null, locale);`
`268`		`- return ("".equals(msg) ? null : msg);`
	`266`	`+ return parent.getMessage(code, args, null, locale);`
`269`	`267`	`}`
`270`	`268`	`}`
`271`	`269`	`// Not found in parent either.`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ public MessageSource getParentMessageSource() {`
`54`	`54`
`55`	`55`
`56`	`56`	`@Override`
	`57`	`+ @Nullable`
`57`	`58`	`public String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale) {`
`58`	`59`	`if (this.parentMessageSource != null) {`
`59`	`60`	`return this.parentMessageSource.getMessage(code, args, defaultMessage, locale);`
`@@ -62,7 +63,7 @@ else if (defaultMessage != null) {`
`62`	`63`	`return renderDefaultMessage(defaultMessage, args, locale);`
`63`	`64`	`}`
`64`	`65`	`else {`
`65`		`- return "";`
	`66`	`+ return null;`
`66`	`67`	`}`
`67`	`68`	`}`
`68`	`69`
Original file line number	Diff line number	Diff line change
`@@ -282,6 +282,9 @@ public String getMessage(String code, @Nullable List<?> args, String defaultMess`
`282`	`282`	`*/`
`283`	`283`	`public String getMessage(String code, @Nullable Object[] args, String defaultMessage, boolean htmlEscape) {`
`284`	`284`	`String msg = this.messageSource.getMessage(code, args, defaultMessage, this.locale);`
	`285`	`+ if (msg == null) {`
	`286`	`+ return "";`
	`287`	`+ }`
`285`	`288`	`return (htmlEscape ? HtmlUtils.htmlEscape(msg) : msg);`
`286`	`289`	`}`
`287`	`290`