Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added @RequestHeader support

Browse Source
This commit is contained in:
Juergen Hoeller
2008-12-05 07:17:31 +00:00
parent b3866a974a
commit 0ed916495c
9 changed files with 281 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
org.springframework.web.servlet/src/main/java/org/springframework/web/bind/annotation/RequestHeader.java Normal file
View File

@@ -0,0 +1,61 @@
/*
* Copyright 2002-2008 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.bind.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation which indicates that a method parameter should be bound to a web request header.
* Supported for {@link RequestMapping} annotated handler methods in Servlet and Portlet environments.
*
* @author Juergen Hoeller
* @since 3.0
* @see RequestMapping
* @see org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter
* @see org.springframework.web.portlet.mvc.annotation.AnnotationMethodHandlerAdapter
*/
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestHeader {
/**
* The name of the request header to bind to.
*/
String value() default "";
/**
* Whether the header is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* of the header missing in the request. Switch this to <code>false</code>
* if you prefer a <code>null</value> in case of the header missing.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitely sets this flag to <code>false</code>.
*/
boolean required() default true;
/**
* The default value to use as a fallback. Supplying a default value implicitely
* sets {@link #required()} to false.
*/
String defaultValue() default "";
}

27
org.springframework.web.servlet/src/main/java/org/springframework/web/bind/annotation/RequestParam.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2007 the original author or authors.
* Copyright 2002-2008 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.
@@ -23,33 +23,40 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation which indicates that a method parameter should be bound to a web request parameter. Supported for {@link
* RequestMapping} annotated handler methods in Servlet and Portlet environments.
* Annotation which indicates that a method parameter should be bound to a web request parameter.
* Supported for {@link RequestMapping} annotated handler methods in Servlet and Portlet environments.
*
* @author Arjen Poutsma
* @author Juergen Hoeller
* @since 2.5
* @see RequestMapping
* @see org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter
* @see org.springframework.web.portlet.mvc.annotation.AnnotationMethodHandlerAdapter
* @since 2.5
*/
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
/** The request parameter to bind to. */
/**
* The name of the request parameter to bind to.
*/
String value() default "";
/**
* Whether the parameter is required. <p>Default is <code>true</code>, leading to an exception thrown in case of the
* parameter missing in the request. Switch this to <code>false</code> if you prefer a <code>null</value> in case of
* the parameter missing. <p>Alternatively, provide a {@link #defaultValue() defaultValue}, which implicitely sets this
* flag to <code>false</code>.
* Whether the parameter is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* of the parameter missing in the request. Switch this to <code>false</code>
* if you prefer a <code>null</value> in case of the parameter missing.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitely sets this flag to <code>false</code>.
*/
boolean required() default true;
/** The default value to use as a fallback. Supplying a default value implicitely sets {@link #required()} to false. */
/**
* The default value to use as a fallback. Supplying a default value implicitely
* sets {@link #required()} to false.
*/
String defaultValue() default "";
}

108
org.springframework.web.servlet/src/main/java/org/springframework/web/bind/annotation/support/HandlerMethodInvoker.java
View File

