Skip to content

Commit 8b95697

Browse files
sbrannensbrannen
committedJun 27, 2024·
Set output_encoding in FreeMarkerView implementations
According to the official FreeMarker documentation, Spring's FreeMarkerView implementations should be configuring the output_encoding for template rendering. To address that, this commit modifies the FreeMarkerView implementations in Web MVC and WebFlux to explicitly set the output_encoding for template rendering. See https://freemarker.apache.org/docs/pgui_misc_charset.html#autoid_53 See gh-33071 Closes gh-33106
·
v7.0.0-M3v6.2.0-M5
1 parent 95887c8 commit 8b95697

File tree

7 files changed

+71
-27
lines changed

7 files changed

+71
-27
lines changed
 

‎spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerView.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import java.util.Map;
2727
import java.util.Optional;
2828

29+
import freemarker.core.Environment;
2930
import freemarker.core.ParseException;
3031
import freemarker.template.Configuration;
3132
import freemarker.template.DefaultObjectWrapperBuilder;
@@ -333,7 +334,9 @@ protected Mono<Void> renderInternal(Map<String, Object> renderAttributes,
333334
FastByteArrayOutputStream bos = new FastByteArrayOutputStream();
334335
Charset charset = getCharset(contentType);
335336
Writer writer = new OutputStreamWriter(bos, charset);
336-
template.process(freeMarkerModel, writer);
337+
Environment env = template.createProcessingEnvironment(freeMarkerModel, writer);
338+
env.setOutputEncoding(charset.name());
339+
env.process();
337340
byte[] bytes = bos.toByteArrayUnsafe();
338341
DataBuffer buffer = exchange.getResponse().bufferFactory().wrap(bytes);
339342
return Mono.just(buffer);

‎spring-webflux/src/test/java/org/springframework/web/reactive/config/WebFluxViewResolutionIntegrationTests.java

+12-4
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,20 @@ class WebFluxViewResolutionIntegrationTests {
5858

5959
private static final MediaType TEXT_HTML_ISO_8859_1 = MediaType.parseMediaType("text/html;charset=ISO-8859-1");
6060

61-
private static final String EXPECTED_BODY = "<html><body>Hello, Java Café</body></html>";
6261

6362

6463
@Nested
6564
class FreeMarkerTests {
6665

66+
private static final String EXPECTED_BODY = """
67+
<html>
68+
<body>
69+
<h1>Hello, Java Café</h1>
70+
<p>output_encoding: %s</p>
71+
</body>
72+
</html>
73+
""";
74+
6775
private static final ClassTemplateLoader classTemplateLoader =
6876
new ClassTemplateLoader(WebFluxViewResolutionIntegrationTests.class, "");
6977

@@ -77,21 +85,21 @@ void freemarkerWithInvalidConfig() {
7785
@Test
7886
void freemarkerWithDefaults() throws Exception {
7987
MockServerHttpResponse response = runTest(FreeMarkerWebFluxConfig.class);
80-
StepVerifier.create(response.getBodyAsString()).expectNext(EXPECTED_BODY).expectComplete().verify();
88+
StepVerifier.create(response.getBodyAsString()).expectNext(EXPECTED_BODY.formatted("UTF-8")).expectComplete().verify();
8189
assertThat(response.getHeaders().getContentType()).isEqualTo(TEXT_HTML_UTF8);
8290
}
8391

8492
@Test
8593
void freemarkerWithExplicitDefaultEncoding() throws Exception {
8694
MockServerHttpResponse response = runTest(ExplicitDefaultEncodingConfig.class);
87-
StepVerifier.create(response.getBodyAsString()).expectNext(EXPECTED_BODY).expectComplete().verify();
95+
StepVerifier.create(response.getBodyAsString()).expectNext(EXPECTED_BODY.formatted("UTF-8")).expectComplete().verify();
8896
assertThat(response.getHeaders().getContentType()).isEqualTo(TEXT_HTML_UTF8);
8997
}
9098

9199
@Test
92100
void freemarkerWithExplicitDefaultEncodingAndContentType() throws Exception {
93101
MockServerHttpResponse response = runTest(ExplicitDefaultEncodingAndContentTypeConfig.class);
94-
StepVerifier.create(response.getBodyAsString()).expectNext(EXPECTED_BODY).expectComplete().verify();
102+
StepVerifier.create(response.getBodyAsString()).expectNext(EXPECTED_BODY.formatted("ISO-8859-1")).expectComplete().verify();
95103
// When the Content-Type (supported media type) is explicitly set on the view resolver, it should be used.
96104
assertThat(response.getHeaders().getContentType()).isEqualTo(TEXT_HTML_ISO_8859_1);
97105
}

‎spring-webflux/src/test/resources/org/springframework/web/reactive/config/index_ISO-8859-1.ftl

+6-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
<html><body>${hello}, Java Café</body></html>
1+
<html>
2+
<body>
3+
<h1>${hello}, Java Café</h1>
4+
<p>output_encoding: ${.output_encoding}</p>
5+
</body>
6+
</html>

‎spring-webflux/src/test/resources/org/springframework/web/reactive/config/index_UTF-8.ftl

+6-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
<html><body>${hello}, Java Café</body></html>
1+
<html>
2+
<body>
3+
<h1>${hello}, Java Café</h1>
4+
<p>output_encoding: ${.output_encoding}</p>
5+
</body>
6+
</html>

‎spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerView.java

+11-3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import java.util.Locale;
2323
import java.util.Map;
2424

25+
import freemarker.core.Environment;
2526
import freemarker.core.ParseException;
2627
import freemarker.template.Configuration;
2728
import freemarker.template.DefaultObjectWrapperBuilder;
@@ -364,19 +365,26 @@ protected Template getTemplate(String name, Locale locale) throws IOException {
364365
}
365366

366367
/**
367-
* Process the FreeMarker template to the servlet response.
368+
* Process the FreeMarker template and write the result to the response.
369+
* <p>As of Spring Framework 6.2, this method sets the
370+
* {@linkplain Environment#setOutputEncoding(String) output encoding} of the
371+
* FreeMarker {@link Environment} to the character encoding of the supplied
372+
* {@link HttpServletResponse}.
368373
* <p>Can be overridden to customize the behavior.
369374
* @param template the template to process
370375
* @param model the model for the template
371376
* @param response servlet response (use this to get the OutputStream or Writer)
372377
* @throws IOException if the template file could not be retrieved
373378
* @throws TemplateException if thrown by FreeMarker
374-
* @see freemarker.template.Template#process(Object, java.io.Writer)
379+
* @see freemarker.template.Template#createProcessingEnvironment(Object, java.io.Writer)
380+
* @see freemarker.core.Environment#process()
375381
*/
376382
protected void processTemplate(Template template, SimpleHash model, HttpServletResponse response)
377383
throws IOException, TemplateException {
378384

379-
template.process(model, response.getWriter());
385+
Environment env = template.createProcessingEnvironment(model, response.getWriter());
386+
env.setOutputEncoding(response.getCharacterEncoding());
387+
env.process();
380388
}
381389

382390

‎spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/ViewResolutionIntegrationTests.java

+26-16
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@
4848
*/
4949
class ViewResolutionIntegrationTests {
5050

51-
private static final String EXPECTED_BODY = "<html><body>Hello, Java Café</body></html>";
52-
53-
5451
@BeforeAll
5552
static void verifyDefaultFileEncoding() {
5653
assertThat(System.getProperty("file.encoding")).as("JVM default file encoding").isEqualTo("UTF-8");
@@ -60,6 +57,15 @@ static void verifyDefaultFileEncoding() {
6057
@Nested
6158
class FreeMarkerTests {
6259

60+
private static final String EXPECTED_BODY = """
61+
<html>
62+
<body>
63+
<h1>Hello, Java Café</h1>
64+
<p>output_encoding: %s</p>
65+
</body>
66+
</html>
67+
""";
68+
6369
@Test
6470
void freemarkerWithInvalidConfig() {
6571
assertThatRuntimeException()
@@ -69,45 +75,49 @@ void freemarkerWithInvalidConfig() {
6975

7076
@Test
7177
void freemarkerWithDefaults() throws Exception {
78+
String encoding = "ISO-8859-1";
7279
MockHttpServletResponse response = runTest(FreeMarkerWebConfig.class);
7380
assertThat(response.isCharset()).as("character encoding set in response").isTrue();
74-
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY);
81+
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY.formatted(encoding));
7582
// Prior to Spring Framework 6.2, the charset is not updated in the Content-Type.
7683
// Thus, we expect ISO-8859-1 instead of UTF-8.
77-
assertThat(response.getCharacterEncoding()).isEqualTo("ISO-8859-1");
78-
assertThat(response.getContentType()).isEqualTo("text/html;charset=ISO-8859-1");
84+
assertThat(response.getCharacterEncoding()).isEqualTo(encoding);
85+
assertThat(response.getContentType()).isEqualTo("text/html;charset=" + encoding);
7986
}
8087

8188
@Test // gh-16629, gh-33071
8289
void freemarkerWithExistingViewResolver() throws Exception {
90+
String encoding = "ISO-8859-1";
8391
MockHttpServletResponse response = runTest(ExistingViewResolverConfig.class);
8492
assertThat(response.isCharset()).as("character encoding set in response").isTrue();
85-
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY);
93+
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY.formatted(encoding));
8694
// Prior to Spring Framework 6.2, the charset is not updated in the Content-Type.
8795
// Thus, we expect ISO-8859-1 instead of UTF-8.
88-
assertThat(response.getCharacterEncoding()).isEqualTo("ISO-8859-1");
89-
assertThat(response.getContentType()).isEqualTo("text/html;charset=ISO-8859-1");
96+
assertThat(response.getCharacterEncoding()).isEqualTo(encoding);
97+
assertThat(response.getContentType()).isEqualTo("text/html;charset=" + encoding);
9098
}
9199

92100
@Test // gh-33071
93101
void freemarkerWithExplicitDefaultEncoding() throws Exception {
102+
String encoding = "ISO-8859-1";
94103
MockHttpServletResponse response = runTest(ExplicitDefaultEncodingConfig.class);
95104
assertThat(response.isCharset()).as("character encoding set in response").isTrue();
96-
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY);
105+
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY.formatted(encoding));
97106
// Prior to Spring Framework 6.2, the charset is not updated in the Content-Type.
98107
// Thus, we expect ISO-8859-1 instead of UTF-8.
99-
assertThat(response.getCharacterEncoding()).isEqualTo("ISO-8859-1");
100-
assertThat(response.getContentType()).isEqualTo("text/html;charset=ISO-8859-1");
108+
assertThat(response.getCharacterEncoding()).isEqualTo(encoding);
109+
assertThat(response.getContentType()).isEqualTo("text/html;charset=" + encoding);
101110
}
102111

103112
@Test // gh-33071
104113
void freemarkerWithExplicitDefaultEncodingAndContentType() throws Exception {
114+
String encoding = "UTF-16";
105115
MockHttpServletResponse response = runTest(ExplicitDefaultEncodingAndContentTypeConfig.class);
106116
assertThat(response.isCharset()).as("character encoding set in response").isTrue();
107-
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY);
117+
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY.formatted(encoding));
108118
// When the Content-Type is explicitly set on the view resolver, it should be used.
109-
assertThat(response.getCharacterEncoding()).isEqualTo("UTF-16");
110-
assertThat(response.getContentType()).isEqualTo("text/html;charset=UTF-16");
119+
assertThat(response.getCharacterEncoding()).isEqualTo(encoding);
120+
assertThat(response.getContentType()).isEqualTo("text/html;charset=" + encoding);
111121
}
112122

113123

@@ -202,7 +212,7 @@ void groovyMarkupInvalidConfig() {
202212
@Test
203213
void groovyMarkup() throws Exception {
204214
MockHttpServletResponse response = runTest(GroovyMarkupWebConfig.class);
205-
assertThat(response.getContentAsString()).isEqualTo(EXPECTED_BODY);
215+
assertThat(response.getContentAsString()).isEqualTo("<html><body>Hello, Java Café</body></html>");
206216
}
207217

208218

‎spring-webmvc/src/test/resources/org/springframework/web/servlet/config/annotation/WEB-INF/index.ftl

+6-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
<html><body>${hello}, Java Café</body></html>
1+
<html>
2+
<body>
3+
<h1>${hello}, Java Café</h1>
4+
<p>output_encoding: ${.output_encoding}</p>
5+
</body>
6+
</html>

0 commit comments

Comments
 (0)
Please sign in to comment.