Merge branch '6.1.x'

Author: jhoeller

spring-core/src/main/java/org/springframework/util/StreamUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -178,18 +178,13 @@ public static long copyRange(InputStream in, OutputStream out, long start, long
 		long bytesToCopy = end - start + 1;
 		byte[] buffer = new byte[(int) Math.min(StreamUtils.BUFFER_SIZE, bytesToCopy)];
 		while (bytesToCopy > 0) {
-			int bytesRead = in.read(buffer);
+			int bytesRead = (bytesToCopy < buffer.length ? in.read(buffer, 0, (int) bytesToCopy) :
+					in.read(buffer));
 			if (bytesRead == -1) {
 				break;
 			}
-			else if (bytesRead <= bytesToCopy) {
-				out.write(buffer, 0, bytesRead);
-				bytesToCopy -= bytesRead;
-			}
-			else {
-				out.write(buffer, 0, (int) bytesToCopy);
-				bytesToCopy = 0;
-			}
+			out.write(buffer, 0, bytesRead);
+			bytesToCopy -= bytesRead;
 		}
 		return (end - start + 1 - bytesToCopy);
 	}
@@ -204,7 +199,9 @@ else if (bytesRead <= bytesToCopy) {
 	 */
 	@Contract("null -> fail")
 	public static int drain(@Nullable InputStream in) throws IOException {
-		Assert.notNull(in, "No InputStream specified");
+		if (in == null) {
+			return 0;
+		}
 		return (int) in.transferTo(OutputStream.nullOutputStream());
 	}
 

spring-core/src/test/java/org/springframework/util/StreamUtilsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -38,13 +38,15 @@
  * Tests for {@link StreamUtils}.
  *
  * @author Phillip Webb
+ * @author Juergen Hoeller
  */
 class StreamUtilsTests {
 
 	private byte[] bytes = new byte[StreamUtils.BUFFER_SIZE + 10];
 
 	private String string = "";
 
+
 	@BeforeEach
 	void setup() {
 		new Random().nextBytes(bytes);
@@ -53,6 +55,7 @@ void setup() {
 		}
 	}
 
+
 	@Test
 	void copyToByteArray() throws Exception {
 		InputStream inputStream = new ByteArrayInputStream(bytes);
@@ -91,11 +94,30 @@ void copyStream() throws Exception {
 	}
 
 	@Test
-	void copyRange() throws Exception {
+	void copyRangeWithinBuffer() throws Exception {
+		ByteArrayOutputStream out = new ByteArrayOutputStream();
+		ByteArrayInputStream in = new ByteArrayInputStream(bytes);
+		StreamUtils.copyRange(in, out, 0, 100);
+		assertThat(in.available()).isEqualTo(bytes.length - 101);
+		assertThat(out.toByteArray()).isEqualTo(Arrays.copyOfRange(bytes, 0, 101));
+	}
+
+	@Test
+	void copyRangeBeyondBuffer() throws Exception {
 		ByteArrayOutputStream out = new ByteArrayOutputStream();
-		StreamUtils.copyRange(new ByteArrayInputStream(bytes), out, 0, 100);
-		byte[] range = Arrays.copyOfRange(bytes, 0, 101);
-		assertThat(out.toByteArray()).isEqualTo(range);
+		ByteArrayInputStream in = new ByteArrayInputStream(bytes);
+		StreamUtils.copyRange(in, out, 0, 8200);
+		assertThat(in.available()).isEqualTo(1);
+		assertThat(out.toByteArray()).isEqualTo(Arrays.copyOfRange(bytes, 0, 8201));
+	}
+
+	@Test
+	void copyRangeBeyondAvailable() throws Exception {
+		ByteArrayOutputStream out = new ByteArrayOutputStream();
+		ByteArrayInputStream in = new ByteArrayInputStream(bytes);
+		StreamUtils.copyRange(in, out, 0, 8300);
+		assertThat(in.available()).isEqualTo(0);
+		assertThat(out.toByteArray()).isEqualTo(Arrays.copyOfRange(bytes, 0, 8202));
 	}
 
 	@Test
@@ -127,4 +149,5 @@ void nonClosingOutputStream() throws Exception {
 		ordered.verify(source).write(bytes, 1, 2);
 		ordered.verify(source, never()).close();
 	}
+
 }

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

@@ -108,6 +108,23 @@ public String getFilename() {
 		}
 	}
 
+	@Override
+	protected void writeInternal(Resource resource, HttpOutputMessage outputMessage)
+			throws IOException, HttpMessageNotWritableException {
+
+		writeContent(resource, outputMessage);
+	}
+
+	/**
+	 * Add the default headers for the given resource to the given message.
+	 * @since 6.0
+	 */
+	public void addDefaultHeaders(HttpOutputMessage message, Resource resource, @Nullable MediaType contentType)
+			throws IOException {
+
+		addDefaultHeaders(message.getHeaders(), resource, contentType);
+	}
+
 	@Override
 	protected MediaType getDefaultContentType(Resource resource) {
 		return MediaTypeFactory.getMediaType(resource).orElse(MediaType.APPLICATION_OCTET_STREAM);
@@ -125,23 +142,15 @@ protected Long getContentLength(Resource resource, @Nullable MediaType contentTy
 		return (contentLength < 0 ? null : contentLength);
 	}
 
-	/**
-	 * Adds the default headers for the given resource to the given message.
-	 * @since 6.0
-	 */
-	public void addDefaultHeaders(HttpOutputMessage message, Resource resource, @Nullable MediaType contentType) throws IOException {
-		addDefaultHeaders(message.getHeaders(), resource, contentType);
-	}
-
 	@Override
-	protected void writeInternal(Resource resource, HttpOutputMessage outputMessage)
-			throws IOException, HttpMessageNotWritableException {
-
-		writeContent(resource, outputMessage);
+	protected boolean supportsRepeatableWrites(Resource resource) {
+		return !(resource instanceof InputStreamResource);
 	}
 
+
 	protected void writeContent(Resource resource, HttpOutputMessage outputMessage)
 			throws IOException, HttpMessageNotWritableException {
+
 		// We cannot use try-with-resources here for the InputStream, since we have
 		// custom handling of the close() method in a finally-block.
 		try {
@@ -168,8 +177,4 @@ protected void writeContent(Resource resource, HttpOutputMessage outputMessage)
 		}
 	}
 
-	@Override
-	protected boolean supportsRepeatableWrites(Resource resource) {
-		return !(resource instanceof InputStreamResource);
-	}
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -53,22 +53,6 @@ public ResourceRegionHttpMessageConverter() {
 	}
 
 
-	@Override
-	@SuppressWarnings("unchecked")
-	protected MediaType getDefaultContentType(Object object) {
-		Resource resource = null;
-		if (object instanceof ResourceRegion resourceRegion) {
-			resource = resourceRegion.getResource();
-		}
-		else {
-			Collection<ResourceRegion> regions = (Collection<ResourceRegion>) object;
-			if (!regions.isEmpty()) {
-				resource = regions.iterator().next().getResource();
-			}
-		}
-		return MediaTypeFactory.getMediaType(resource).orElse(MediaType.APPLICATION_OCTET_STREAM);
-	}
-
 	@Override
 	public boolean canRead(Class<?> clazz, @Nullable MediaType mediaType) {
 		return false;
@@ -138,6 +122,43 @@ protected void writeInternal(Object object, @Nullable Type type, HttpOutputMessa
 		}
 	}
 
+	@Override
+	protected MediaType getDefaultContentType(Object object) {
+		Resource resource = null;
+		if (object instanceof ResourceRegion resourceRegion) {
+			resource = resourceRegion.getResource();
+		}
+		else {
+			@SuppressWarnings("unchecked")
+			Collection<ResourceRegion> regions = (Collection<ResourceRegion>) object;
+			if (!regions.isEmpty()) {
+				resource = regions.iterator().next().getResource();
+			}
+		}
+		return MediaTypeFactory.getMediaType(resource).orElse(MediaType.APPLICATION_OCTET_STREAM);
+	}
+
+	@Override
+	protected boolean supportsRepeatableWrites(Object object) {
+		if (object instanceof ResourceRegion resourceRegion) {
+			return supportsRepeatableWrites(resourceRegion);
+		}
+		else {
+			@SuppressWarnings("unchecked")
+			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);
+	}
+
 
 	protected void writeResourceRegion(ResourceRegion region, HttpOutputMessage outputMessage) throws IOException {
 		Assert.notNull(region, "ResourceRegion must not be null");
@@ -240,24 +261,4 @@ 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);
-	}
 }