Construct StringWriter instances with appropriate initial size

Closes gh-25789

Author: jhoeller

spring-context-support/src/main/java/org/springframework/ui/freemarker/FreeMarkerTemplateUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 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,7 +46,7 @@ public abstract class FreeMarkerTemplateUtils {
 	public static String processTemplateIntoString(Template template, Object model)
 			throws IOException, TemplateException {
 
-		StringWriter result = new StringWriter();
+		StringWriter result = new StringWriter(1024);
 		template.process(model, result);
 		return result.toString();
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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.
@@ -43,6 +43,9 @@
  */
 public abstract class FileCopyUtils {
 
+	/**
+	 * The default buffer size used when copying bytes.
+	 */
 	public static final int BUFFER_SIZE = StreamUtils.BUFFER_SIZE;
 
 
@@ -178,15 +181,15 @@ public static int copy(Reader in, Writer out) throws IOException {
 		Assert.notNull(out, "No Writer specified");
 
 		try {
-			int byteCount = 0;
+			int charCount = 0;
 			char[] buffer = new char[BUFFER_SIZE];
-			int bytesRead = -1;
-			while ((bytesRead = in.read(buffer)) != -1) {
-				out.write(buffer, 0, bytesRead);
-				byteCount += bytesRead;
+			int charsRead;
+			while ((charsRead = in.read(buffer)) != -1) {
+				out.write(buffer, 0, charsRead);
+				charCount += charsRead;
 			}
 			out.flush();
-			return byteCount;
+			return charCount;
 		}
 		finally {
 			try {
@@ -203,7 +206,7 @@ public static int copy(Reader in, Writer out) throws IOException {
 	}
 
 	/**
-	 * Copy the contents of the given String to the given output Writer.
+	 * Copy the contents of the given String to the given Writer.
 	 * Closes the writer when done.
 	 * @param in the String to copy from
 	 * @param out the Writer to copy to
@@ -237,7 +240,7 @@ public static String copyToString(@Nullable Reader in) throws IOException {
 			return "";
 		}
 
-		StringWriter out = new StringWriter();
+		StringWriter out = new StringWriter(BUFFER_SIZE);
 		copy(in, out);
 		return out.toString();
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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.
@@ -45,14 +45,17 @@
  */
 public abstract class StreamUtils {
 
+	/**
+	 * The default buffer size used when copying bytes.
+	 */
 	public static final int BUFFER_SIZE = 4096;
 
 	private static final byte[] EMPTY_CONTENT = new byte[0];
 
 
 	/**
 	 * Copy the contents of the given InputStream into a new byte array.
-	 * Leaves the stream open when done.
+	 * <p>Leaves the stream open when done.
 	 * @param in the stream to copy from (may be {@code null} or empty)
 	 * @return the new byte array that has been copied to (possibly empty)
 	 * @throws IOException in case of I/O errors
@@ -69,8 +72,9 @@ public static byte[] copyToByteArray(@Nullable InputStream in) throws IOExceptio
 
 	/**
 	 * Copy the contents of the given InputStream into a String.
-	 * Leaves the stream open when done.
+	 * <p>Leaves the stream open when done.
 	 * @param in the InputStream to copy from (may be {@code null} or empty)
+	 * @param charset the {@link Charset} to use to decode the bytes
 	 * @return the String that has been copied to (possibly empty)
 	 * @throws IOException in case of I/O errors
 	 */
@@ -79,19 +83,19 @@ public static String copyToString(@Nullable InputStream in, Charset charset) thr
 			return "";
 		}
 
-		StringBuilder out = new StringBuilder();
+		StringBuilder out = new StringBuilder(BUFFER_SIZE);
 		InputStreamReader reader = new InputStreamReader(in, charset);
 		char[] buffer = new char[BUFFER_SIZE];
-		int bytesRead = -1;
-		while ((bytesRead = reader.read(buffer)) != -1) {
-			out.append(buffer, 0, bytesRead);
+		int charsRead;
+		while ((charsRead = reader.read(buffer)) != -1) {
+			out.append(buffer, 0, charsRead);
 		}
 		return out.toString();
 	}
 
 	/**
 	 * Copy the contents of the given byte array to the given OutputStream.
-	 * Leaves the stream open when done.
+	 * <p>Leaves the stream open when done.
 	 * @param in the byte array to copy from
 	 * @param out the OutputStream to copy to
 	 * @throws IOException in case of I/O errors
@@ -101,19 +105,20 @@ public static void copy(byte[] in, OutputStream out) throws IOException {
 		Assert.notNull(out, "No OutputStream specified");
 
 		out.write(in);
+		out.flush();
 	}
 
 	/**
-	 * Copy the contents of the given String to the given output OutputStream.
-	 * Leaves the stream open when done.
+	 * Copy the contents of the given String to the given OutputStream.
+	 * <p>Leaves the stream open when done.
 	 * @param in the String to copy from
 	 * @param charset the Charset
 	 * @param out the OutputStream to copy to
 	 * @throws IOException in case of I/O errors
 	 */
 	public static void copy(String in, Charset charset, OutputStream out) throws IOException {
 		Assert.notNull(in, "No input String specified");
-		Assert.notNull(charset, "No charset specified");
+		Assert.notNull(charset, "No Charset specified");
 		Assert.notNull(out, "No OutputStream specified");
 
 		Writer writer = new OutputStreamWriter(out, charset);
@@ -123,7 +128,7 @@ public static void copy(String in, Charset charset, OutputStream out) throws IOE
 
 	/**
 	 * Copy the contents of the given InputStream to the given OutputStream.
-	 * Leaves both streams open when done.
+	 * <p>Leaves both streams open when done.
 	 * @param in the InputStream to copy from
 	 * @param out the OutputStream to copy to
 	 * @return the number of bytes copied
@@ -135,7 +140,7 @@ public static int copy(InputStream in, OutputStream out) throws IOException {
 
 		int byteCount = 0;
 		byte[] buffer = new byte[BUFFER_SIZE];
-		int bytesRead = -1;
+		int bytesRead;
 		while ((bytesRead = in.read(buffer)) != -1) {
 			out.write(buffer, 0, bytesRead);
 			byteCount += bytesRead;
@@ -167,7 +172,7 @@ public static long copyRange(InputStream in, OutputStream out, long start, long
 		}
 
 		long bytesToCopy = end - start + 1;
-		byte[] buffer = new byte[StreamUtils.BUFFER_SIZE];
+		byte[] buffer = new byte[(int) Math.min(StreamUtils.BUFFER_SIZE, bytesToCopy)];
 		while (bytesToCopy > 0) {
 			int bytesRead = in.read(buffer);
 			if (bytesRead == -1) {
@@ -187,7 +192,7 @@ else if (bytesRead <= bytesToCopy) {
 
 	/**
 	 * Drain the remaining content of the given InputStream.
-	 * Leaves the InputStream open when done.
+	 * <p>Leaves the InputStream open when done.
 	 * @param in the InputStream to drain
 	 * @return the number of bytes read
 	 * @throws IOException in case of I/O errors
@@ -257,7 +262,7 @@ public NonClosingOutputStream(OutputStream out) {
 		@Override
 		public void write(byte[] b, int off, int let) throws IOException {
 			// It is critical that we override this method for performance
-			out.write(b, off, let);
+			this.out.write(b, off, let);
 		}
 
 		@Override

spring-jms/src/main/java/org/springframework/jms/support/converter/MappingJackson2MessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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.
@@ -121,7 +121,7 @@ public void setTargetType(MessageType targetType) {
 	/**
 	 * Specify the encoding to use when converting to and from text-based
 	 * message body content. The default encoding will be "UTF-8".
-	 * <p>When reading from a a text-based message, an encoding may have been
+	 * <p>When reading from a text-based message, an encoding may have been
 	 * suggested through a special JMS property which will then be preferred
 	 * over the encoding set on this MessageConverter instance.
 	 * @see #setEncodingPropertyName
@@ -267,13 +267,13 @@ protected Message toMessage(Object object, Session session, ObjectWriter objectW
 	 * @return the resulting message
 	 * @throws JMSException if thrown by JMS methods
 	 * @throws IOException in case of I/O errors
-	 * @see Session#createBytesMessage
 	 * @since 4.3
+	 * @see Session#createBytesMessage
 	 */
 	protected TextMessage mapToTextMessage(Object object, Session session, ObjectWriter objectWriter)
 			throws JMSException, IOException {
 
-		StringWriter writer = new StringWriter();
+		StringWriter writer = new StringWriter(1024);
 		objectWriter.writeValue(writer, object);
 		return session.createTextMessage(writer.toString());
 	}
@@ -330,7 +330,7 @@ protected Message mapToMessage(Object object, Session session, ObjectWriter obje
 	 * sets the resulting value (either a mapped id or the raw Java class name)
 	 * into the configured type id message property.
 	 * @param object the payload object to set a type id for
-	 * @param message the JMS Message to set the type id on
+	 * @param message the JMS Message on which to set the type id property
 	 * @throws JMSException if thrown by JMS methods
 	 * @see #getJavaTypeForMessage(javax.jms.Message)
 	 * @see #setTypeIdPropertyName(String)
@@ -426,7 +426,7 @@ protected Object convertFromMessage(Message message, JavaType targetJavaType)
 	 * <p>The default implementation parses the configured type id property name
 	 * and consults the configured type id mapping. This can be overridden with
 	 * a different strategy, e.g. doing some heuristics based on message origin.
-	 * @param message the JMS Message to set the type id on
+	 * @param message the JMS Message from which to get the type id property
 	 * @throws JMSException if thrown by JMS methods
 	 * @see #setTypeIdOnMessage(Object, javax.jms.Message)
 	 * @see #setTypeIdPropertyName(String)
@@ -441,11 +441,11 @@ protected JavaType getJavaTypeForMessage(Message message) throws JMSException {
 		}
 		Class<?> mappedClass = this.idClassMappings.get(typeId);
 		if (mappedClass != null) {
-			return this.objectMapper.getTypeFactory().constructType(mappedClass);
+			return this.objectMapper.constructType(mappedClass);
 		}
 		try {
 			Class<?> typeClass = ClassUtils.forName(typeId, this.beanClassLoader);
-			return this.objectMapper.getTypeFactory().constructType(typeClass);
+			return this.objectMapper.constructType(typeClass);
 		}
 		catch (Throwable ex) {
 			throw new MessageConversionException("Failed to resolve type id [" + typeId + "]", ex);

spring-jms/src/main/java/org/springframework/jms/support/converter/MarshallingMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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.
@@ -47,8 +47,6 @@
  * @author Arjen Poutsma
  * @author Juergen Hoeller
  * @since 3.0
- * @see org.springframework.jms.core.JmsTemplate#convertAndSend
- * @see org.springframework.jms.core.JmsTemplate#receiveAndConvert
  */
 public class MarshallingMessageConverter implements MessageConverter, InitializingBean {
 
@@ -214,7 +212,7 @@ else if (message instanceof BytesMessage) {
 	protected TextMessage marshalToTextMessage(Object object, Session session, Marshaller marshaller)
 			throws JMSException, IOException, XmlMappingException {
 
-		StringWriter writer = new StringWriter();
+		StringWriter writer = new StringWriter(1024);
 		Result result = new StreamResult(writer);
 		marshaller.marshal(object, result);
 		return session.createTextMessage(writer.toString());

spring-messaging/src/main/java/org/springframework/messaging/converter/MappingJackson2MessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 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.
@@ -141,6 +141,7 @@ private void configurePrettyPrint() {
 		}
 	}
 
+
 	@Override
 	protected boolean canConvertFrom(Message<?> message, @Nullable Class<?> targetClass) {
 		if (targetClass == null || !supportsMimeType(message.getHeaders())) {
@@ -223,6 +224,7 @@ protected Object convertFromInternal(Message<?> message, Class<?> targetClass, @
 				}
 			}
 			else {
+				// Assuming a text-based source payload
 				if (view != null) {
 					return this.objectMapper.readerWithView(view).forType(javaType).readValue(payload.toString());
 				}
@@ -246,7 +248,7 @@ private JavaType getJavaType(Class<?> targetClass, @Nullable Object conversionHi
 			Type genericParameterType = param.getNestedGenericParameterType();
 			Class<?> contextClass = param.getContainingClass();
 			Type type = GenericTypeResolver.resolveType(genericParameterType, contextClass);
-			return this.objectMapper.getTypeFactory().constructType(type);
+			return this.objectMapper.constructType(type);
 		}
 		return this.objectMapper.constructType(targetClass);
 	}
@@ -271,7 +273,8 @@ protected Object convertToInternal(Object payload, @Nullable MessageHeaders head
 				payload = out.toByteArray();
 			}
 			else {
-				Writer writer = new StringWriter();
+				// Assuming a text-based target payload
+				Writer writer = new StringWriter(1024);
 				if (view != null) {
 					this.objectMapper.writerWithView(view).writeValue(writer, payload);
 				}
@@ -330,7 +333,7 @@ private Class<?> extractViewClass(JsonView annotation, Object conversionHint) {
 	 * @return the JSON encoding to use (never {@code null})
 	 */
 	protected JsonEncoding getJsonEncoding(@Nullable MimeType contentType) {
-		if (contentType != null && (contentType.getCharset() != null)) {
+		if (contentType != null && contentType.getCharset() != null) {
 			Charset charset = contentType.getCharset();
 			for (JsonEncoding encoding : JsonEncoding.values()) {
 				if (charset.name().equals(encoding.getJavaName())) {

spring-messaging/src/main/java/org/springframework/messaging/converter/MarshallingMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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,6 +46,8 @@
  *
  * @author Arjen Poutsma
  * @since 4.2
+ * @see Marshaller
+ * @see Unmarshaller
  */
 public class MarshallingMessageConverter extends AbstractMessageConverter {
 
@@ -61,7 +63,8 @@ public class MarshallingMessageConverter extends AbstractMessageConverter {
 	 * {@link #setUnmarshaller(Unmarshaller)} to be invoked separately.
 	 */
 	public MarshallingMessageConverter() {
-		this(new MimeType("application", "xml"), new MimeType("text", "xml"), new MimeType("application", "*+xml"));
+		this(new MimeType("application", "xml"), new MimeType("text", "xml"),
+				new MimeType("application", "*+xml"));
 	}
 
 	/**
@@ -160,7 +163,7 @@ private Source getSource(Object payload) {
 			return new StreamSource(new ByteArrayInputStream((byte[]) payload));
 		}
 		else {
-			return new StreamSource(new StringReader((String) payload));
+			return new StreamSource(new StringReader(payload.toString()));
 		}
 	}
 
@@ -172,13 +175,13 @@ protected Object convertToInternal(Object payload, @Nullable MessageHeaders head
 		Assert.notNull(this.marshaller, "Property 'marshaller' is required");
 		try {
 			if (byte[].class == getSerializedPayloadClass()) {
-				ByteArrayOutputStream out = new ByteArrayOutputStream();
+				ByteArrayOutputStream out = new ByteArrayOutputStream(1024);
 				Result result = new StreamResult(out);
 				this.marshaller.marshal(payload, result);
 				payload = out.toByteArray();
 			}
 			else {
-				Writer writer = new StringWriter();
+				Writer writer = new StringWriter(1024);
 				Result result = new StreamResult(writer);
 				this.marshaller.marshal(payload, result);
 				payload = writer.toString();