SPR-7353 - Added equivalent of JAX-RS @produces to Spring MVC

Author: poutsma

org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerMapping.java

@@ -25,7 +25,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-
 import javax.servlet.http.HttpServletRequest;
 
 import org.springframework.core.annotation.AnnotationUtils;
@@ -141,7 +140,9 @@ private static RequestMappingInfo createFromRequestMapping(RequestMapping annota
 						RequestConditionFactory.parseMethods(annotation.method()),
 						RequestConditionFactory.parseParams(annotation.params()),
 						RequestConditionFactory.parseHeaders(annotation.headers()),
-						RequestConditionFactory.parseConsumes(annotation.consumes(), annotation.headers()));
+						RequestConditionFactory.parseConsumes(annotation.consumes(), annotation.headers()),
+						RequestConditionFactory.parseProduces(annotation.produces(), annotation.headers())
+				);
 	}
 
 	@Override
@@ -257,13 +258,10 @@ public int compare(RequestMappingInfo mapping, RequestMappingInfo otherMapping)
 			if (result != 0) {
 				return result;
 			}
-/*
-			TODO: fix
-			result = compareAcceptHeaders(mapping.getAcceptHeaderMediaTypes(), otherMapping.getAcceptHeaderMediaTypes());
+			result = mapping.getProduces().compareTo(otherMapping.getProduces(), this.requestAcceptHeader);
 			if (result != 0) {
 				return result;
 			}
-*/
 			result = mapping.getMethods().compareTo(otherMapping.getMethods());
 			if (result != 0) {
 				return result;

org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingInfo.java

@@ -30,6 +30,7 @@
 import org.springframework.web.servlet.mvc.method.condition.ConsumesRequestCondition;
 import org.springframework.web.servlet.mvc.method.condition.HeadersRequestCondition;
 import org.springframework.web.servlet.mvc.method.condition.ParamsRequestCondition;
+import org.springframework.web.servlet.mvc.method.condition.ProducesRequestCondition;
 import org.springframework.web.servlet.mvc.method.condition.RequestConditionFactory;
 import org.springframework.web.servlet.mvc.method.condition.RequestMethodsRequestCondition;
 
@@ -57,6 +58,8 @@ public final class RequestMappingInfo {
 
 	private final ConsumesRequestCondition consumesCondition;
 
+	private final ProducesRequestCondition producesCondition;
+
 	private int hash;
 
 	/**
@@ -65,7 +68,7 @@ public final class RequestMappingInfo {
 	 * <p>Package protected for testing purposes.
 	 */
 	RequestMappingInfo(Collection<String> patterns, RequestMethod[] methods) {
-		this(patterns, RequestConditionFactory.parseMethods(methods), null, null, null);
+		this(patterns, RequestConditionFactory.parseMethods(methods), null, null, null, null);
 	}
 
 	/**
@@ -75,12 +78,14 @@ public RequestMappingInfo(Collection<String> patterns,
 							 RequestMethodsRequestCondition methodsCondition,
 							 ParamsRequestCondition paramsCondition,
 							 HeadersRequestCondition headersCondition,
-							 ConsumesRequestCondition consumesCondition) {
+							 ConsumesRequestCondition consumesCondition,
+							 ProducesRequestCondition producesCondition) {
 		this.patterns = asUnmodifiableSet(prependLeadingSlash(patterns));
 		this.methodsCondition = methodsCondition != null ? methodsCondition : new RequestMethodsRequestCondition();
 		this.paramsCondition = paramsCondition != null ? paramsCondition : new ParamsRequestCondition();
 		this.headersCondition = headersCondition != null ? headersCondition : new HeadersRequestCondition();
 		this.consumesCondition = consumesCondition != null ? consumesCondition : new ConsumesRequestCondition();
+		this.producesCondition = producesCondition != null ? producesCondition : new ProducesRequestCondition();
 	}
 
 	private static Set<String> prependLeadingSlash(Collection<String> patterns) {
@@ -106,40 +111,47 @@ private static <T> Set<T> asUnmodifiableSet(Collection<T> collection) {
 	}
 
 	/**
-	 * Returns the patterns of this request key.
+	 * Returns the patterns of this request mapping info.
 	 */
 	public Set<String> getPatterns() {
 		return patterns;
 	}
 
 	/**
-	 * Returns the request method conditions of this request key.
+	 * Returns the request method conditions of this request mapping info.
 	 */
 	public RequestMethodsRequestCondition getMethods() {
 		return methodsCondition;
 	}
 
 	/**
-	 * Returns the request parameters conditions of this request key.
+	 * Returns the request parameters conditions of this request mapping info.
 	 */
 	public ParamsRequestCondition getParams() {
 		return paramsCondition;
 	}
 
 	/**
-	 * Returns the request headers conditions of this request key.
+	 * Returns the request headers conditions of this request mapping info.
 	 */
 	public HeadersRequestCondition getHeaders() {
 		return headersCondition;
 	}
 
 	/**
-	 * Returns the request consumes conditions of this request key.
+	 * Returns the request consumes conditions of this request mapping info.
 	 */
 	public ConsumesRequestCondition getConsumes() {
 		return consumesCondition;
 	}
 
+	/**
+	 * Returns the request produces conditions of this request mapping info.
+	 */
+	public ProducesRequestCondition getProduces() {
+		return producesCondition;
+	}
+
 	/**
 	 * Combines this {@code RequestMappingInfo} with another as follows:
 	 * <ul>
@@ -156,16 +168,17 @@ public ConsumesRequestCondition getConsumes() {
 	 * </ul>
 	 * @param methodKey the key to combine with
 	 * @param pathMatcher to {@linkplain PathMatcher#combine(String, String) combine} the patterns
-	 * @return a new request key containing conditions from both keys
+	 * @return a new request mapping info containing conditions from both keys
 	 */
 	public RequestMappingInfo combine(RequestMappingInfo methodKey, PathMatcher pathMatcher) {
 		Set<String> patterns = combinePatterns(this.patterns, methodKey.patterns, pathMatcher);
 		RequestMethodsRequestCondition methods = this.methodsCondition.combine(methodKey.methodsCondition);
 		ParamsRequestCondition params = this.paramsCondition.combine(methodKey.paramsCondition);
 		HeadersRequestCondition headers = this.headersCondition.combine(methodKey.headersCondition);
 		ConsumesRequestCondition consumes = this.consumesCondition.combine(methodKey.consumesCondition);
+		ProducesRequestCondition produces = this.producesCondition.combine(methodKey.producesCondition);
 
-		return new RequestMappingInfo(patterns, methods, params, headers, consumes);
+		return new RequestMappingInfo(patterns, methods, params, headers, consumes, produces);
 	}
 
 	private static Set<String> combinePatterns(Collection<String> typePatterns,
@@ -203,23 +216,24 @@ else if (!methodPatterns.isEmpty()) {
 	 * @param lookupPath mapping lookup path within the current servlet mapping if applicable
 	 * @param request the current request
 	 * @param pathMatcher to check for matching patterns
-	 * @return a new request key that contains all matching attributes, or {@code null} if not all conditions match
+	 * @return a new request mapping info that contains all matching attributes, or {@code null} if not all conditions match
 	 */
 	public RequestMappingInfo getMatchingRequestMapping(String lookupPath, HttpServletRequest request, PathMatcher pathMatcher) {
 		RequestMethodsRequestCondition matchingMethodCondition = methodsCondition.getMatchingCondition(request);
 		ParamsRequestCondition matchingParamsCondition = paramsCondition.getMatchingCondition(request);
 		HeadersRequestCondition matchingHeadersCondition = headersCondition.getMatchingCondition(request);
 		ConsumesRequestCondition matchingConsumesCondition = consumesCondition.getMatchingCondition(request);
+		ProducesRequestCondition matchingProducesCondition = producesCondition.getMatchingCondition(request);
 
 		if (matchingMethodCondition == null || matchingParamsCondition == null || matchingHeadersCondition == null ||
-				matchingConsumesCondition == null) {
+				matchingConsumesCondition == null || matchingProducesCondition == null)  {
 			return null;
 		}
 		else {
 			List<String> matchingPatterns = getMatchingPatterns(lookupPath, pathMatcher);
 			if (!matchingPatterns.isEmpty()) {
 				return new RequestMappingInfo(matchingPatterns, matchingMethodCondition, matchingParamsCondition,
-						matchingHeadersCondition, matchingConsumesCondition);
+						matchingHeadersCondition, matchingConsumesCondition, matchingProducesCondition);
 			}
 			else {
 				return null;
@@ -271,7 +285,8 @@ public boolean equals(Object obj) {
 					this.methodsCondition.equals(other.methodsCondition) &&
 					this.paramsCondition.equals(other.paramsCondition) &&
 					this.headersCondition.equals(other.headersCondition) &&
-					this.consumesCondition.equals(other.consumesCondition));
+					this.consumesCondition.equals(other.consumesCondition) &&
+					this.producesCondition.equals(other.producesCondition));
 		}
 		return false;
 	}
@@ -285,6 +300,7 @@ public int hashCode() {
 			result = 31 * result + paramsCondition.hashCode();
 			result = 31 * result + headersCondition.hashCode();
 			result = 31 * result + consumesCondition.hashCode();
+			result = 31 * result + producesCondition.hashCode();
 			hash = result;
 		}
 		return result;
@@ -298,6 +314,7 @@ public String toString() {
 		builder.append(",params=").append(paramsCondition);
 		builder.append(",headers=").append(headersCondition);
 		builder.append(",consumes=").append(consumesCondition);
+		builder.append(",produces=").append(producesCondition);
 		builder.append('}');
 		return builder.toString();
 	}

org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/method/condition/ConsumesRequestCondition.java

@@ -16,7 +16,6 @@
 
 package org.springframework.web.servlet.mvc.method.condition;
 
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
@@ -27,33 +26,23 @@
 import javax.servlet.http.HttpServletRequest;
 
 import org.springframework.http.MediaType;
-import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 /**
- * Represents a collection of consumes conditions, typically obtained from {@link
- * org.springframework.web.bind.annotation.RequestMapping#consumes() @RequestMapping.consumes()}.
+ * Represents a collection of consumes conditions, typically obtained from {@link org.springframework.web.bind.annotation.RequestMapping#consumes()
+ * @RequestMapping.consumes()}.
  *
  * @author Arjen Poutsma
- * @see RequestConditionFactory#parseHeaders(String...)
+ * @see RequestConditionFactory#parseConsumes(String...)
+ * @see RequestConditionFactory#parseConsumes(String[], String[])
  * @since 3.1
  */
 public class ConsumesRequestCondition
-		extends LogicalDisjunctionRequestCondition<ConsumesRequestCondition.ConsumeRequestCondition>
+		extends MediaTypesRequestCondition<ConsumesRequestCondition.ConsumeRequestCondition>
 		implements Comparable<ConsumesRequestCondition> {
 
-	private final ConsumeRequestCondition mostSpecificCondition;
-
 	ConsumesRequestCondition(Collection<ConsumeRequestCondition> conditions) {
 		super(conditions);
-		Assert.notEmpty(conditions, "'conditions' must not be empty");
-		mostSpecificCondition = getMostSpecificCondition();
-	}
-
-	private ConsumeRequestCondition getMostSpecificCondition() {
-		List<ConsumeRequestCondition> conditions = new ArrayList<ConsumeRequestCondition>(getConditions());
-		Collections.sort(conditions);
-		return conditions.get(0);
 	}
 
 	ConsumesRequestCondition(String... consumes) {
@@ -72,7 +61,7 @@ private static Set<ConsumeRequestCondition> parseConditions(List<String> consume
 	}
 
 	/**
-	 * Creates an default set of consumes request conditions.
+	 * Creates a default set of consumes request conditions.
 	 */
 	public ConsumesRequestCondition() {
 		this(Collections.singleton(new ConsumeRequestCondition(MediaType.ALL, false)));
@@ -101,8 +90,8 @@ public ConsumesRequestCondition getMatchingCondition(HttpServletRequest request)
 	}
 
 	/**
-	 * Combines this collection of request condition with another. Returns {@code other}, unless it has the default
-	 * value (i.e. <code>&#42;/&#42;</code>).
+	 * Combines this collection of request condition with another. Returns {@code other}, unless it has the default value
+	 * (i.e. <code>&#42;/&#42;</code>).
 	 *
 	 * @param other the condition to combine with
 	 */
@@ -122,79 +111,32 @@ private boolean hasDefaultValue() {
 	}
 
 	public int compareTo(ConsumesRequestCondition other) {
-		return this.mostSpecificCondition.compareTo(other.mostSpecificCondition);
-	}
-
-	private static MediaType getContentType(HttpServletRequest request) {
-		if (StringUtils.hasLength(request.getContentType())) {
-			return MediaType.parseMediaType(request.getContentType());
-		}
-		else {
-			return MediaType.APPLICATION_OCTET_STREAM;
-		}
+		return this.getMostSpecificCondition().compareTo(other.getMostSpecificCondition());
 	}
 
-	static class ConsumeRequestCondition implements RequestCondition, Comparable<ConsumeRequestCondition> {
-
-		private final MediaType mediaType;
-
-		private final boolean isNegated;
+	static class ConsumeRequestCondition extends MediaTypesRequestCondition.MediaTypeRequestCondition {
 
 		ConsumeRequestCondition(String expression) {
-			if (expression.startsWith("!")) {
-				isNegated = true;
-				expression = expression.substring(1);
-			}
-			else {
-				isNegated = false;
-			}
-			this.mediaType = MediaType.parseMediaType(expression);
+			super(expression);
 		}
 
-		ConsumeRequestCondition(MediaType mediaType, boolean isNegated) {
-			this.mediaType = mediaType;
-			this.isNegated = isNegated;
+		ConsumeRequestCondition(MediaType mediaType, boolean negated) {
+			super(mediaType, negated);
 		}
 
-		public boolean match(HttpServletRequest request) {
+		@Override
+		protected boolean match(HttpServletRequest request, MediaType mediaType) {
 			MediaType contentType = getContentType(request);
-			boolean match = this.mediaType.includes(contentType);
-			return !isNegated ? match : !match;
+			return mediaType.includes(contentType);
 		}
 
-		public int compareTo(ConsumeRequestCondition other) {
-			return MediaType.SPECIFICITY_COMPARATOR.compare(this.mediaType, other.mediaType);
-		}
-
-		MediaType getMediaType() {
-			return mediaType;
-		}
-
-		@Override
-		public boolean equals(Object obj) {
-			if (this == obj) {
-				return true;
-			}
-			if (obj != null && obj instanceof ConsumeRequestCondition) {
-				ConsumeRequestCondition other = (ConsumeRequestCondition) obj;
-				return (this.mediaType.equals(other.mediaType)) && (this.isNegated == other.isNegated);
+		private MediaType getContentType(HttpServletRequest request) {
+			if (StringUtils.hasLength(request.getContentType())) {
+				return MediaType.parseMediaType(request.getContentType());
 			}
-			return false;
-		}
-
-		@Override
-		public int hashCode() {
-			return mediaType.hashCode();
-		}
-
-		@Override
-		public String toString() {
-			StringBuilder builder = new StringBuilder();
-			if (isNegated) {
-				builder.append('!');
+			else {
+				return MediaType.APPLICATION_OCTET_STREAM;
 			}
-			builder.append(mediaType.toString());
-			return builder.toString();
 		}
 
 	}