diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerAdapter.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerAdapter.java index e610cd4b15d..56e396e7fc0 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerAdapter.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerAdapter.java @@ -507,41 +507,30 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator Set allowedMethods = new LinkedHashSet(7); String resolvedMethodName = null; for (Method handlerMethod : getHandlerMethods()) { - RequestMappingInfo mappingInfo = new RequestMappingInfo(); - RequestMapping mapping = AnnotationUtils.findAnnotation(handlerMethod, RequestMapping.class); - mappingInfo.paths = mapping.value(); - if (!hasTypeLevelMapping() || !Arrays.equals(mapping.method(), getTypeLevelMapping().method())) { - mappingInfo.methods = mapping.method(); - } - if (!hasTypeLevelMapping() || !Arrays.equals(mapping.params(), getTypeLevelMapping().params())) { - mappingInfo.params = mapping.params(); - } - if (!hasTypeLevelMapping() || !Arrays.equals(mapping.headers(), getTypeLevelMapping().headers())) { - mappingInfo.headers = mapping.headers(); - } + RequestMappingInfo mappingInfo = createRequestMappingInfo(handlerMethod); boolean match = false; - if (mappingInfo.paths.length > 0) { - List matchedPaths = new ArrayList(mappingInfo.paths.length); - for (String mappedPattern : mappingInfo.paths) { - if (!hasTypeLevelMapping() && !mappedPattern.startsWith("/")) { - mappedPattern = "/" + mappedPattern; + if (mappingInfo.hasPatterns()) { + List matchingPatterns = new ArrayList(mappingInfo.patterns.length); + for (String pattern : mappingInfo.patterns) { + if (!hasTypeLevelMapping() && !pattern.startsWith("/")) { + pattern = "/" + pattern; } - String matchedPattern = getMatchedPattern(mappedPattern, lookupPath, request); - if (matchedPattern != null) { + String combinedPattern = getCombinedPattern(pattern, lookupPath, request); + if (combinedPattern != null) { if (mappingInfo.matches(request)) { match = true; - matchedPaths.add(matchedPattern); + matchingPatterns.add(combinedPattern); } else { - for (RequestMethod requestMethod : mappingInfo.methods) { - allowedMethods.add(requestMethod.toString()); + if (!mappingInfo.matchesRequestMethod(request)) { + allowedMethods.addAll(mappingInfo.methodNames()); } break; } } } - Collections.sort(matchedPaths, pathComparator); - mappingInfo.matchedPaths = matchedPaths; + Collections.sort(matchingPatterns, pathComparator); + mappingInfo.matchedPatterns = matchingPatterns; } else { // No paths specified: parameter match sufficient. @@ -551,15 +540,15 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator match = false; } else { - for (RequestMethod requestMethod : mappingInfo.methods) { - allowedMethods.add(requestMethod.toString()); + if (!mappingInfo.matchesRequestMethod(request)) { + allowedMethods.addAll(mappingInfo.methodNames()); } } } if (match) { Method oldMappedMethod = targetHandlerMethods.put(mappingInfo, handlerMethod); if (oldMappedMethod != null && oldMappedMethod != handlerMethod) { - if (methodNameResolver != null && mappingInfo.paths.length == 0) { + if (methodNameResolver != null && mappingInfo.patterns.length == 0) { if (!oldMappedMethod.getName().equals(handlerMethod.getName())) { if (resolvedMethodName == null) { resolvedMethodName = methodNameResolver.getHandlerMethodName(request); @@ -594,7 +583,7 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator new RequestMappingInfoComparator(pathComparator, request); Collections.sort(matches, requestMappingInfoComparator); RequestMappingInfo bestMappingMatch = matches.get(0); - String bestMatchedPath = bestMappingMatch.bestMatchedPath(); + String bestMatchedPath = bestMappingMatch.bestMatchedPattern(); if (bestMatchedPath != null) { extractHandlerMethodUriTemplates(bestMatchedPath, lookupPath, request); } @@ -605,21 +594,38 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator throw new HttpRequestMethodNotSupportedException(request.getMethod(), StringUtils.toStringArray(allowedMethods)); } - else { - throw new NoSuchRequestHandlingMethodException(lookupPath, request.getMethod(), - request.getParameterMap()); - } + throw new NoSuchRequestHandlingMethodException(lookupPath, request.getMethod(), + request.getParameterMap()); } } + private RequestMappingInfo createRequestMappingInfo(Method handlerMethod) { + RequestMappingInfo mappingInfo = new RequestMappingInfo(); + RequestMapping mapping = AnnotationUtils.findAnnotation(handlerMethod, RequestMapping.class); + mappingInfo.patterns = mapping.value(); + if (!hasTypeLevelMapping() || !Arrays.equals(mapping.method(), getTypeLevelMapping().method())) { + mappingInfo.methods = mapping.method(); + } + if (!hasTypeLevelMapping() || !Arrays.equals(mapping.params(), getTypeLevelMapping().params())) { + mappingInfo.params = mapping.params(); + } + if (!hasTypeLevelMapping() || !Arrays.equals(mapping.headers(), getTypeLevelMapping().headers())) { + mappingInfo.headers = mapping.headers(); + } + return mappingInfo; + } + /** - * Determines the matched pattern for the given methodLevelPattern and path. - *

Uses the following algorithm:

  1. If there is a type-level mapping with path information, it is {@linkplain - * PathMatcher#combine(String, String) combined} with the method-level pattern.
  2. If there is a {@linkplain - * HandlerMapping#BEST_MATCHING_PATTERN_ATTRIBUTE best matching pattern} in the request, it is combined with the - * method-level pattern.
  3. Otherwise, + * Determines the combined pattern for the given methodLevelPattern and path. + *

    Uses the following algorithm:

      + *
    1. If there is a type-level mapping with path information, it is {@linkplain + * PathMatcher#combine(String, String) combined} with the method-level pattern.
      2. + *
    2. If there is a {@linkplain HandlerMapping#BEST_MATCHING_PATTERN_ATTRIBUTE best matching pattern} in the + * request, it is combined with the method-level pattern.
      3. + *
    3. Otherwise, the method-level pattern is returned.
      4. + *
    */ - private String getMatchedPattern(String methodLevelPattern, String lookupPath, HttpServletRequest request) { + private String getCombinedPattern(String methodLevelPattern, String lookupPath, HttpServletRequest request) { if (hasTypeLevelMapping() && (!ObjectUtils.isEmpty(getTypeLevelMapping().value()))) { String[] typeLevelPatterns = getTypeLevelMapping().value(); for (String typeLevelPattern : typeLevelPatterns) { @@ -978,9 +984,9 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator */ static class RequestMappingInfo { - String[] paths = new String[0]; + String[] patterns = new String[0]; - List matchedPaths = Collections.emptyList(); + List matchedPatterns = Collections.emptyList(); RequestMethod[] methods = new RequestMethod[0]; @@ -988,28 +994,69 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator String[] headers = new String[0]; - public String bestMatchedPath() { - return (!this.matchedPaths.isEmpty() ? this.matchedPaths.get(0) : null); + public boolean hasPatterns() { + return patterns.length > 0; + } + + public String bestMatchedPattern() { + return (!this.matchedPatterns.isEmpty() ? this.matchedPatterns.get(0) : null); } public boolean matches(HttpServletRequest request) { - return ServletAnnotationMappingUtils.checkRequestMethod(this.methods, request) && - ServletAnnotationMappingUtils.checkParameters(this.params, request) && - ServletAnnotationMappingUtils.checkHeaders(this.headers, request); + return matchesRequestMethod(request) && matchesParameters(request) && matchesHeaders(request); + } + + public boolean matchesHeaders(HttpServletRequest request) { + return ServletAnnotationMappingUtils.checkHeaders(this.headers, request); + } + + public boolean matchesParameters(HttpServletRequest request) { + return ServletAnnotationMappingUtils.checkParameters(this.params, request); + } + + public boolean matchesRequestMethod(HttpServletRequest request) { + return ServletAnnotationMappingUtils.checkRequestMethod(this.methods, request); + } + + public Set methodNames() { + Set methodNames = new LinkedHashSet(methods.length); + for (RequestMethod method : methods) { + methodNames.add(method.name()); + } + return methodNames; } @Override public boolean equals(Object obj) { RequestMappingInfo other = (RequestMappingInfo) obj; - return (Arrays.equals(this.paths, other.paths) && Arrays.equals(this.methods, other.methods) && + return (Arrays.equals(this.patterns, other.patterns) && Arrays.equals(this.methods, other.methods) && Arrays.equals(this.params, other.params) && Arrays.equals(this.headers, other.headers)); } @Override public int hashCode() { - return (Arrays.hashCode(this.paths) * 23 + Arrays.hashCode(this.methods) * 29 + + return (Arrays.hashCode(this.patterns) * 23 + Arrays.hashCode(this.methods) * 29 + Arrays.hashCode(this.params) * 31 + Arrays.hashCode(this.headers)); } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append(Arrays.asList(patterns)); + if (methods.length > 0) { + builder.append(','); + builder.append(Arrays.asList(methods)); + } + if (headers.length > 0) { + builder.append(','); + builder.append(Arrays.asList(headers)); + } + if (params.length > 0) { + builder.append(','); + builder.append(Arrays.asList(params)); + } + return builder.toString(); + } } @@ -1017,7 +1064,7 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator * Comparator capable of sorting {@link RequestMappingInfo}s (RHIs) so that sorting a list with this comparator will * result in: *
      - *
    • RHIs with {@linkplain RequestMappingInfo#matchedPaths better matched paths} take prescedence + *
    • RHIs with {@linkplain RequestMappingInfo#matchedPatterns better matched paths} take prescedence * over those with a weaker match (as expressed by the {@linkplain PathMatcher#getPatternComparator(String) path * pattern comparator}.) Typically, this means that patterns without wild cards and uri templates will be ordered * before those without.
      • @@ -1039,7 +1086,7 @@ public class AnnotationMethodHandlerAdapter extends WebContentGenerator } public int compare(RequestMappingInfo info1, RequestMappingInfo info2) { - int pathComparison = pathComparator.compare(info1.bestMatchedPath(), info2.bestMatchedPath()); + int pathComparison = pathComparator.compare(info1.bestMatchedPattern(), info2.bestMatchedPattern()); if (pathComparison != 0) { return pathComparison; } diff --git a/org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/ServletAnnotationControllerTests.java b/org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/ServletAnnotationControllerTests.java index e3a902eef2b..1eb75f530bb 100644 --- a/org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/ServletAnnotationControllerTests.java +++ b/org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/ServletAnnotationControllerTests.java @@ -1071,7 +1071,7 @@ public class ServletAnnotationControllerTests { @Test public void requestBodyResponseBody() throws ServletException, IOException { - initServlet(RequestBodyController.class); + initServlet(RequestResponseBodyController.class); MockHttpServletRequest request = new MockHttpServletRequest("PUT", "/something"); String requestBody = "Hello World"; @@ -1090,7 +1090,7 @@ public class ServletAnnotationControllerTests { @Override protected WebApplicationContext createWebApplicationContext(WebApplicationContext parent) { GenericWebApplicationContext wac = new GenericWebApplicationContext(); - wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestBodyController.class)); + wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestResponseBodyController.class)); RootBeanDefinition converterDef = new RootBeanDefinition(StringHttpMessageConverter.class); converterDef.getPropertyValues().add("supportedMediaTypes", new MediaType("text", "plain")); RootBeanDefinition adapterDef = new RootBeanDefinition(AnnotationMethodHandlerAdapter.class); @@ -1116,7 +1116,7 @@ public class ServletAnnotationControllerTests { @Test public void responseBodyWildCardMediaType() throws ServletException, IOException { - initServlet(RequestBodyController.class); + initServlet(RequestResponseBodyController.class); MockHttpServletRequest request = new MockHttpServletRequest("PUT", "/something"); String requestBody = "Hello World"; @@ -1134,7 +1134,7 @@ public class ServletAnnotationControllerTests { @Override protected WebApplicationContext createWebApplicationContext(WebApplicationContext parent) { GenericWebApplicationContext wac = new GenericWebApplicationContext(); - wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestBodyController.class)); + wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestResponseBodyController.class)); RootBeanDefinition adapterDef = new RootBeanDefinition(AnnotationMethodHandlerAdapter.class); adapterDef.getPropertyValues().add("messageConverters", new ByteArrayHttpMessageConverter()); wac.registerBeanDefinition("handlerAdapter", adapterDef); @@ -1150,14 +1150,13 @@ public class ServletAnnotationControllerTests { request.addHeader("Content-Type", "application/pdf"); MockHttpServletResponse response = new MockHttpServletResponse(); servlet.service(request, response); - assertEquals("Invalid response status code", HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, - response.getStatus()); + assertEquals(415, response.getStatus()); assertNotNull("No Accept response header set", response.getHeader("Accept")); } @Test public void responseBodyNoAcceptHeader() throws ServletException, IOException { - initServlet(RequestBodyController.class); + initServlet(RequestResponseBodyController.class); MockHttpServletRequest request = new MockHttpServletRequest("PUT", "/something"); String requestBody = "Hello World"; @@ -1175,7 +1174,7 @@ public class ServletAnnotationControllerTests { @Override protected WebApplicationContext createWebApplicationContext(WebApplicationContext parent) { GenericWebApplicationContext wac = new GenericWebApplicationContext(); - wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestBodyController.class)); + wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestResponseBodyController.class)); RootBeanDefinition adapterDef = new RootBeanDefinition(AnnotationMethodHandlerAdapter.class); adapterDef.getPropertyValues().add("messageConverters", new NotReadableMessageConverter()); wac.registerBeanDefinition("handlerAdapter", adapterDef); @@ -1226,7 +1225,7 @@ public class ServletAnnotationControllerTests { @Override protected WebApplicationContext createWebApplicationContext(WebApplicationContext parent) { GenericWebApplicationContext wac = new GenericWebApplicationContext(); - wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestBodyController.class)); + wac.registerBeanDefinition("controller", new RootBeanDefinition(RequestResponseBodyController.class)); RootBeanDefinition adapterDef = new RootBeanDefinition(AnnotationMethodHandlerAdapter.class); List messageConverters = new ArrayList(); messageConverters.add(new StringHttpMessageConverter()); @@ -1314,6 +1313,12 @@ public class ServletAnnotationControllerTests { response = new MockHttpServletResponse(); servlet.service(request, response); assertEquals("text", response.getContentAsString()); + + request = new MockHttpServletRequest("POST", "/something"); + request.addHeader("Content-Type", "application/xml"); + response = new MockHttpServletResponse(); + servlet.service(request, response); + assertEquals(404, response.getStatus()); } @Test @@ -2340,7 +2345,7 @@ public class ServletAnnotationControllerTests { } @Controller - public static class RequestBodyController { + public static class RequestResponseBodyController { @RequestMapping(value = "/something", method = RequestMethod.PUT) @ResponseBody