GH-1152: Use contentEncoding in Message.toString()

Resolves #1152

* Add check for null properties.

Author: garyrussell

spring-amqp/src/main/java/org/springframework/amqp/core/Message.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -46,11 +46,13 @@ public class Message implements Serializable {
 
 	private static final long serialVersionUID = -7177590352110605597L;
 
-	private static final String ENCODING = Charset.defaultCharset().name();
+	private static final String DEFAULT_ENCODING = Charset.defaultCharset().name();
 
 	private static final Set<String> whiteListPatterns = // NOSONAR lower case static
 			new LinkedHashSet<>(Arrays.asList("java.util.*", "java.lang.*"));
 
+	private static String bodyEncoding = DEFAULT_ENCODING;
+
 	private final MessageProperties messageProperties;
 
 	private final byte[] body;
@@ -77,6 +79,17 @@ public static void addWhiteListPatterns(String... patterns) {
 		whiteListPatterns.addAll(Arrays.asList(patterns));
 	}
 
+	/**
+	 * Set the encoding to use in {@link #toString()} when converting the body if
+	 * there is no {@link MessageProperties#getContentEncoding() contentEncoding} message property present.
+	 * @param encoding the encoding to use.
+	 * @since 2.2.4
+	 */
+	public static void setDefaultEncoding(String encoding) {
+		Assert.notNull(encoding, "'encoding' cannot be null");
+		bodyEncoding = encoding;
+	}
+
 	public byte[] getBody() {
 		return this.body; //NOSONAR
 	}
@@ -102,16 +115,21 @@ private String getBodyContentAsString() {
 			return null;
 		}
 		try {
-			String contentType = (this.messageProperties != null) ? this.messageProperties.getContentType() : null;
+			boolean nullProps = this.messageProperties == null;
+			String contentType = nullProps ? null : this.messageProperties.getContentType();
 			if (MessageProperties.CONTENT_TYPE_SERIALIZED_OBJECT.equals(contentType)) {
 				return SerializationUtils.deserialize(new ByteArrayInputStream(this.body), whiteListPatterns,
 						ClassUtils.getDefaultClassLoader()).toString();
 			}
+			String encoding = nullProps ? null : this.messageProperties.getContentEncoding();
+			if (encoding == null) {
+				encoding = bodyEncoding;
+			}
 			if (MessageProperties.CONTENT_TYPE_TEXT_PLAIN.equals(contentType)
 					|| MessageProperties.CONTENT_TYPE_JSON.equals(contentType)
 					|| MessageProperties.CONTENT_TYPE_JSON_ALT.equals(contentType)
 					|| MessageProperties.CONTENT_TYPE_XML.equals(contentType)) {
-				return new String(this.body, ENCODING);
+				return new String(this.body, encoding);
 			}
 		}
 		catch (Exception e) {

spring-amqp/src/test/java/org/springframework/amqp/core/MessageTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -23,6 +23,7 @@
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
 import java.io.Serializable;
+import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.Date;
 
@@ -44,6 +45,15 @@ public void toStringForEmptyMessageBody() {
 		assertThat(message.toString()).isNotNull();
 	}
 
+	@Test
+	public void properEncoding() {
+		Message message = new Message("ÁRVÍZTŰRŐ TÜKÖRFÚRÓGÉP".getBytes(StandardCharsets.UTF_16),
+				new MessageProperties());
+		message.getMessageProperties().setContentType(MessageProperties.CONTENT_TYPE_JSON);
+		message.getMessageProperties().setContentEncoding("UTF-16");
+		assertThat(message.toString()).contains("ÁRVÍZTŰRŐ TÜKÖRFÚRÓGÉP");
+	}
+
 	@Test
 	public void toStringForNullMessageProperties() {
 		Message message = new Message(new byte[0], null);