root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

SPR-7789 - FormHttpMessageConverter does not honor the charset in the content type when writing a form and uses a wrong default charset 

git-svn-id: https://src.springframework.org/svn/spring-framework/trunk@3826 50f2f4bb-b051-0410-bef5-90022cba6387
This commit is contained in:
Arjen Poutsma 2010-12-20 16:56:14 +00:00
parent bc235c5b03
commit a3583fd5c4
1 changed files with 38 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
org.springframework.web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java
View File

@ -45,35 +45,26 @@ import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils; import org.springframework.util.StringUtils;
/** /**
* Implementation of {@link HttpMessageConverter} that can handle form data, including multipart form data * Implementation of {@link HttpMessageConverter} that can handle form data, including multipart form data (i.e. file
* (i.e. file uploads). * uploads).
* *
* <p>This converter can write the {@code application/x-www-form-urlencoded} and {@code multipart/form-data} media * <p>This converter can write the {@code application/x-www-form-urlencoded} and {@code multipart/form-data} media
* types, and read the {@code application/x-www-form-urlencoded}) media type (but not {@code multipart/form-data}). * types, and read the {@code application/x-www-form-urlencoded}) media type (but not {@code multipart/form-data}).
* *
* <p>In other words, this converter can read and write 'normal' HTML forms (as * <p>In other words, this converter can read and write 'normal' HTML forms (as {@link MultiValueMap
* {@link MultiValueMap MultiValueMap&lt;String, String&gt;}), and it can write multipart form (as * MultiValueMap&lt;String, String&gt;}), and it can write multipart form (as {@link MultiValueMap
* {@link MultiValueMap MultiValueMap&lt;String, Object&gt;}. When writing multipart, this converter uses other * MultiValueMap&lt;String, Object&gt;}. When writing multipart, this converter uses other {@link HttpMessageConverter
* {@link HttpMessageConverter HttpMessageConverters} to write the respective MIME parts. By default, basic converters * HttpMessageConverters} to write the respective MIME parts. By default, basic converters are registered (supporting
* are registered (supporting {@code Strings} and {@code Resources}, for instance); these can be overridden by setting * {@code Strings} and {@code Resources}, for instance); these can be overridden by setting the {@link
* the {@link #setPartConverters(java.util.List) partConverters} property. * #setPartConverters(java.util.List) partConverters} property.
* *
* <p>For example, the following snippet shows how to submit an HTML form: * <p>For example, the following snippet shows how to submit an HTML form: <pre class="code"> RestTemplate template =
* <pre class="code"> * new RestTemplate(); // FormHttpMessageConverter is configured by default MultiValueMap&lt;String, String&gt; form =
* RestTemplate template = new RestTemplate(); // FormHttpMessageConverter is configured by default * new LinkedMultiValueMap&lt;String, String&gt;(); form.add("field 1", "value 1"); form.add("field 2", "value 2");
* MultiValueMap&lt;String, String&gt; form = new LinkedMultiValueMap&lt;String, String&gt;(); * form.add("field 2", "value 3"); template.postForLocation("http://example.com/myForm", form); </pre> <p>The following
* form.add("field 1", "value 1"); * snippet shows how to do a file upload: <pre class="code"> MultiValueMap&lt;String, Object&gt; parts = new
* form.add("field 2", "value 2"); * LinkedMultiValueMap&lt;String, Object&gt;(); parts.add("field 1", "value 1"); parts.add("file", new
* form.add("field 2", "value 3"); * ClassPathResource("myFile.jpg")); template.postForLocation("http://example.com/myFileUpload", parts); </pre>
* template.postForLocation("http://example.com/myForm", form);
* </pre>
* <p>The following snippet shows how to do a file upload:
* <pre class="code">
* MultiValueMap&lt;String, Object&gt; parts = new LinkedMultiValueMap&lt;String, Object&gt;();
* parts.add("field 1", "value 1");
* parts.add("file", new ClassPathResource("myFile.jpg"));
* template.postForLocation("http://example.com/myFileUpload", parts);
* </pre>
* *
* <p>Some methods in this class were inspired by {@link org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity}. * <p>Some methods in this class were inspired by {@link org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity}.
* *
@ -87,7 +78,7 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
new byte[]{'-', '_', '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 'a', 'b', 'c', 'd', 'e', 'f', 'g', new byte[]{'-', '_', '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 'a', 'b', 'c', 'd', 'e', 'f', 'g',
'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A',
'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U',
'V', 'W', 'X', 'Y', 'Z'}; 'V', 'W', 'X', 'Y', 'Z'};
private final Random rnd = new Random(); private final Random rnd = new Random();
@ -95,7 +86,6 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
private List<HttpMessageConverter<?>> partConverters = new ArrayList<HttpMessageConverter<?>>(); private List<HttpMessageConverter<?>> partConverters = new ArrayList<HttpMessageConverter<?>>();
public FormHttpMessageConverter() { public FormHttpMessageConverter() {
this.partConverters.add(new ByteArrayHttpMessageConverter()); this.partConverters.add(new ByteArrayHttpMessageConverter());
StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter(); StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
@ -104,31 +94,23 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
this.partConverters.add(new ResourceHttpMessageConverter()); this.partConverters.add(new ResourceHttpMessageConverter());
} }
/** Add a message body converter. Such a converters is used to convert objects to MIME parts. */
/**
* Add a message body converter. Such a converters is used to convert objects to MIME parts.
*/
public final void addPartConverter(HttpMessageConverter<?> partConverter) { public final void addPartConverter(HttpMessageConverter<?> partConverter) {
Assert.notNull(partConverter, "'partConverter' must not be NULL"); Assert.notNull(partConverter, "'partConverter' must not be NULL");
this.partConverters.add(partConverter); this.partConverters.add(partConverter);
} }
/** /** Set the message body converters to use. These converters are used to convert objects to MIME parts. */
* Set the message body converters to use. These converters are used to convert objects to MIME parts.
*/
public final void setPartConverters(List<HttpMessageConverter<?>> partConverters) { public final void setPartConverters(List<HttpMessageConverter<?>> partConverters) {
Assert.notEmpty(partConverters, "'partConverters' must not be empty"); Assert.notEmpty(partConverters, "'partConverters' must not be empty");
this.partConverters = partConverters; this.partConverters = partConverters;
} }
/** /** Sets the character set used for writing form data. */
* Sets the character set used for writing form data.
*/
public void setCharset(Charset charset) { public void setCharset(Charset charset) {
this.charset = charset; this.charset = charset;
} }
public boolean canRead(Class<?> clazz, MediaType mediaType) { public boolean canRead(Class<?> clazz, MediaType mediaType) {
if (!MultiValueMap.class.isAssignableFrom(clazz)) { if (!MultiValueMap.class.isAssignableFrom(clazz)) {
return false; return false;
@ -187,7 +169,7 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
public void write(MultiValueMap<String, ?> map, MediaType contentType, HttpOutputMessage outputMessage) public void write(MultiValueMap<String, ?> map, MediaType contentType, HttpOutputMessage outputMessage)
throws IOException, HttpMessageNotWritableException { throws IOException, HttpMessageNotWritableException {
if (!isMultipart(map, contentType)) { if (!isMultipart(map, contentType)) {
writeForm((MultiValueMap<String, String>) map, outputMessage); writeForm((MultiValueMap<String, String>) map, contentType, outputMessage);
} }
else { else {
writeMultipart((MultiValueMap<String, Object>) map, outputMessage); writeMultipart((MultiValueMap<String, Object>) map, outputMessage);
@ -208,8 +190,16 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
return false; return false;
} }
private void writeForm(MultiValueMap<String, String> form, HttpOutputMessage outputMessage) throws IOException { private void writeForm(MultiValueMap<String, String> form, MediaType contentType, HttpOutputMessage outputMessage)
outputMessage.getHeaders().setContentType(MediaType.APPLICATION_FORM_URLENCODED); throws IOException {
Charset charset;
if (contentType != null) {
outputMessage.getHeaders().setContentType(contentType);
charset = contentType.getCharSet() != null ? contentType.getCharSet() : this.charset;
} else {
outputMessage.getHeaders().setContentType(MediaType.APPLICATION_FORM_URLENCODED);
charset = this.charset;
}
StringBuilder builder = new StringBuilder(); StringBuilder builder = new StringBuilder();
for (Iterator<String> nameIterator = form.keySet().iterator(); nameIterator.hasNext();) { for (Iterator<String> nameIterator = form.keySet().iterator(); nameIterator.hasNext();) {
String name = nameIterator.next(); String name = nameIterator.next();
@ -231,7 +221,8 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
FileCopyUtils.copy(builder.toString(), new OutputStreamWriter(outputMessage.getBody(), charset)); FileCopyUtils.copy(builder.toString(), new OutputStreamWriter(outputMessage.getBody(), charset));
} }
private void writeMultipart(MultiValueMap<String, Object> parts, HttpOutputMessage outputMessage) throws IOException { private void writeMultipart(MultiValueMap<String, Object> parts, HttpOutputMessage outputMessage)
throws IOException {
byte[] boundary = generateMultipartBoundary(); byte[] boundary = generateMultipartBoundary();
Map<String, String> parameters = Collections.singletonMap("boundary", new String(boundary, "US-ASCII")); Map<String, String> parameters = Collections.singletonMap("boundary", new String(boundary, "US-ASCII"));
@ -308,8 +299,8 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
} }
/** /**
* Generate a multipart boundary. * Generate a multipart boundary. <p>Default implementation returns a random boundary. Can be overridden in
* <p>Default implementation returns a random boundary. Can be overridden in subclasses. * subclasses.
*/ */
protected byte[] generateMultipartBoundary() { protected byte[] generateMultipartBoundary() {
byte[] boundary = new byte[rnd.nextInt(11) + 30]; byte[] boundary = new byte[rnd.nextInt(11) + 30];
@ -321,8 +312,9 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
/** /**
* Return the filename of the given multipart part. This value will be used for the {@code Content-Disposition} header. * Return the filename of the given multipart part. This value will be used for the {@code Content-Disposition} header.
* <p>Default implementation returns {@link Resource#getFilename()} if the part is a {@code Resource}, and * <p>Default implementation returns {@link Resource#getFilename()} if the part is a {@code Resource}, and {@code null}
* {@code null} in other cases. Can be overridden in subclasses. * in other cases. Can be overridden in subclasses.
*
* @param part the part to determine the file name for * @param part the part to determine the file name for
* @return the filename, or {@code null} if not known * @return the filename, or {@code null} if not known
*/ */
@ -336,10 +328,7 @@ public class FormHttpMessageConverter implements HttpMessageConverter<MultiValue
} }
} }
/** Implementation of {@link org.springframework.http.HttpOutputMessage} used for writing multipart data. */
/**
* Implementation of {@link org.springframework.http.HttpOutputMessage} used for writing multipart data.
*/
private class MultipartHttpOutputMessage implements HttpOutputMessage { private class MultipartHttpOutputMessage implements HttpOutputMessage {
private final HttpHeaders headers = new HttpHeaders(); private final HttpHeaders headers = new HttpHeaders();