GH-1463: RabbitTemplate.logReceived() Protected

garyrussell · artembilan · commit bd46d4709114 · 2022-06-15T14:38:56.000-04:00
Resolves #1463 **cherry-pick to 2.4.x**
diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitTemplate.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitTemplate.java
@@ -1222,7 +1222,7 @@ else if (isChannelTransacted()) {
 			}
 			return null;
 		}, obtainTargetConnectionFactory(this.receiveConnectionFactorySelectorExpression, queueName));
-		logReceived(message);
+		logReceived("Received: ", message);
 		return message;
 	}
 
@@ -1261,7 +1261,7 @@ else if (isChannelTransacted()) {
 				return buildMessageFromDelivery(delivery);
 			}
 		}, obtainTargetConnectionFactory(this.receiveConnectionFactorySelectorExpression, null));
-		logReceived(message);
+		logReceived("Received: ", message);
 		return message;
 	}
 
@@ -1412,7 +1412,7 @@ else if (channelTransacted) {
 				receiveMessage = buildMessageFromDelivery(delivery);
 			}
 		}
-		logReceived(receiveMessage);
+		logReceived("Received: ", receiveMessage);
 		return receiveMessage;
 	}
 
@@ -1467,12 +1467,21 @@ private Delivery consumeDelivery(Channel channel, String queueName, long timeout
 		return delivery;
 	}
 
-	private void logReceived(@Nullable Message message) {
-		if (message == null) {
-			logger.debug("Received no message");
-		}
-		else if (logger.isDebugEnabled()) {
-			logger.debug("Received: " + message);
+	/**
+	 * Log a received message. The default implementation logs the full message at DEBUG
+	 * level. Override this method to change that behavior.
+	 * @param prefix a prefix, e.g. "Received: " or "Reply: ".
+	 * @param message the message.
+	 * @since 2.4.6
+	 */
+	protected void logReceived(String prefix, @Nullable Message message) {
+		if (logger.isDebugEnabled()) {
+			if (message == null) {
+				logger.debug(prefix + "no message");
+			}
+			else {
+				logger.debug(prefix + message);
+			}
 		}
 	}
 
@@ -2091,9 +2100,7 @@ private Message exchangeMessages(final String exchange, final String routingKey,
 		}
 		doSend(channel, exchange, routingKey, message, mandatory, correlationData);
 		reply = this.replyTimeout < 0 ? pendingReply.get() : pendingReply.get(this.replyTimeout, TimeUnit.MILLISECONDS);
-		if (this.logger.isDebugEnabled()) {
-			this.logger.debug("Reply: " + reply);
-		}
+		logReceived("Reply: ", reply);
 		if (reply == null) {
 			replyTimedOut(message.getMessageProperties().getCorrelationId());
 		}

Original file line number	Diff line number	Diff line change
`@@ -1222,7 +1222,7 @@ else if (isChannelTransacted()) {`
`1222`	`1222`	`}`
`1223`	`1223`	`return null;`
`1224`	`1224`	`}, obtainTargetConnectionFactory(this.receiveConnectionFactorySelectorExpression, queueName));`
`1225`		`- logReceived(message);`
	`1225`	`+ logReceived("Received: ", message);`
`1226`	`1226`	`return message;`
`1227`	`1227`	`}`
`1228`	`1228`
`@@ -1261,7 +1261,7 @@ else if (isChannelTransacted()) {`
`1261`	`1261`	`return buildMessageFromDelivery(delivery);`
`1262`	`1262`	`}`
`1263`	`1263`	`}, obtainTargetConnectionFactory(this.receiveConnectionFactorySelectorExpression, null));`
`1264`		`- logReceived(message);`
	`1264`	`+ logReceived("Received: ", message);`
`1265`	`1265`	`return message;`
`1266`	`1266`	`}`
`1267`	`1267`
`@@ -1412,7 +1412,7 @@ else if (channelTransacted) {`
`1412`	`1412`	`receiveMessage = buildMessageFromDelivery(delivery);`
`1413`	`1413`	`}`
`1414`	`1414`	`}`
`1415`		`- logReceived(receiveMessage);`
	`1415`	`+ logReceived("Received: ", receiveMessage);`
`1416`	`1416`	`return receiveMessage;`
`1417`	`1417`	`}`
`1418`	`1418`
`@@ -1467,12 +1467,21 @@ private Delivery consumeDelivery(Channel channel, String queueName, long timeout`
`1467`	`1467`	`return delivery;`
`1468`	`1468`	`}`
`1469`	`1469`
`1470`		`- private void logReceived(@Nullable Message message) {`
`1471`		`- if (message == null) {`
`1472`		`- logger.debug("Received no message");`
`1473`		`- }`
`1474`		`- else if (logger.isDebugEnabled()) {`
`1475`		`- logger.debug("Received: " + message);`
	`1470`	`+ /**`
	`1471`	`+ * Log a received message. The default implementation logs the full message at DEBUG`
	`1472`	`+ * level. Override this method to change that behavior.`
	`1473`	`+ * @param prefix a prefix, e.g. "Received: " or "Reply: ".`
	`1474`	`+ * @param message the message.`
	`1475`	`+ * @since 2.4.6`
	`1476`	`+ */`
	`1477`	`+ protected void logReceived(String prefix, @Nullable Message message) {`
	`1478`	`+ if (logger.isDebugEnabled()) {`
	`1479`	`+ if (message == null) {`
	`1480`	`+ logger.debug(prefix + "no message");`
	`1481`	`+ }`
	`1482`	`+ else {`
	`1483`	`+ logger.debug(prefix + message);`
	`1484`	`+ }`
`1476`	`1485`	`}`
`1477`	`1486`	`}`
`1478`	`1487`
`@@ -2091,9 +2100,7 @@ private Message exchangeMessages(final String exchange, final String routingKey,`
`2091`	`2100`	`}`
`2092`	`2101`	`doSend(channel, exchange, routingKey, message, mandatory, correlationData);`
`2093`	`2102`	`reply = this.replyTimeout < 0 ? pendingReply.get() : pendingReply.get(this.replyTimeout, TimeUnit.MILLISECONDS);`
`2094`		`- if (this.logger.isDebugEnabled()) {`
`2095`		`- this.logger.debug("Reply: " + reply);`
`2096`		`- }`
	`2103`	`+ logReceived("Reply: ", reply);`
`2097`	`2104`	`if (reply == null) {`
`2098`	`2105`	`replyTimedOut(message.getMessageProperties().getCorrelationId());`
`2099`	`2106`	`}`