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-8448 Use URI template vars rather than path vars in RedirectView

This commit is contained in:
Rossen Stoyanchev 2011-08-02 08:27:26 +00:00
parent 98ad8633bd
commit 3fb753bc0c
2 changed files with 39 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/RedirectView.java
View File

@ -22,7 +22,6 @@ import java.lang.reflect.Array;
import java.net.URI; import java.net.URI;
import java.net.URISyntaxException; import java.net.URISyntaxException;
import java.net.URLEncoder; import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
@ -38,6 +37,8 @@ import javax.servlet.http.HttpServletResponse;
import org.springframework.beans.BeanUtils; import org.springframework.beans.BeanUtils;
import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatus;
import org.springframework.util.ObjectUtils; import org.springframework.util.ObjectUtils;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.View; import org.springframework.web.servlet.View;
import org.springframework.web.util.UriTemplate; import org.springframework.web.util.UriTemplate;
import org.springframework.web.util.UriUtils; import org.springframework.web.util.UriUtils;
@ -47,8 +48,8 @@ import org.springframework.web.util.WebUtils;
* <p>View that redirects to an absolute, context relative, or current request * <p>View that redirects to an absolute, context relative, or current request
* relative URL. The URL may be a URI template in which case the URI template * relative URL. The URL may be a URI template in which case the URI template
* variables will be replaced with values available in the model. By default * variables will be replaced with values available in the model. By default
* all primitive model attributes (or collections thereof), not used to fill * all primitive model attributes (or collections thereof), not used as URI
* in URI tempate variables, are exposed as HTTP query parameters, but this * template variables, are exposed as HTTP query parameters, but this
* behavior can be changed by overriding the * behavior can be changed by overriding the
* {@link #isEligibleProperty(String, Object)} method. * {@link #isEligibleProperty(String, Object)} method.
* *
@ -99,6 +100,7 @@ public class RedirectView extends AbstractUrlBasedView {
* Constructor for use as a bean. * Constructor for use as a bean.
*/ */
public RedirectView() { public RedirectView() {
setExposePathVariables(false);
} }
/** /**
@ -110,6 +112,7 @@ public class RedirectView extends AbstractUrlBasedView {
*/ */
public RedirectView(String url) { public RedirectView(String url) {
super(url); super(url);
setExposePathVariables(false);
} }
/** /**
@ -121,6 +124,7 @@ public class RedirectView extends AbstractUrlBasedView {
public RedirectView(String url, boolean contextRelative) { public RedirectView(String url, boolean contextRelative) {
super(url); super(url);
this.contextRelative = contextRelative; this.contextRelative = contextRelative;
setExposePathVariables(false);
} }
/** /**
@ -134,6 +138,7 @@ public class RedirectView extends AbstractUrlBasedView {
super(url); super(url);
this.contextRelative = contextRelative; this.contextRelative = contextRelative;
this.http10Compatible = http10Compatible; this.http10Compatible = http10Compatible;
setExposePathVariables(false);
} }
/** /**
@ -150,6 +155,7 @@ public class RedirectView extends AbstractUrlBasedView {
this.contextRelative = contextRelative; this.contextRelative = contextRelative;
this.http10Compatible = http10Compatible; this.http10Compatible = http10Compatible;
this.exposeModelAttributes = exposeModelAttributes; this.exposeModelAttributes = exposeModelAttributes;
setExposePathVariables(false);
} }
@ -245,23 +251,32 @@ public class RedirectView extends AbstractUrlBasedView {
enc = WebUtils.DEFAULT_CHARACTER_ENCODING; enc = WebUtils.DEFAULT_CHARACTER_ENCODING;
} }
UriTemplate redirectUri = createUriTemplate(targetUrl, enc); UriTemplate uriTemplate = createUriTemplate(targetUrl, enc);
if (redirectUri.getVariableNames().size() > 0) { if (uriTemplate.getVariableNames().size() > 0) {
targetUrl = new StringBuilder(redirectUri.expand(model).toString()); Map<String, Object> vars = new HashMap<String, Object>();
model = removeKeys(model, redirectUri.getVariableNames()); vars.putAll(getCurrentUriVars(request));
vars.putAll(model);
targetUrl = new StringBuilder(uriTemplate.expand(vars).toString());
model = removeKeys(model, uriTemplate.getVariableNames());
} }
if (this.exposeModelAttributes) { if (this.exposeModelAttributes) {
List<String> pathVarNames = getPathVarNames(request);
if (!pathVarNames.isEmpty()) {
model = removeKeys(model, pathVarNames);
}
appendQueryProperties(targetUrl, model, enc); appendQueryProperties(targetUrl, model, enc);
} }
return targetUrl.toString(); return targetUrl.toString();
} }
/**
* Returns the URI template variables extracted from the current request.
*/
@SuppressWarnings("unchecked")
private Map<String, String> getCurrentUriVars(HttpServletRequest request) {
String name = HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE;
Map<String, String> map = (Map<String, String>) request.getAttribute(name);
return (map != null) ? map : new HashMap<String, String>();
}
@SuppressWarnings("serial") @SuppressWarnings("serial")
private UriTemplate createUriTemplate(StringBuilder targetUrl, final String encoding) { private UriTemplate createUriTemplate(StringBuilder targetUrl, final String encoding) {
return new UriTemplate(targetUrl.toString()) { return new UriTemplate(targetUrl.toString()) {
@ -287,15 +302,6 @@ public class RedirectView extends AbstractUrlBasedView {
return result; return result;
} }
/**
* Returns the names of PathVariable for the current request; or an empty list.
*/
@SuppressWarnings("unchecked")
private List<String> getPathVarNames(HttpServletRequest request) {
Map<String, Object> map = (Map<String, Object>) request.getAttribute(View.PATH_VARIABLES);
return (map != null) ? new ArrayList<String>(map.keySet()) : Collections.<String>emptyList();
}
/** /**
* Append query properties to the redirect URL. * Append query properties to the redirect URL.
* Stringifies, URL-encodes and formats model attributes as query properties. * Stringifies, URL-encodes and formats model attributes as query properties.

24
org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/view/RedirectViewUriTemplateTests.java
View File

@ -25,7 +25,7 @@ import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.springframework.mock.web.MockHttpServletRequest; import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse; import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.web.servlet.View; import org.springframework.web.servlet.HandlerMapping;
public class RedirectViewUriTemplateTests { public class RedirectViewUriTemplateTests {
@ -75,21 +75,23 @@ public class RedirectViewUriTemplateTests {
} }
@Test @Test
public void doNotAppendUriTemplateVarFromCurrentRequest() throws Exception { public void currentRequestUriTemplateVars() throws Exception {
Map<String, Object> model = new HashMap<String, Object>(); Map<String, Object> model = new HashMap<String, Object>();
model.put("name1", "value1"); model.put("key1", "value1");
model.put("name2", "value2"); model.put("name", "value2");
model.put("name3", "value3"); model.put("key3", "value3");
Map<String, String> uriTemplatVars = new HashMap<String, String>(); Map<String, String> vars = new HashMap<String, String>();
uriTemplatVars.put("name1", "value1"); vars.put("var1", "v1");
uriTemplatVars.put("name2", "value2"); vars.put("name", "v2");
request.setAttribute(View.PATH_VARIABLES, uriTemplatVars); vars.put("var3", "v3");
request.setAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE, vars);
String url = "http://url.somewhere.com"; String url = "http://url.somewhere.com";
RedirectView redirectView = new RedirectView(url + "/{name2}"); RedirectView redirectView = new RedirectView(url + "/{key1}/{var1}/{name}");
redirectView.renderMergedOutputModel(model, request, response); redirectView.renderMergedOutputModel(model, request, response);
assertEquals(url + "/value2?name3=value3", response.getRedirectedUrl()); assertEquals(url + "/value1/v1/value2?key3=value3", response.getRedirectedUrl());
} }
} }