@@ -46,6 +46,7 @@ import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.support.DefaultSessionAttributeStore;
import org.springframework.web.bind.support.SessionAttributeStore;
@@ -156,36 +157,47 @@ public class HandlerMethodInvoker {
methodParam.initParameterNameDiscovery(this.parameterNameDiscoverer);
GenericTypeResolver.resolveParameterType(methodParam, handler.getClass());
String paramName = null;
boolean paramRequired = false;
String paramDefaultValue = null;
String headerName = null;
boolean required = false;
String defaultValue = null;
String pathVarName = null;
String attrName = null;
int found = 0;
Annotation[] paramAnns = methodParam.getParameterAnnotations();
for (Annotation paramAnn : paramAnns) {
if (RequestParam.class.isInstance(paramAnn)) {
RequestParam requestParam = (RequestParam) paramAnn;
paramName = requestParam.value();
paramRequired = requestParam.required();
paramDefaultValue = requestParam.defaultValue();
break;
required = requestParam.required();
defaultValue = requestParam.defaultValue();
found++;
}
else if (RequestHeader.class.isInstance(paramAnn)) {
RequestHeader requestHeader = (RequestHeader) paramAnn;
headerName = requestHeader.value();
required = requestHeader.required();
defaultValue = requestHeader.defaultValue();
found++;
}
else if (ModelAttribute.class.isInstance(paramAnn)) {
ModelAttribute attr = (ModelAttribute) paramAnn;
attrName = attr.value();
found++;
}
else if (PathVariable.class.isInstance(paramAnn)) {
PathVariable pathVar = (PathVariable) paramAnn;
pathVarName = pathVar.value();
found++;
}
}
if ((paramName != null && attrName != null) || (paramName != null && pathVarName != null) ||
(pathVarName != null && attrName != null)) {
throw new IllegalStateException("@RequestParam, @PathVariable and @ModelAttribute are exclusive " +
"choices - do not specify both on the same parameter: " + handlerMethod);
if (found > 1) {
throw new IllegalStateException("Handler parameter annotations are exclusive choices - " +
"do not specify more than one such annotation on the same parameter: " + handlerMethod);
}
if (paramName == null && attrName == null && pathVarName == null) {
if (found == 0) {
Object argValue = resolveCommonArgument(methodParam, webRequest);
if (argValue != WebArgumentResolver.UNRESOLVED) {
args[i] = argValue;
@@ -212,8 +224,10 @@ public class HandlerMethodInvoker {
}
if (paramName != null) {
args[i] = resolveRequestParam(paramName, paramRequired, paramDefaultValue, methodParam, webRequest,
handler);
args[i] = resolveRequestParam(paramName, required, defaultValue, methodParam, webRequest, handler);
}
else if (headerName != null) {
args[i] = resolveRequestHeader(headerName, required, defaultValue, methodParam, webRequest, handler);
}
else if (attrName != null) {
WebDataBinder binder = resolveModelAttribute(attrName, methodParam, implicitModel, webRequest, handler);
@@ -333,18 +347,13 @@ public class HandlerMethodInvoker {
return initBinderArgs;
}
private Object resolveRequestParam(String paramName, boolean paramRequired, String paramDefaultValue,
private Object resolveRequestParam(String paramName, boolean required, String defaultValue,
MethodParameter methodParam, NativeWebRequest webRequest, Object handlerForInitBinderCall)
throws Exception {
Class paramType = methodParam.getParameterType();
if (paramName.length() == 0) {
paramName = methodParam.getParameterName();
if (paramName == null) {
throw new IllegalStateException(
"No parameter specified for @RequestParam argument of type [" + paramType.getName() +
"], and no parameter name information found in class file either.");
}
paramName = getRequiredParameterName(methodParam);
}
Object paramValue = null;
if (webRequest.getNativeRequest() instanceof MultipartRequest) {
@@ -357,23 +366,64 @@ public class HandlerMethodInvoker {
}
}
if (paramValue == null) {
if (StringUtils.hasText(paramDefaultValue)) {
paramValue = paramDefaultValue;
if (StringUtils.hasText(defaultValue)) {
paramValue = defaultValue;
}
else if (paramRequired) {
else if (required) {
raiseMissingParameterException(paramName, paramType);
}
if (paramValue == null && paramType.isPrimitive()) {
throw new IllegalStateException("Optional " + paramType + " parameter '" + paramName +
"' is not present but cannot be translated into a null value due to being declared as a " +
"primitive type. Consider declaring it as object wrapper for the corresponding primitive type.");
}
checkValue(paramName, paramValue, paramType);
}
WebDataBinder binder = createBinder(webRequest, null, paramName);
initBinder(handlerForInitBinderCall, paramName, binder, webRequest);
return binder.convertIfNecessary(paramValue, paramType, methodParam);
}
private Object resolveRequestHeader(String headerName, boolean required, String defaultValue,
MethodParameter methodParam, NativeWebRequest webRequest, Object handlerForInitBinderCall)
throws Exception {
Class paramType = methodParam.getParameterType();
if (headerName.length() == 0) {
headerName = getRequiredParameterName(methodParam);
}
Object headerValue = null;
String[] headerValues = webRequest.getHeaderValues(headerName);
if (headerValues != null) {
headerValue = (headerValues.length == 1 ? headerValues[0] : headerValues);
}
if (headerValue == null) {
if (StringUtils.hasText(defaultValue)) {
headerValue = defaultValue;
}
else if (required) {
raiseMissingHeaderException(headerName, paramType);
}
checkValue(headerName, headerValue, paramType);
}
WebDataBinder binder = createBinder(webRequest, null, headerName);
initBinder(handlerForInitBinderCall, headerName, binder, webRequest);
return binder.convertIfNecessary(headerValue, paramType, methodParam);
}
private String getRequiredParameterName(MethodParameter methodParam) {
String name = methodParam.getParameterName();
if (name == null) {
throw new IllegalStateException("No parameter name specified for argument of type [" +
methodParam.getParameterType().getName() +
"], and no parameter name information found in class file either.");
}
return name;
}
private void checkValue(String name, Object value, Class paramType) {
if (value == null && paramType.isPrimitive()) {
throw new IllegalStateException("Optional " + paramType + " parameter '" + name +
"' is not present but cannot be translated into a null value due to being declared as a " +
"primitive type. Consider declaring it as object wrapper for the corresponding primitive type.");
}
}
private WebDataBinder resolveModelAttribute(String attrName, MethodParameter methodParam,
ExtendedModelMap implicitModel, NativeWebRequest webRequest, Object handler)
throws Exception {
@@ -471,6 +521,10 @@ public class HandlerMethodInvoker {
throw new IllegalStateException("Missing parameter '" + paramName + "' of type [" + paramType.getName() + "]");
}
protected void raiseMissingHeaderException(String headerName, Class paramType) throws Exception {
throw new IllegalStateException("Missing header '" + headerName + "' of type [" + paramType.getName() + "]");
}
protected void raiseSessionRequiredException(String message) throws Exception {
throw new IllegalStateException(message);
}

99
org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/ServletAnnotationControllerTests.java
View File

@@ -63,6 +63,7 @@ import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
@@ -142,7 +143,7 @@ public class ServletAnnotationControllerTests {
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/myPath.do");
MockHttpServletResponse response = new MockHttpServletResponse();
servlet.service(request, response);
assertEquals("null", response.getContentAsString());
assertEquals("null-null", response.getContentAsString());
}
@Test
@@ -161,7 +162,7 @@ public class ServletAnnotationControllerTests {
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/myPath.do");
MockHttpServletResponse response = new MockHttpServletResponse();
servlet.service(request, response);
assertEquals("foo", response.getContentAsString());
assertEquals("foo-bar", response.getContentAsString());
}
@Test
@@ -281,9 +282,10 @@ public class ServletAnnotationControllerTests {
request = new MockHttpServletRequest("GET", "/myPath2.do");
request.addParameter("param1", "value1");
request.addParameter("param2", "2");
request.addHeader("header1", "10");
response = new MockHttpServletResponse();
servlet.service(request, response);
assertEquals("test-value1-2", response.getContentAsString());
assertEquals("test-value1-2-10", response.getContentAsString());
request = new MockHttpServletRequest("GET", "/myPath3.do");
request.addParameter("param1", "value1");
@@ -812,6 +814,7 @@ public class ServletAnnotationControllerTests {
}
}
/** @noinspection UnusedDeclaration*/
private static class BaseController {
@@ -821,6 +824,7 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
private static class MyAdaptedController {
@@ -830,10 +834,9 @@ public class ServletAnnotationControllerTests {
}
@RequestMapping("/myPath2.do")
public void myHandle(@RequestParam("param1")String p1,
@RequestParam("param2")int p2,
HttpServletResponse response) throws IOException {
response.getWriter().write("test-" + p1 + "-" + p2);
public void myHandle(@RequestParam("param1") String p1, @RequestParam("param2") int p2,
@RequestHeader("header1") long h1, HttpServletResponse response) throws IOException {
response.getWriter().write("test-" + p1 + "-" + p2 + "-" + h1);
}
@RequestMapping("/myPath3")
@@ -847,6 +850,7 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
@RequestMapping("/*.do")
private static class MyAdaptedController2 {
@@ -857,9 +861,9 @@ public class ServletAnnotationControllerTests {
}
@RequestMapping("/myPath2.do")
public void myHandle(@RequestParam("param1")String p1, int param2, HttpServletResponse response)
throws IOException {
response.getWriter().write("test-" + p1 + "-" + param2);
public void myHandle(@RequestParam("param1") String p1, int param2, HttpServletResponse response,
@RequestHeader("header1") String h1) throws IOException {
response.getWriter().write("test-" + p1 + "-" + param2 + "-" + h1);
}
@RequestMapping("/myPath3")
@@ -873,23 +877,26 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
private static class MyAdaptedControllerBase<T> {
@RequestMapping("/myPath2.do")
public void myHandle(@RequestParam("param1")T p1, int param2, HttpServletResponse response) throws IOException {
response.getWriter().write("test-" + p1 + "-" + param2);
public void myHandle(@RequestParam("param1") T p1, int param2, @RequestHeader Integer header1,
HttpServletResponse response) throws IOException {
response.getWriter().write("test-" + p1 + "-" + param2 + "-" + header1);
}
@InitBinder
public void initBinder(@RequestParam("param1")T p1, int param2) {
public void initBinder(@RequestParam("param1") T p1, int param2) {
}
@ModelAttribute
public void modelAttribute(@RequestParam("param1")T p1, int param2) {
public void modelAttribute(@RequestParam("param1") T p1, int param2) {
}
}
@RequestMapping("/*.do")
private static class MyAdaptedController3 extends MyAdaptedControllerBase<String> {
@@ -899,9 +906,9 @@ public class ServletAnnotationControllerTests {
}
@Override
public void myHandle(@RequestParam("param1")String p1, int param2, HttpServletResponse response)
throws IOException {
response.getWriter().write("test-" + p1 + "-" + param2);
public void myHandle(@RequestParam("param1") String p1, int param2, @RequestHeader Integer header1,
HttpServletResponse response) throws IOException {
response.getWriter().write("test-" + p1 + "-" + param2 + "-" + header1);
}
@RequestMapping("/myPath3")
@@ -916,15 +923,16 @@ public class ServletAnnotationControllerTests {
@Override
@InitBinder
public void initBinder(@RequestParam("param1")String p1, int param2) {
public void initBinder(@RequestParam("param1") String p1, int param2) {
}
@Override
@ModelAttribute
public void modelAttribute(@RequestParam("param1")String p1, int param2) {
public void modelAttribute(@RequestParam("param1") String p1, int param2) {
}
}
@Controller
@RequestMapping(method = RequestMethod.GET)
private static class EmptyParameterListHandlerMethodController {
@@ -941,6 +949,7 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
public static class MyFormController {
@@ -961,6 +970,7 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
public static class MyModelFormController {
@@ -981,14 +991,14 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
private static class MyCommandProvidingFormController<T, TB, TB2> extends MyFormController {
@SuppressWarnings("unused")
@ModelAttribute("myCommand")
private TestBean createTestBean(@RequestParam T defaultName,
Map<String, Object> model,
@RequestParam Date date) {
private TestBean createTestBean(@RequestParam T defaultName, Map<String, Object> model,
@RequestParam Date date) {
model.put("myKey", "myOriginalValue");
return new TestBean(defaultName.getClass().getSimpleName() + ":" + defaultName.toString());
}
@@ -1020,18 +1030,21 @@ public class ServletAnnotationControllerTests {
}
}
private static class MySpecialArg {
public MySpecialArg(String value) {
}
}
@Controller
private static class MyTypedCommandProvidingFormController
extends MyCommandProvidingFormController<Integer, TestBean, ITestBean> {
}
@Controller
private static class MyBinderInitializingCommandProvidingFormController extends MyCommandProvidingFormController {
@@ -1045,13 +1058,14 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
private static class MySpecificBinderInitializingCommandProvidingFormController
extends MyCommandProvidingFormController {
@SuppressWarnings("unused")
@InitBinder({"myCommand", "date"})
private void initBinder(WebDataBinder binder, String date, @RequestParam("date")String[] date2) {
private void initBinder(WebDataBinder binder, String date, @RequestParam("date") String[] date2) {
assertEquals("2007-10-02", date);
assertEquals(1, date2.length);
assertEquals("2007-10-02", date2[0]);
@@ -1061,6 +1075,7 @@ public class ServletAnnotationControllerTests {
}
}
private static class MyWebBindingInitializer implements WebBindingInitializer {
public void initBinder(WebDataBinder binder, WebRequest request) {
@@ -1071,6 +1086,7 @@ public class ServletAnnotationControllerTests {
}
}
private static class MySpecialArgumentResolver implements WebArgumentResolver {
public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) {
@@ -1081,6 +1097,7 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
@RequestMapping("/myPath.do")
private static class MyParameterDispatchingController {
@@ -1126,12 +1143,14 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
@RequestMapping(value = "/*.do", method = RequestMethod.POST, params = "myParam=myValue")
private static class MyPostMethodNameDispatchingController extends MethodNameDispatchingController {
}
@Controller
@RequestMapping("/myApp/*")
private static class MyRelativePathDispatchingController {
@@ -1157,6 +1176,7 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
private static class MyNullCommandController {
@@ -1171,11 +1191,8 @@ public class ServletAnnotationControllerTests {
}
@RequestMapping("/myPath")
public void handle(@ModelAttribute TestBean testBean,
Errors errors,
@ModelAttribute TestPrincipal modelPrinc,
OtherPrincipal requestPrinc,
Writer writer) throws IOException {
public void handle(@ModelAttribute TestBean testBean, Errors errors, @ModelAttribute TestPrincipal modelPrinc,
OtherPrincipal requestPrinc, Writer writer) throws IOException {
assertNull(testBean);
assertNotNull(modelPrinc);
assertNotNull(requestPrinc);
@@ -1185,6 +1202,7 @@ public class ServletAnnotationControllerTests {
}
}
private static class TestPrincipal implements Principal {
public String getName() {
@@ -1192,6 +1210,7 @@ public class ServletAnnotationControllerTests {
}
}
private static class OtherPrincipal implements Principal {
public String getName() {
@@ -1199,6 +1218,7 @@ public class ServletAnnotationControllerTests {
}
}
private static class TestViewResolver implements ViewResolver {
public View resolveViewName(final String viewName, Locale locale) throws Exception {
@@ -1242,6 +1262,7 @@ public class ServletAnnotationControllerTests {
}
}
public static class ParentController {
@RequestMapping(method = RequestMethod.GET)
@@ -1249,44 +1270,51 @@ public class ServletAnnotationControllerTests {
}
}
@Controller
@RequestMapping("/child/test")
public static class ChildController extends ParentController {
@RequestMapping(method = RequestMethod.GET)
public void doGet(HttpServletRequest req, HttpServletResponse resp, @RequestParam("childId")String id) {
public void doGet(HttpServletRequest req, HttpServletResponse resp, @RequestParam("childId") String id) {
}
}
@Controller
public static class RequiredParamController {
@RequestMapping("/myPath.do")
public void myHandle(@RequestParam(value = "id", required = true)String id) {
public void myHandle(@RequestParam(value = "id", required = true) String id,
@RequestHeader(value = "header", required = true) String header) {
}
}
@Controller
public static class OptionalParamController {
@RequestMapping("/myPath.do")
public void myHandle(@RequestParam(value = "id", required = false)String id, HttpServletResponse response)
public void myHandle(@RequestParam(required = false) String id,
@RequestHeader(value = "header", required = false) String header, HttpServletResponse response)
throws IOException {
response.getWriter().write(String.valueOf(id));
response.getWriter().write(String.valueOf(id) + "-" + String.valueOf(header));
}
}
@Controller
public static class DefaultValueParamController {
@RequestMapping("/myPath.do")
public void myHandle(@RequestParam(value = "id", defaultValue = "foo")String id, HttpServletResponse response)
public void myHandle(@RequestParam(value = "id", defaultValue = "foo") String id,
@RequestHeader(defaultValue = "bar") String header, HttpServletResponse response)
throws IOException {
response.getWriter().write(String.valueOf(id));
response.getWriter().write(String.valueOf(id) + "-" + String.valueOf(header));
}
}
@Controller
public static class MethodNotAllowedController {
@@ -1318,5 +1346,4 @@ public class ServletAnnotationControllerTests {
}
}
}