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

Consistent ScriptTemplateView locale resolution via request 

Issue: SPR-15064
This commit is contained in:
Juergen Hoeller 2017-06-26 23:28:49 +02:00
parent 41eaf03bc8
commit 98642c7e29
8 changed files with 24 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/RenderingContext.java
View File

@ -40,6 +40,7 @@ public class RenderingContext {
public RenderingContext(ApplicationContext applicationContext, Locale locale,
Function<String, String> templateLoader, String url) {
this.applicationContext = applicationContext;
this.locale = locale;
this.templateLoader = templateLoader;
@ -48,19 +49,19 @@ public class RenderingContext {
public ApplicationContext getApplicationContext() {
return applicationContext;
return this.applicationContext;
}
public Locale getLocale() {
return locale;
return this.locale;
}
public Function<String, String> getTemplateLoader() {
return templateLoader;
return this.templateLoader;
}
public String getUrl() {
return url;
return this.url;
}
}

15
spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/ScriptTemplateView.java
View File

@ -35,6 +35,7 @@ import org.springframework.beans.factory.BeanFactoryUtils;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextException;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.io.buffer.DataBuffer;
@ -58,7 +59,7 @@ import org.springframework.web.server.ServerWebExchange;
* {@link ScriptTemplateConfig} bean in the web application context and using
* it to obtain the configured properties.
*
* <p>Nashorn Javascript engine requires Java 8+, and may require setting the
* <p>The Nashorn JavaScript engine requires Java 8+ and may require setting the
* {@code sharedEngine} property to {@code false} in order to run properly. See
* {@link ScriptTemplateConfigurer#setSharedEngine(Boolean)} for more details.
*
@ -77,8 +78,6 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
private String engineName;
private Locale locale;
private Boolean sharedEngine;
private String[] scripts;
@ -123,13 +122,6 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
this.engineName = engineName;
}
/**
* Set the {@link Locale} to pass to the render function.
*/
public void setLocale(Locale locale) {
this.locale = locale;
}
/**
* See {@link ScriptTemplateConfigurer#setSharedEngine(Boolean)} documentation.
*/
@ -312,8 +304,9 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
}
};
Locale locale = LocaleContextHolder.getLocale(exchange.getLocaleContext());
RenderingContext context = new RenderingContext(
obtainApplicationContext(), this.locale, templateLoader, url);
obtainApplicationContext(), locale, templateLoader, url);
Object html;
if (this.renderFunction == null) {

14
spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/ScriptTemplateViewResolver.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2017 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.
@ -16,12 +16,7 @@
package org.springframework.web.reactive.result.view.script;
import java.util.Locale;
import reactor.core.publisher.Mono;
import org.springframework.web.reactive.result.view.UrlBasedViewResolver;
import org.springframework.web.reactive.result.view.View;
/**
* Convenience subclass of {@link UrlBasedViewResolver} that supports
@ -60,13 +55,6 @@ public class ScriptTemplateViewResolver extends UrlBasedViewResolver {
setSuffix(suffix);
}
@Override
public Mono<View> resolveViewName(String viewName, Locale locale) {
return super.resolveViewName(viewName, locale).map(view -> {
((ScriptTemplateView)view).setLocale(locale);
return view;
});
}
@Override
protected Class<?> requiredViewClass() {

3
spring-webflux/src/test/java/org/springframework/web/reactive/result/view/script/KotlinScriptTemplateTests.java
View File

@ -78,8 +78,7 @@ public class KotlinScriptTemplateTests {
private MockServerHttpResponse renderViewWithModel(String viewUrl, Map<String, Object> model, Locale locale, Class<?> configuration) throws Exception {
ScriptTemplateView view = createViewWithUrl(viewUrl, configuration);
view.setLocale(locale);
MockServerWebExchange exchange = MockServerHttpRequest.get("/").toExchange();
MockServerWebExchange exchange = MockServerHttpRequest.get("/").acceptLanguageAsLocales(locale).toExchange();
view.renderInternal(model, MediaType.TEXT_HTML, exchange).block();
return exchange.getResponse();
}

9
spring-webmvc/src/main/java/org/springframework/web/servlet/view/script/RenderingContext.java
View File

@ -40,6 +40,7 @@ public class RenderingContext {
public RenderingContext(ApplicationContext applicationContext, Locale locale,
Function<String, String> templateLoader, String url) {
this.applicationContext = applicationContext;
this.locale = locale;
this.templateLoader = templateLoader;
@ -48,19 +49,19 @@ public class RenderingContext {
public ApplicationContext getApplicationContext() {
return applicationContext;
return this.applicationContext;
}
public Locale getLocale() {
return locale;
return this.locale;
}
public Function<String, String> getTemplateLoader() {
return templateLoader;
return this.templateLoader;
}
public String getUrl() {
return url;
return this.url;
}
}

18
spring-webmvc/src/main/java/org/springframework/web/servlet/view/script/ScriptTemplateView.java
View File

@ -49,6 +49,7 @@ import org.springframework.util.Assert;
import org.springframework.util.FileCopyUtils;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.support.RequestContextUtils;
import org.springframework.web.servlet.view.AbstractUrlBasedView;
/**
@ -59,7 +60,7 @@ import org.springframework.web.servlet.view.AbstractUrlBasedView;
* {@link ScriptTemplateConfig} bean in the web application context and using
* it to obtain the configured properties.
*
* <p>Nashorn Javascript engine requires Java 8+, and may require setting the
* <p>The Nashorn JavaScript engine requires Java 8+ and may require setting the
* {@code sharedEngine} property to {@code false} in order to run properly. See
* {@link ScriptTemplateConfigurer#setSharedEngine(Boolean)} for more details.
*
@ -86,8 +87,6 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
private String engineName;
private Locale locale;
private Boolean sharedEngine;
private String[] scripts;
@ -130,14 +129,6 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
this.engine = engine;
}
/**
* Set the {@link Locale} to pass to the render function.
* @since 5.0
*/
public void setLocale(Locale locale) {
this.locale = locale;
}
/**
* See {@link ScriptTemplateConfigurer#setEngineName(String)} documentation.
*/
@ -362,6 +353,7 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
String url = getUrl();
Assert.state(url != null, "'url' not set");
String template = getTemplate(url);
Function<String, String> templateLoader = path -> {
try {
return getTemplate(path);
@ -370,7 +362,9 @@ public class ScriptTemplateView extends AbstractUrlBasedView {
throw new IllegalStateException(ex);
}
};
RenderingContext context = new RenderingContext(obtainApplicationContext(), this.locale, templateLoader, url);
Locale locale = RequestContextUtils.getLocale(request);
RenderingContext context = new RenderingContext(obtainApplicationContext(), locale, templateLoader, url);
Object html;
if (this.renderFunction == null) {

13
spring-webmvc/src/main/java/org/springframework/web/servlet/view/script/ScriptTemplateViewResolver.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2017 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.
@ -16,9 +16,6 @@
package org.springframework.web.servlet.view.script;
import java.util.Locale;
import org.springframework.web.servlet.View;
import org.springframework.web.servlet.view.UrlBasedViewResolver;
/**
@ -59,14 +56,6 @@ public class ScriptTemplateViewResolver extends UrlBasedViewResolver {
setSuffix(suffix);
}
@Override
public View resolveViewName(String viewName, Locale locale) throws Exception {
ScriptTemplateView view = (ScriptTemplateView)super.resolveViewName(viewName, locale);
if (view != null) {
view.setLocale(locale);
}
return view;
}
@Override
protected Class<?> requiredViewClass() {

2
spring-webmvc/src/test/java/org/springframework/web/servlet/view/script/KotlinScriptTemplateTests.java
View File

@ -94,9 +94,9 @@ public class KotlinScriptTemplateTests {
private MockHttpServletResponse renderViewWithModel(String viewUrl, Map<String, Object> model, Locale locale, Class<?> configuration) throws Exception {
ScriptTemplateView view = createViewWithUrl(viewUrl, configuration);
view.setLocale(locale);
MockHttpServletResponse response = new MockHttpServletResponse();
MockHttpServletRequest request = new MockHttpServletRequest();
request.addPreferredLocale(locale);
view.renderMergedOutputModel(model, request, response);
return response;
}