Allow repeatable writes in HttpMessageConverter

poutsma · poutsma · commit 6dd93d4d85da · 2023-11-02T15:51:36.000+01:00
This commit ensures that the StreamingHttpOutputMessage.Body.repeatable flag is set in message converters for bodies that can be written repeatedly. Closes gh-31516 See gh-31449
diff --git a/spring-web/src/main/java/org/springframework/http/converter/AbstractGenericHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/AbstractGenericHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -88,16 +88,27 @@ public final void write(final T t, @Nullable final Type type, @Nullable MediaTyp
 		addDefaultHeaders(headers, t, contentType);
 
 		if (outputMessage instanceof StreamingHttpOutputMessage streamingOutputMessage) {
-			streamingOutputMessage.setBody(outputStream -> writeInternal(t, type, new HttpOutputMessage() {
+			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
 				@Override
-				public OutputStream getBody() {
-					return outputStream;
+				public void writeTo(OutputStream outputStream) throws IOException {
+					writeInternal(t, type, new HttpOutputMessage() {
+						@Override
+						public OutputStream getBody() {
+							return outputStream;
+						}
+
+						@Override
+						public HttpHeaders getHeaders() {
+							return headers;
+						}
+					});
 				}
+
 				@Override
-				public HttpHeaders getHeaders() {
-					return headers;
+				public boolean repeatable() {
+					return supportsRepeatableWrites(t);
 				}
-			}));
+			});
 		}
 		else {
 			writeInternal(t, type, outputMessage);
diff --git a/spring-web/src/main/java/org/springframework/http/converter/AbstractHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/AbstractHttpMessageConverter.java
@@ -210,16 +210,27 @@ public final void write(final T t, @Nullable MediaType contentType, HttpOutputMe
 		addDefaultHeaders(headers, t, contentType);
 
 		if (outputMessage instanceof StreamingHttpOutputMessage streamingOutputMessage) {
-			streamingOutputMessage.setBody(outputStream -> writeInternal(t, new HttpOutputMessage() {
+			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
 				@Override
-				public OutputStream getBody() {
-					return outputStream;
+				public void writeTo(OutputStream outputStream) throws IOException {
+					writeInternal(t, new HttpOutputMessage() {
+						@Override
+						public OutputStream getBody() {
+							return outputStream;
+						}
+
+						@Override
+						public HttpHeaders getHeaders() {
+							return headers;
+						}
+					});
 				}
+
 				@Override
-				public HttpHeaders getHeaders() {
-					return headers;
+				public boolean repeatable() {
+					return supportsRepeatableWrites(t);
 				}
-			}));
+			});
 		}
 		else {
 			writeInternal(t, outputMessage);
@@ -289,6 +300,21 @@ protected Long getContentLength(T t, @Nullable MediaType contentType) throws IOE
 		return null;
 	}
 
+	/**
+	 * Indicates whether this message converter can
+	 * {@linkplain #write(Object, MediaType, HttpOutputMessage) write} the
+	 * given object multiple times.
+	 *
+	 * <p>Default implementation returns {@code false}.
+	 * @param t the object t
+	 * @return {@code true} if {@code t} can be written repeatedly;
+	 * {@code false} otherwise
+	 * @since 6.1
+	 */
+	protected boolean supportsRepeatableWrites(T t) {
+		return false;
+	}
+
 
 	/**
 	 * Indicates whether the given class is supported by this converter.
diff --git a/spring-web/src/main/java/org/springframework/http/converter/AbstractKotlinSerializationHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/AbstractKotlinSerializationHttpMessageConverter.java
@@ -178,4 +178,9 @@ private boolean hasPolymorphism(SerialDescriptor descriptor, Set<String> already
 		}
 		return false;
 	}
+
+	@Override
+	protected boolean supportsRepeatableWrites(Object object) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/BufferedImageHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/BufferedImageHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -226,7 +226,17 @@ public void write(final BufferedImage image, @Nullable final MediaType contentTy
 		outputMessage.getHeaders().setContentType(selectedContentType);
 
 		if (outputMessage instanceof StreamingHttpOutputMessage streamingOutputMessage) {
-			streamingOutputMessage.setBody(outputStream -> writeInternal(image, selectedContentType, outputStream));
+			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
+				@Override
+				public void writeTo(OutputStream outputStream) throws IOException {
+					BufferedImageHttpMessageConverter.this.writeInternal(image, selectedContentType, outputStream);
+				}
+
+				@Override
+				public boolean repeatable() {
+					return true;
+				}
+			});
 		}
 		else {
 			writeInternal(image, selectedContentType, outputMessage.getBody());
diff --git a/spring-web/src/main/java/org/springframework/http/converter/ByteArrayHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/ByteArrayHttpMessageConverter.java
@@ -67,4 +67,8 @@ protected void writeInternal(byte[] bytes, HttpOutputMessage outputMessage) thro
 		StreamUtils.copy(bytes, outputMessage.getBody());
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(byte[] bytes) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java
@@ -400,7 +400,17 @@ private void writeForm(MultiValueMap<String, Object> formData, @Nullable MediaTy
 		outputMessage.getHeaders().setContentLength(bytes.length);
 
 		if (outputMessage instanceof StreamingHttpOutputMessage streamingOutputMessage) {
-			streamingOutputMessage.setBody(outputStream -> StreamUtils.copy(bytes, outputStream));
+			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
+				@Override
+				public void writeTo(OutputStream outputStream) throws IOException {
+					StreamUtils.copy(bytes, outputStream);
+				}
+
+				@Override
+				public boolean repeatable() {
+					return true;
+				}
+			});
 		}
 		else {
 			StreamUtils.copy(bytes, outputMessage.getBody());
diff --git a/spring-web/src/main/java/org/springframework/http/converter/ObjectToStringHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/ObjectToStringHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -135,4 +135,8 @@ protected Long getContentLength(Object obj, @Nullable MediaType contentType) {
 		return this.stringHttpMessageConverter.getContentLength(value, contentType);
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Object o) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/ResourceHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/ResourceHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -166,4 +166,8 @@ protected void writeContent(Resource resource, HttpOutputMessage outputMessage)
 		}
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Resource resource) {
+		return !(resource instanceof InputStreamResource);
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/ResourceRegionHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/ResourceRegionHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -24,6 +24,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Collection;
 
+import org.springframework.core.io.InputStreamResource;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.support.ResourceRegion;
 import org.springframework.http.HttpHeaders;
@@ -238,4 +239,24 @@ private static void print(OutputStream os, String buf) throws IOException {
 		os.write(buf.getBytes(StandardCharsets.US_ASCII));
 	}
 
+	@Override
+	@SuppressWarnings("unchecked")
+	protected boolean supportsRepeatableWrites(Object object) {
+		if (object instanceof ResourceRegion resourceRegion) {
+			return supportsRepeatableWrites(resourceRegion);
+		}
+		else {
+			Collection<ResourceRegion> regions = (Collection<ResourceRegion>) object;
+			for (ResourceRegion region : regions) {
+				if (!supportsRepeatableWrites(region)) {
+					return false;
+				}
+			}
+			return true;
+		}
+	}
+
+	private boolean supportsRepeatableWrites(ResourceRegion region) {
+		return !(region.getResource() instanceof InputStreamResource);
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/StringHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/StringHttpMessageConverter.java
@@ -163,4 +163,8 @@ else if (contentType.isCompatibleWith(MediaType.APPLICATION_JSON) ||
 		return charset;
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(String s) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/feed/AbstractWireFeedHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/feed/AbstractWireFeedHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -107,4 +107,8 @@ protected void writeInternal(T wireFeed, HttpOutputMessage outputMessage)
 		}
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(T t) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/AbstractJackson2HttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/json/AbstractJackson2HttpMessageConverter.java
@@ -568,4 +568,8 @@ protected Long getContentLength(Object object, @Nullable MediaType contentType)
 		return super.getContentLength(object, contentType);
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Object o) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/GsonHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/json/GsonHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -107,4 +107,8 @@ protected void writeInternal(Object object, @Nullable Type type, Writer writer)
 		}
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Object o) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/JsonbHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/json/JsonbHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -110,4 +110,8 @@ protected void writeInternal(Object object, @Nullable Type type, Writer writer)
 		}
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Object o) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufHttpMessageConverter.java
@@ -247,6 +247,10 @@ private void setProtoHeader(HttpOutputMessage response, Message message) {
 		response.getHeaders().set(X_PROTOBUF_MESSAGE_HEADER, message.getDescriptorForType().getFullName());
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Message message) {
+		return true;
+	}
 
 	/**
 	 * Protobuf format support.
diff --git a/spring-web/src/main/java/org/springframework/http/converter/xml/Jaxb2RootElementHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/xml/Jaxb2RootElementHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -200,6 +200,11 @@ private void setCharset(@Nullable MediaType contentType, Marshaller marshaller)
 		}
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Object o) {
+		return true;
+	}
+
 
 	private static final EntityResolver NO_OP_ENTITY_RESOLVER =
 			(publicId, systemId) -> new InputSource(new StringReader(""));
diff --git a/spring-web/src/main/java/org/springframework/http/converter/xml/MarshallingHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/xml/MarshallingHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -137,4 +137,8 @@ protected void writeToResult(Object o, HttpHeaders headers, Result result) throw
 		this.marshaller.marshal(o, result);
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(Object o) {
+		return true;
+	}
 }
diff --git a/spring-web/src/main/java/org/springframework/http/converter/xml/SourceHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/xml/SourceHttpMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -269,6 +269,11 @@ private void transform(Source source, Result result) throws TransformerException
 		this.transformerFactory.newTransformer().transform(source, result);
 	}
 
+	@Override
+	protected boolean supportsRepeatableWrites(T t) {
+		return t instanceof DOMSource;
+	}
+
 
 	private static class CountingOutputStream extends OutputStream {
 
diff --git a/spring-web/src/test/java/org/springframework/http/converter/ByteArrayHttpMessageConverterTests.java b/spring-web/src/test/java/org/springframework/http/converter/ByteArrayHttpMessageConverterTests.java
@@ -79,4 +79,18 @@ public void write() throws IOException {
 		assertThat(outputMessage.getHeaders().getContentLength()).isEqualTo(2);
 	}
 
+	@Test
+	public void repeatableWrites() throws IOException {
+		MockHttpOutputMessage outputMessage1 = new MockHttpOutputMessage();
+		byte[] body = new byte[]{0x1, 0x2};
+		assertThat(converter.supportsRepeatableWrites(body)).isTrue();
+
+		converter.write(body, null, outputMessage1);
+		assertThat(outputMessage1.getBodyAsBytes()).isEqualTo(body);
+
+		MockHttpOutputMessage outputMessage2 = new MockHttpOutputMessage();
+		converter.write(body, null, outputMessage2);
+		assertThat(outputMessage2.getBodyAsBytes()).isEqualTo(body);
+	}
+
 }
diff --git a/spring-web/src/test/java/org/springframework/http/converter/StringHttpMessageConverterTests.java b/spring-web/src/test/java/org/springframework/http/converter/StringHttpMessageConverterTests.java
diff --git a/spring-web/src/test/java/org/springframework/http/converter/json/MappingJackson2HttpMessageConverterTests.java b/spring-web/src/test/java/org/springframework/http/converter/json/MappingJackson2HttpMessageConverterTests.java
diff --git a/spring-web/src/test/java/org/springframework/http/converter/xml/SourceHttpMessageConverterTests.java b/spring-web/src/test/java/org/springframework/http/converter/xml/SourceHttpMessageConverterTests.java

Original file line number	Diff line number	Diff line change
`@@ -178,4 +178,9 @@ private boolean hasPolymorphism(SerialDescriptor descriptor, Set<String> already`
`178`	`178`	`}`
`179`	`179`	`return false;`
`180`	`180`	`}`
	`181`	`+`
	`182`	`+ @Override`
	`183`	`+ protected boolean supportsRepeatableWrites(Object object) {`
	`184`	`+ return true;`
	`185`	`+ }`
`181`	`186`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,4 +67,8 @@ protected void writeInternal(byte[] bytes, HttpOutputMessage outputMessage) thro`
`67`	`67`	`StreamUtils.copy(bytes, outputMessage.getBody());`
`68`	`68`	`}`
`69`	`69`
	`70`	`+ @Override`
	`71`	`+ protected boolean supportsRepeatableWrites(byte[] bytes) {`
	`72`	`+ return true;`
	`73`	`+ }`
`70`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2018 the original author or authors.`
	`2`	`+ * Copyright 2002-2023 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -135,4 +135,8 @@ protected Long getContentLength(Object obj, @Nullable MediaType contentType) {`
`135`	`135`	`return this.stringHttpMessageConverter.getContentLength(value, contentType);`
`136`	`136`	`}`
`137`	`137`
	`138`	`+ @Override`
	`139`	`+ protected boolean supportsRepeatableWrites(Object o) {`
	`140`	`+ return true;`
	`141`	`+ }`
`138`	`142`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2022 the original author or authors.`
	`2`	`+ * Copyright 2002-2023 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -166,4 +166,8 @@ protected void writeContent(Resource resource, HttpOutputMessage outputMessage)`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`
	`169`	`+ @Override`
	`170`	`+ protected boolean supportsRepeatableWrites(Resource resource) {`
	`171`	`+ return !(resource instanceof InputStreamResource);`
	`172`	`+ }`
`169`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -163,4 +163,8 @@ else if (contentType.isCompatibleWith(MediaType.APPLICATION_JSON) \|\|`
`163`	`163`	`return charset;`
`164`	`164`	`}`
`165`	`165`
	`166`	`+ @Override`
	`167`	`+ protected boolean supportsRepeatableWrites(String s) {`
	`168`	`+ return true;`
	`169`	`+ }`
`166`	`170`	`}`