GitHub-Spring
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Refactor HandlerMapping path match configuration 

Since the introduction of `PathPatternRegistry`, the various path match
configuration flags are no longer needed in several places and that
configuration can live in the registry itself.

Issue: SPR-14544
pull/1294/merge
Brian Clozel 9 years ago
parent
da4af6157e
commit
09d18f2ef5
11 changed files with 163 additions and 294 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 29
      spring-web/src/main/java/org/springframework/web/util/patterns/PathPatternRegistry.java
  2. 57
      spring-web/src/test/java/org/springframework/web/util/patterns/PathPatternRegistryTests.java
  3. 41
      spring-webflux/src/main/java/org/springframework/web/reactive/config/PathMatchConfigurer.java
  4. 19
      spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurationSupport.java
  5. 42
      spring-webflux/src/main/java/org/springframework/web/reactive/result/condition/PatternsRequestCondition.java
  6. 70
      spring-webflux/src/main/java/org/springframework/web/reactive/result/method/RequestMappingInfo.java
  7. 76
      spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/RequestMappingHandlerMapping.java
  8. 24
      spring-webflux/src/test/java/org/springframework/web/reactive/config/WebFluxConfigurationSupportTests.java
  9. 29
      spring-webflux/src/test/java/org/springframework/web/reactive/result/condition/PatternsRequestConditionTests.java
  10. 7
      spring-webflux/src/test/java/org/springframework/web/reactive/result/method/RequestMappingInfoHandlerMappingTests.java
  11. 63
      spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/RequestMappingHandlerMappingTests.java

29
spring-web/src/main/java/org/springframework/web/util/patterns/PathPatternRegistry.java
Unescape View File

@ -111,11 +111,14 @@ public class PathPatternRegistry {
* <p>The default value is an empty {@code Set} * <p>The default value is an empty {@code Set}
*/ */
public void setFileExtensions(Set<String> fileExtensions) { public void setFileExtensions(Set<String> fileExtensions) {
this.fileExtensions = fileExtensions; Set<String> fixedFileExtensions = (fileExtensions != null) ? fileExtensions.stream()
.map(ext -> (ext.charAt(0) != '.') ? "." + ext : ext)
.collect(Collectors.toSet()) : Collections.emptySet();
this.fileExtensions = fixedFileExtensions;
} }
/** /**
* Return a (read-only) set of all patterns, sorted according to their specificity. * Return a (read-only) set of all patterns for matching (including generated pattern variants).
*/ */
public Set<PathPattern> getPatterns() { public Set<PathPattern> getPatterns() {
return Collections.unmodifiableSet(this.patterns); return Collections.unmodifiableSet(this.patterns);
@ -194,28 +197,38 @@ public class PathPatternRegistry {
* @return the list of {@link PathPattern} that were registered as a result * @return the list of {@link PathPattern} that were registered as a result
*/ */
public List<PathPattern> register(String rawPattern) { public List<PathPattern> register(String rawPattern) {
String fixedPattern = prependLeadingSlash(rawPattern);
List<PathPattern> newPatterns = new ArrayList<>(); List<PathPattern> newPatterns = new ArrayList<>();
PathPattern pattern = this.pathPatternParser.parse(rawPattern); PathPattern pattern = this.pathPatternParser.parse(fixedPattern);
newPatterns.add(pattern); newPatterns.add(pattern);
if (StringUtils.hasLength(rawPattern) && !pattern.isCatchAll()) { if (StringUtils.hasLength(fixedPattern) && !pattern.isCatchAll()) {
if (this.useSuffixPatternMatch) { if (this.useSuffixPatternMatch) {
if (this.fileExtensions != null && !this.fileExtensions.isEmpty()) { if (this.fileExtensions != null && !this.fileExtensions.isEmpty()) {
for (String extension : this.fileExtensions) { for (String extension : this.fileExtensions) {
newPatterns.add(this.pathPatternParser.parse(rawPattern + "." + extension)); newPatterns.add(this.pathPatternParser.parse(fixedPattern + extension));
} }
} }
else { else {
newPatterns.add(this.pathPatternParser.parse(rawPattern + ".*")); newPatterns.add(this.pathPatternParser.parse(fixedPattern + ".*"));
} }
} }
if (this.useTrailingSlashMatch && !rawPattern.endsWith("/")) { if (this.useTrailingSlashMatch && !fixedPattern.endsWith("/")) {
newPatterns.add(this.pathPatternParser.parse(rawPattern + "/")); newPatterns.add(this.pathPatternParser.parse(fixedPattern + "/"));
} }
} }
this.patterns.addAll(newPatterns); this.patterns.addAll(newPatterns);
return newPatterns; return newPatterns;
} }
private String prependLeadingSlash(String pattern) {
if (StringUtils.hasLength(pattern) && !pattern.startsWith("/")) {
return "/" + pattern;
}
else {
return pattern;
}
}
/** /**
* Combine the patterns contained in the current registry * Combine the patterns contained in the current registry
* with the ones in the other, into a new {@code PathPatternRegistry} instance. * with the ones in the other, into a new {@code PathPatternRegistry} instance.

57
spring-web/src/test/java/org/springframework/web/util/patterns/PathPatternRegistryTests.java
Unescape View File

@ -28,12 +28,14 @@ import org.junit.Rule;
import org.junit.Test; import org.junit.Test;
import org.junit.rules.ExpectedException; import org.junit.rules.ExpectedException;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize; import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is; import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat; import static org.junit.Assert.assertThat;
/** /**
* Tests for {@link PathPatternRegistry} * Tests for {@link PathPatternRegistry}
*
* @author Brian Clozel * @author Brian Clozel
*/ */
public class PathPatternRegistryTests { public class PathPatternRegistryTests {
@ -48,6 +50,21 @@ public class PathPatternRegistryTests {
this.registry = new PathPatternRegistry(); this.registry = new PathPatternRegistry();
} }
@Test
public void shouldFixFileExtensions() {
Set<String> fileExtensions = new HashSet<>();
fileExtensions.add("json");
fileExtensions.add("xml");
this.registry.setFileExtensions(fileExtensions);
assertThat(this.registry.getFileExtensions(), contains(".json", ".xml"));
}
@Test
public void shouldPrependPatternsWithSlash() {
this.registry.register("foo/bar");
assertThat(getPatternList(this.registry.getPatterns()), Matchers.containsInAnyOrder("/foo/bar"));
}
@Test @Test
public void shouldNotRegisterInvalidPatterns() { public void shouldNotRegisterInvalidPatterns() {
this.thrown.expect(PatternParseException.class); this.thrown.expect(PatternParseException.class);
@ -58,58 +75,59 @@ public class PathPatternRegistryTests {
@Test @Test
public void shouldNotRegisterPatternVariants() { public void shouldNotRegisterPatternVariants() {
List<PathPattern> patterns = this.registry.register("/foo/{bar}"); List<PathPattern> patterns = this.registry.register("/foo/{bar}");
assertPathPatternListContains(patterns, "/foo/{bar}"); assertThat(getPatternList(patterns), Matchers.containsInAnyOrder("/foo/{bar}"));
} }
@Test @Test
public void shouldRegisterTrailingSlashVariants() { public void shouldRegisterTrailingSlashVariants() {
this.registry.setUseTrailingSlashMatch(true); this.registry.setUseTrailingSlashMatch(true);
List<PathPattern> patterns = this.registry.register("/foo/{bar}"); List<PathPattern> patterns = this.registry.register("/foo/{bar}");
assertPathPatternListContains(patterns, "/foo/{bar}", "/foo/{bar}/"); assertThat(getPatternList(patterns), Matchers.containsInAnyOrder("/foo/{bar}", "/foo/{bar}/"));
} }
@Test @Test
public void shouldRegisterSuffixVariants() { public void shouldRegisterSuffixVariants() {
this.registry.setUseSuffixPatternMatch(true); this.registry.setUseSuffixPatternMatch(true);
List<PathPattern> patterns = this.registry.register("/foo/{bar}"); List<PathPattern> patterns = this.registry.register("/foo/{bar}");
assertPathPatternListContains(patterns, "/foo/{bar}", "/foo/{bar}.*"); assertThat(getPatternList(patterns), Matchers.containsInAnyOrder("/foo/{bar}", "/foo/{bar}.*"));
} }
@Test @Test
public void shouldRegisterExtensionsVariants() { public void shouldRegisterExtensionsVariants() {
Set<String> fileExtensions = new HashSet<>(); Set<String> fileExtensions = new HashSet<>();
fileExtensions.add("json"); fileExtensions.add(".json");
fileExtensions.add("xml"); fileExtensions.add(".xml");
this.registry.setUseSuffixPatternMatch(true); this.registry.setUseSuffixPatternMatch(true);
this.registry.setFileExtensions(fileExtensions); this.registry.setFileExtensions(fileExtensions);
List<PathPattern> patterns = this.registry.register("/foo/{bar}"); List<PathPattern> patterns = this.registry.register("/foo/{bar}");
assertPathPatternListContains(patterns, "/foo/{bar}", "/foo/{bar}.xml", "/foo/{bar}.json"); assertThat(getPatternList(patterns),
Matchers.containsInAnyOrder("/foo/{bar}", "/foo/{bar}.xml", "/foo/{bar}.json"));
} }
@Test @Test
public void shouldRegisterAllVariants() { public void shouldRegisterAllVariants() {
Set<String> fileExtensions = new HashSet<>(); Set<String> fileExtensions = new HashSet<>();
fileExtensions.add("json"); fileExtensions.add(".json");
fileExtensions.add("xml"); fileExtensions.add(".xml");
this.registry.setUseSuffixPatternMatch(true); this.registry.setUseSuffixPatternMatch(true);
this.registry.setUseTrailingSlashMatch(true); this.registry.setUseTrailingSlashMatch(true);
this.registry.setFileExtensions(fileExtensions); this.registry.setFileExtensions(fileExtensions);
List<PathPattern> patterns = this.registry.register("/foo/{bar}"); List<PathPattern> patterns = this.registry.register("/foo/{bar}");
assertPathPatternListContains(patterns, "/foo/{bar}", assertThat(getPatternList(patterns), Matchers.containsInAnyOrder("/foo/{bar}",
"/foo/{bar}.xml", "/foo/{bar}.json", "/foo/{bar}/"); "/foo/{bar}.xml", "/foo/{bar}.json", "/foo/{bar}/"));
} }
@Test @Test
public void combineEmptyRegistries() { public void combineEmptyRegistries() {
PathPatternRegistry result = this.registry.combine(new PathPatternRegistry()); PathPatternRegistry result = this.registry.combine(new PathPatternRegistry());
assertPathPatternListContains(result.getPatterns(), ""); assertThat(getPatternList(result.getPatterns()), Matchers.containsInAnyOrder(""));
} }
@Test @Test
public void combineWithEmptyRegistry() { public void combineWithEmptyRegistry() {
this.registry.register("/foo"); this.registry.register("/foo");
PathPatternRegistry result = this.registry.combine(new PathPatternRegistry()); PathPatternRegistry result = this.registry.combine(new PathPatternRegistry());
assertPathPatternListContains(result.getPatterns(), "/foo"); assertThat(getPatternList(result.getPatterns()), Matchers.containsInAnyOrder("/foo"));
} }
@Test @Test
@ -119,7 +137,7 @@ public class PathPatternRegistryTests {
other.register("/bar"); other.register("/bar");
other.register("/baz"); other.register("/baz");
PathPatternRegistry result = this.registry.combine(other); PathPatternRegistry result = this.registry.combine(other);
assertPathPatternListContains(result.getPatterns(), "/foo/bar", "/foo/baz"); assertThat(getPatternList(result.getPatterns()), Matchers.containsInAnyOrder("/foo/bar", "/foo/baz"));
} }
@Test @Test
@ -131,7 +149,7 @@ public class PathPatternRegistryTests {
this.registry.add(fooOne); this.registry.add(fooOne);
this.registry.add(fooTwo); this.registry.add(fooTwo);
Set<PathPattern> matches = this.registry.findMatches("/foo"); Set<PathPattern> matches = this.registry.findMatches("/foo");
assertPathPatternListContains(matches, "/f?o", "/fo?"); assertThat(getPatternList(matches), Matchers.contains("/f?o", "/fo?"));
} }
@Test @Test
@ -146,15 +164,14 @@ public class PathPatternRegistryTests {
this.registry.register("/foo/bar/baz"); this.registry.register("/foo/bar/baz");
this.registry.register("/foo/bar/{baz}"); this.registry.register("/foo/bar/{baz}");
Set<PathPattern> matches = this.registry.findMatches("/foo/bar/baz"); Set<PathPattern> matches = this.registry.findMatches("/foo/bar/baz");
assertPathPatternListContains(matches, "/foo/bar/baz", "/foo/bar/{baz}", assertThat(getPatternList(matches), Matchers.contains("/foo/bar/baz", "/foo/bar/{baz}",
"/foo/{*baz}"); "/foo/{*baz}"));
} }
private void assertPathPatternListContains(Collection<PathPattern> parsedPatterns, String... pathPatterns) { private List<String> getPatternList(Collection<PathPattern> parsedPatterns) {
List<String> patternList = parsedPatterns. return parsedPatterns.stream().map(pattern -> pattern.getPatternString()).collect(Collectors.toList());
stream().map(pattern -> pattern.getPatternString()).collect(Collectors.toList());
assertThat(patternList, Matchers.contains(pathPatterns));
} }
} }

41
spring-webflux/src/main/java/org/springframework/web/reactive/config/PathMatchConfigurer.java
Unescape 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -16,7 +16,6 @@
package org.springframework.web.reactive.config; package org.springframework.web.reactive.config;
import org.springframework.util.PathMatcher;
import org.springframework.web.server.support.HttpRequestPathHelper; import org.springframework.web.server.support.HttpRequestPathHelper;
/** /**
@ -27,24 +26,22 @@ import org.springframework.web.server.support.HttpRequestPathHelper;
*/ */
public class PathMatchConfigurer { public class PathMatchConfigurer {
private Boolean suffixPatternMatch; private boolean suffixPatternMatch = false;
private Boolean trailingSlashMatch; private boolean trailingSlashMatch = true;
private Boolean registeredSuffixPatternMatch; private boolean registeredSuffixPatternMatch = false;
private HttpRequestPathHelper pathHelper; private HttpRequestPathHelper pathHelper;
private PathMatcher pathMatcher;
/** /**
* Whether to use suffix pattern match (".*") when matching patterns to * Whether to use suffix pattern match (".*") when matching patterns to
* requests. If enabled a method mapped to "/users" also matches to "/users.*". * requests. If enabled a method mapped to "/users" also matches to "/users.*".
* <p>By default this is set to {@code true}. * <p>By default this is set to {@code false}.
* @see #registeredSuffixPatternMatch * @see #registeredSuffixPatternMatch
*/ */
public PathMatchConfigurer setUseSuffixPatternMatch(Boolean suffixPatternMatch) { public PathMatchConfigurer setUseSuffixPatternMatch(boolean suffixPatternMatch) {
this.suffixPatternMatch = suffixPatternMatch; this.suffixPatternMatch = suffixPatternMatch;
return this; return this;
} }
@ -54,7 +51,7 @@ public class PathMatchConfigurer {
* If enabled a method mapped to "/users" also matches to "/users/". * If enabled a method mapped to "/users" also matches to "/users/".
* <p>The default value is {@code true}. * <p>The default value is {@code true}.
*/ */
public PathMatchConfigurer setUseTrailingSlashMatch(Boolean trailingSlashMatch) { public PathMatchConfigurer setUseTrailingSlashMatch(boolean trailingSlashMatch) {
this.trailingSlashMatch = trailingSlashMatch; this.trailingSlashMatch = trailingSlashMatch;
return this; return this;
} }
@ -64,9 +61,9 @@ public class PathMatchConfigurer {
* that are explicitly registered. This is generally recommended to reduce * that are explicitly registered. This is generally recommended to reduce
* ambiguity and to avoid issues such as when a "." (dot) appears in the path * ambiguity and to avoid issues such as when a "." (dot) appears in the path
* for other reasons. * for other reasons.
* <p>By default this is set to "true". * <p>By default this is set to "false".
*/ */
public PathMatchConfigurer setUseRegisteredSuffixPatternMatch(Boolean registeredSuffixPatternMatch) { public PathMatchConfigurer setUseRegisteredSuffixPatternMatch(boolean registeredSuffixPatternMatch) {
this.registeredSuffixPatternMatch = registeredSuffixPatternMatch; this.registeredSuffixPatternMatch = registeredSuffixPatternMatch;
return this; return this;
} }
@ -80,24 +77,15 @@ public class PathMatchConfigurer {
return this; return this;
} }
/** protected boolean isUseSuffixPatternMatch() {
* Set the PathMatcher for matching URL paths against registered URL patterns.
* <p>Default is {@link org.springframework.util.AntPathMatcher AntPathMatcher}.
*/
public PathMatchConfigurer setPathMatcher(PathMatcher pathMatcher) {
this.pathMatcher = pathMatcher;
return this;
}
protected Boolean isUseSuffixPatternMatch() {
return this.suffixPatternMatch; return this.suffixPatternMatch;
} }
protected Boolean isUseTrailingSlashMatch() { protected boolean isUseTrailingSlashMatch() {
return this.trailingSlashMatch; return this.trailingSlashMatch;
} }
protected Boolean isUseRegisteredSuffixPatternMatch() { protected boolean isUseRegisteredSuffixPatternMatch() {
return this.registeredSuffixPatternMatch; return this.registeredSuffixPatternMatch;
} }
@ -105,9 +93,4 @@ public class PathMatchConfigurer {
return this.pathHelper; return this.pathHelper;
} }
//TODO: remove
protected PathMatcher getPathMatcher() {
return this.pathMatcher;
}
} }

19
spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurationSupport.java
Unescape View File

@ -81,6 +81,7 @@ import org.springframework.web.reactive.result.view.ViewResolver;
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebExceptionHandler; import org.springframework.web.server.WebExceptionHandler;
import org.springframework.web.server.handler.ResponseStatusExceptionHandler; import org.springframework.web.server.handler.ResponseStatusExceptionHandler;
import org.springframework.web.util.patterns.PathPatternRegistry;
/** /**
* The main class for Spring Web Reactive configuration. * The main class for Spring Web Reactive configuration.
@ -136,25 +137,23 @@ public class WebFluxConfigurationSupport implements ApplicationContextAware {
@Bean @Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping() { public RequestMappingHandlerMapping requestMappingHandlerMapping() {
CompositeContentTypeResolver contentTypeResolver = webFluxContentTypeResolver();
RequestMappingHandlerMapping mapping = createRequestMappingHandlerMapping(); RequestMappingHandlerMapping mapping = createRequestMappingHandlerMapping();
mapping.setOrder(0); mapping.setOrder(0);
mapping.setContentTypeResolver(webFluxContentTypeResolver()); mapping.setContentTypeResolver(contentTypeResolver);
mapping.setCorsConfigurations(getCorsConfigurations()); mapping.setCorsConfigurations(getCorsConfigurations());
PathPatternRegistry pathPatternRegistry = new PathPatternRegistry();
mapping.setPatternRegistry(pathPatternRegistry);
PathMatchConfigurer configurer = getPathMatchConfigurer(); PathMatchConfigurer configurer = getPathMatchConfigurer();
if (configurer.isUseSuffixPatternMatch() != null) { pathPatternRegistry.setUseSuffixPatternMatch(configurer.isUseSuffixPatternMatch());
mapping.setUseSuffixPatternMatch(configurer.isUseSuffixPatternMatch()); pathPatternRegistry.setUseTrailingSlashMatch(configurer.isUseTrailingSlashMatch());
} if (configurer.isUseRegisteredSuffixPatternMatch() && contentTypeResolver != null) {
if (configurer.isUseRegisteredSuffixPatternMatch() != null) { pathPatternRegistry.setFileExtensions(contentTypeResolver.getKeys());
mapping.setUseRegisteredSuffixPatternMatch(configurer.isUseRegisteredSuffixPatternMatch());
}
if (configurer.isUseTrailingSlashMatch() != null) {
mapping.setUseTrailingSlashMatch(configurer.isUseTrailingSlashMatch());
} }
if (configurer.getPathHelper() != null) { if (configurer.getPathHelper() != null) {
mapping.setPathHelper(configurer.getPathHelper()); mapping.setPathHelper(configurer.getPathHelper());
} }
return mapping; return mapping;
} }

42
spring-webflux/src/main/java/org/springframework/web/reactive/result/condition/PatternsRequestCondition.java
Unescape View File

@ -18,15 +18,11 @@ package org.springframework.web.reactive.result.condition;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections;
import java.util.Comparator; import java.util.Comparator;
import java.util.Set; import java.util.Set;
import java.util.SortedSet; import java.util.SortedSet;
import java.util.function.Function;
import java.util.stream.Collectors;
import org.springframework.util.PathMatcher; import org.springframework.util.PathMatcher;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.support.HttpRequestPathHelper; import org.springframework.web.server.support.HttpRequestPathHelper;
import org.springframework.web.util.patterns.PathPattern; import org.springframework.web.util.patterns.PathPattern;
@ -37,6 +33,7 @@ import org.springframework.web.util.patterns.PathPatternRegistry;
* against a set of URL path patterns. * against a set of URL path patterns.
* *
* @author Rossen Stoyanchev * @author Rossen Stoyanchev
* @author Brian Clozel
* @since 5.0 * @since 5.0
*/ */
public final class PatternsRequestCondition extends AbstractRequestCondition<PatternsRequestCondition> { public final class PatternsRequestCondition extends AbstractRequestCondition<PatternsRequestCondition> {
@ -51,7 +48,7 @@ public final class PatternsRequestCondition extends AbstractRequestCondition<Pat
* @param patterns 0 or more URL patterns; if 0 the condition will match to every request. * @param patterns 0 or more URL patterns; if 0 the condition will match to every request.
*/ */
public PatternsRequestCondition(String... patterns) { public PatternsRequestCondition(String... patterns) {
this(patterns, null, false, false, null); this(patterns, null, null);
} }
/** /**
@ -59,45 +56,22 @@ public final class PatternsRequestCondition extends AbstractRequestCondition<Pat
* Each pattern that is not empty and does not start with "/" is pre-pended with "/". * Each pattern that is not empty and does not start with "/" is pre-pended with "/".
* @param patterns the URL patterns to use; if 0, the condition will match to every request. * @param patterns the URL patterns to use; if 0, the condition will match to every request.
* @param pathHelper to determine the lookup path for a request * @param pathHelper to determine the lookup path for a request
* @param useSuffixPatternMatch whether to enable matching by suffix (".*") * @param pathPatternRegistry the pattern registry in which we'll register the given paths
* @param useTrailingSlashMatch whether to match irrespective of a trailing slash
* @param extensions file extensions to consider for path matching
*/ */
public PatternsRequestCondition(String[] patterns, HttpRequestPathHelper pathHelper, public PatternsRequestCondition(String[] patterns, HttpRequestPathHelper pathHelper,
boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, Set<String> extensions) { PathPatternRegistry pathPatternRegistry) {
this(createPatternSet(patterns, pathPatternRegistry),
this(createPatternSet(patterns, useSuffixPatternMatch, useTrailingSlashMatch, extensions),
(pathHelper != null ? pathHelper : new HttpRequestPathHelper())); (pathHelper != null ? pathHelper : new HttpRequestPathHelper()));
} }
private static PathPatternRegistry createPatternSet(String[] patterns,boolean useSuffixPatternMatch, private static PathPatternRegistry createPatternSet(String[] patterns, PathPatternRegistry pathPatternRegistry) {
boolean useTrailingSlashMatch, Set<String> extensions) { PathPatternRegistry patternSet = pathPatternRegistry != null ? pathPatternRegistry : new PathPatternRegistry();
Set<String> fixedFileExtensions = (extensions != null) ? extensions.stream()
.map(ext -> (ext.charAt(0) != '.') ? "." + ext : ext)
.collect(Collectors.toSet()) : Collections.emptySet();
PathPatternRegistry patternSet = new PathPatternRegistry();
patternSet.setUseSuffixPatternMatch(useSuffixPatternMatch);
patternSet.setUseTrailingSlashMatch(useTrailingSlashMatch);
patternSet.setFileExtensions(extensions);
if(patterns != null) { if(patterns != null) {
Arrays.asList(patterns).stream() Arrays.asList(patterns).stream().forEach(p -> patternSet.register(p));
.map(prependLeadingSlash())
.forEach(p -> patternSet.register(p));
} }
return patternSet; return patternSet;
} }
private static Function<String, String> prependLeadingSlash() {
return pattern -> {
if (StringUtils.hasLength(pattern) && !pattern.startsWith("/")) {
return "/" + pattern;
}
else {
return pattern;
}
};
}
private PatternsRequestCondition(PathPatternRegistry patternRegistry, HttpRequestPathHelper pathHelper) { private PatternsRequestCondition(PathPatternRegistry patternRegistry, HttpRequestPathHelper pathHelper) {
this.patternRegistry = patternRegistry; this.patternRegistry = patternRegistry;
this.pathHelper = pathHelper; this.pathHelper = pathHelper;

70
spring-webflux/src/main/java/org/springframework/web/reactive/result/method/RequestMappingInfo.java
Unescape View File

@ -32,6 +32,7 @@ import org.springframework.web.reactive.result.condition.RequestConditionHolder;
import org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition; import org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition;
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.support.HttpRequestPathHelper; import org.springframework.web.server.support.HttpRequestPathHelper;
import org.springframework.web.util.patterns.PathPatternRegistry;
/** /**
* Encapsulates the following request mapping conditions: * Encapsulates the following request mapping conditions:
@ -470,10 +471,15 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
public RequestMappingInfo build() { public RequestMappingInfo build() {
RequestedContentTypeResolver contentTypeResolver = this.options.getContentTypeResolver(); RequestedContentTypeResolver contentTypeResolver = this.options.getContentTypeResolver();
PathPatternRegistry pathPatternRegistry = this.options.getPathPatternRegistry();
PathPatternRegistry conditionRegistry = new PathPatternRegistry();
conditionRegistry.setUseTrailingSlashMatch(pathPatternRegistry.useTrailingSlashMatch());
conditionRegistry.setUseSuffixPatternMatch(pathPatternRegistry.useSuffixPatternMatch());
conditionRegistry.setFileExtensions(pathPatternRegistry.getFileExtensions());
PatternsRequestCondition patternsCondition = new PatternsRequestCondition( PatternsRequestCondition patternsCondition = new PatternsRequestCondition(
this.paths, this.options.getPathHelper(), this.paths, this.options.getPathHelper(), conditionRegistry);
this.options.useSuffixPatternMatch(), this.options.useTrailingSlashMatch(),
this.options.getFileExtensions());
return new RequestMappingInfo(this.mappingName, patternsCondition, return new RequestMappingInfo(this.mappingName, patternsCondition,
new RequestMethodsRequestCondition(methods), new RequestMethodsRequestCondition(methods),
@ -496,9 +502,7 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
private HttpRequestPathHelper pathHelper; private HttpRequestPathHelper pathHelper;
private boolean trailingSlashMatch = true; private PathPatternRegistry pathPatternRegistry;
private boolean suffixPatternMatch = false;
private boolean registeredSuffixPatternMatch = false; private boolean registeredSuffixPatternMatch = false;
@ -516,29 +520,22 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
return this.pathHelper; return this.pathHelper;
} }
/** public PathPatternRegistry getPathPatternRegistry() {
* Whether to apply trailing slash matching in PatternsRequestCondition. if(this.pathPatternRegistry == null) {
* <p>By default this is set to 'true'. this.pathPatternRegistry = new PathPatternRegistry();
*/ this.pathPatternRegistry.setUseTrailingSlashMatch(true);
public void setTrailingSlashMatch(boolean trailingSlashMatch) { }
this.trailingSlashMatch = trailingSlashMatch; if(this.registeredSuffixPatternMatch) {
} RequestedContentTypeResolver resolver = getContentTypeResolver();
if (resolver != null && resolver instanceof MappingContentTypeResolver) {
public boolean useTrailingSlashMatch() { if (resolver instanceof MappingContentTypeResolver) {
return this.trailingSlashMatch; Set<String> fileExtensions = ((MappingContentTypeResolver) resolver).getKeys();
} this.pathPatternRegistry.setFileExtensions(fileExtensions);
}
/**
* Whether to apply suffix pattern matching in PatternsRequestCondition.
* <p>By default this is set to 'true'.
* @see #setRegisteredSuffixPatternMatch(boolean)
*/
public void setSuffixPatternMatch(boolean suffixPatternMatch) {
this.suffixPatternMatch = suffixPatternMatch;
}
public boolean useSuffixPatternMatch() { }
return this.suffixPatternMatch; }
return this.pathPatternRegistry;
} }
/** /**
@ -550,7 +547,6 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
*/ */
public void setRegisteredSuffixPatternMatch(boolean registeredSuffixPatternMatch) { public void setRegisteredSuffixPatternMatch(boolean registeredSuffixPatternMatch) {
this.registeredSuffixPatternMatch = registeredSuffixPatternMatch; this.registeredSuffixPatternMatch = registeredSuffixPatternMatch;
this.suffixPatternMatch = (registeredSuffixPatternMatch || this.suffixPatternMatch);
} }
public boolean useRegisteredSuffixPatternMatch() { public boolean useRegisteredSuffixPatternMatch() {
@ -558,18 +554,12 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
} }
/** /**
* Return the file extensions to use for suffix pattern matching. If * Set the PathPatternRegistry to use for parsing and matching path patterns
* {@code registeredSuffixPatternMatch=true}, the extensions are obtained * <p>By default, a new instance of {@link PathPatternRegistry} with
* from the configured {@code contentTypeResolver}. * {@link PathPatternRegistry#setUseTrailingSlashMatch(boolean)} set to {@code true}
*/ */
public Set<String> getFileExtensions() { public void setPathPatternRegistry(PathPatternRegistry pathPatternRegistry) {
RequestedContentTypeResolver resolver = getContentTypeResolver(); this.pathPatternRegistry = pathPatternRegistry;
if (useRegisteredSuffixPatternMatch() && resolver != null) {
if (resolver instanceof MappingContentTypeResolver) {
return ((MappingContentTypeResolver) resolver).getKeys();
}
}
return null;
} }
/** /**

76
spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/RequestMappingHandlerMapping.java
Unescape View File

@ -18,7 +18,6 @@ package org.springframework.web.reactive.result.method.annotation;
import java.lang.reflect.AnnotatedElement; import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.util.Set;
import org.springframework.context.EmbeddedValueResolverAware; import org.springframework.context.EmbeddedValueResolverAware;
import org.springframework.core.annotation.AnnotatedElementUtils; import org.springframework.core.annotation.AnnotatedElementUtils;
@ -48,53 +47,12 @@ import org.springframework.web.reactive.result.method.RequestMappingInfoHandlerM
public class RequestMappingHandlerMapping extends RequestMappingInfoHandlerMapping public class RequestMappingHandlerMapping extends RequestMappingInfoHandlerMapping
implements EmbeddedValueResolverAware { implements EmbeddedValueResolverAware {
private boolean useSuffixPatternMatch = false;
private boolean useRegisteredSuffixPatternMatch = false;
private boolean useTrailingSlashMatch = true;
private RequestedContentTypeResolver contentTypeResolver = new RequestedContentTypeResolverBuilder().build(); private RequestedContentTypeResolver contentTypeResolver = new RequestedContentTypeResolverBuilder().build();
private StringValueResolver embeddedValueResolver; private StringValueResolver embeddedValueResolver;
private RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration(); private RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();
/**
* Whether to use suffix pattern matching. If enabled a method mapped to
* "/path" also matches to "/path.*".
* <p>The default value is {@code true}.
* <p><strong>Note:</strong> when using suffix pattern matching it's usually
* preferable to be explicit about what is and isn't an extension so rather
* than setting this property consider using
* {@link #setUseRegisteredSuffixPatternMatch} instead.
*/
public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch) {
this.useSuffixPatternMatch = useSuffixPatternMatch;
}
/**
* Whether suffix pattern matching should work only against path extensions
* explicitly registered with the configured {@link RequestedContentTypeResolver}. This
* is generally recommended to reduce ambiguity and to avoid issues such as
* when a "." appears in the path for other reasons.
* <p>By default this is set to "true".
*/
public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch) {
this.useRegisteredSuffixPatternMatch = useRegisteredSuffixPatternMatch;
this.useSuffixPatternMatch = (useRegisteredSuffixPatternMatch || this.useSuffixPatternMatch);
}
/**
* Whether to match to URLs irrespective of the presence of a trailing slash.
* If enabled a method mapped to "/users" also matches to "/users/".
* <p>The default value is {@code true}.
*/
public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch) {
this.useTrailingSlashMatch = useTrailingSlashMatch;
}
/** /**
* Set the {@link RequestedContentTypeResolver} to use to determine requested media types. * Set the {@link RequestedContentTypeResolver} to use to determine requested media types.
* If not set, the default constructor is used. * If not set, the default constructor is used.
@ -113,36 +71,11 @@ public class RequestMappingHandlerMapping extends RequestMappingInfoHandlerMappi
public void afterPropertiesSet() { public void afterPropertiesSet() {
this.config = new RequestMappingInfo.BuilderConfiguration(); this.config = new RequestMappingInfo.BuilderConfiguration();
this.config.setPathHelper(getPathHelper()); this.config.setPathHelper(getPathHelper());
this.config.setSuffixPatternMatch(this.useSuffixPatternMatch);
this.config.setTrailingSlashMatch(this.useTrailingSlashMatch);
this.config.setRegisteredSuffixPatternMatch(this.useRegisteredSuffixPatternMatch);
this.config.setContentTypeResolver(getContentTypeResolver()); this.config.setContentTypeResolver(getContentTypeResolver());
super.afterPropertiesSet(); super.afterPropertiesSet();
} }
/**
* Whether to use suffix pattern matching.
*/
public boolean useSuffixPatternMatch() {
return this.useSuffixPatternMatch;
}
/**
* Whether to use registered suffixes for pattern matching.
*/
public boolean useRegisteredSuffixPatternMatch() {
return this.useRegisteredSuffixPatternMatch;
}
/**
* Whether to match to URLs irrespective of the presence of a trailing slash.
*/
public boolean useTrailingSlashMatch() {
return this.useTrailingSlashMatch;
}
/** /**
* Return the configured {@link RequestedContentTypeResolver}. * Return the configured {@link RequestedContentTypeResolver}.
*/ */
@ -150,14 +83,7 @@ public class RequestMappingHandlerMapping extends RequestMappingInfoHandlerMappi
return this.contentTypeResolver; return this.contentTypeResolver;
} }
/**
* Return the file extensions to use for suffix pattern matching.
*/
public Set<String> getFileExtensions() {
return this.config.getFileExtensions();
}
/** /**
* {@inheritDoc} * {@inheritDoc}
* Expects a handler to have a type-level @{@link Controller} annotation. * Expects a handler to have a type-level @{@link Controller} annotation.

24
spring-webflux/src/test/java/org/springframework/web/reactive/config/WebFluxConfigurationSupportTests.java
Unescape View File

@ -19,8 +19,10 @@ package org.springframework.web.reactive.config;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
import javax.xml.bind.annotation.XmlRootElement; import javax.xml.bind.annotation.XmlRootElement;
import org.hamcrest.Matchers;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
@ -51,6 +53,7 @@ import org.springframework.validation.Validator;
import org.springframework.web.bind.support.WebBindingInitializer; import org.springframework.web.bind.support.WebBindingInitializer;
import org.springframework.web.bind.support.WebExchangeDataBinder; import org.springframework.web.bind.support.WebExchangeDataBinder;
import org.springframework.web.reactive.accept.RequestedContentTypeResolver; import org.springframework.web.reactive.accept.RequestedContentTypeResolver;
import org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder;
import org.springframework.web.reactive.handler.AbstractHandlerMapping; import org.springframework.web.reactive.handler.AbstractHandlerMapping;
import org.springframework.web.reactive.handler.SimpleUrlHandlerMapping; import org.springframework.web.reactive.handler.SimpleUrlHandlerMapping;
import org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter; import org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter;
@ -70,6 +73,7 @@ import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame; import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertTrue;
import static org.springframework.http.MediaType.APPLICATION_JSON; import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.http.MediaType.APPLICATION_OCTET_STREAM; import static org.springframework.http.MediaType.APPLICATION_OCTET_STREAM;
@ -102,9 +106,9 @@ public class WebFluxConfigurationSupportTests {
assertEquals(0, mapping.getOrder()); assertEquals(0, mapping.getOrder());
assertFalse(mapping.useSuffixPatternMatch()); assertFalse(mapping.getPatternRegistry().useSuffixPatternMatch());
assertFalse(mapping.useRegisteredSuffixPatternMatch()); assertThat(mapping.getPatternRegistry().getFileExtensions(), Matchers.empty());
assertTrue(mapping.useTrailingSlashMatch()); assertTrue(mapping.getPatternRegistry().useTrailingSlashMatch());
name = "webFluxContentTypeResolver"; name = "webFluxContentTypeResolver";
RequestedContentTypeResolver resolver = context.getBean(name, RequestedContentTypeResolver.class); RequestedContentTypeResolver resolver = context.getBean(name, RequestedContentTypeResolver.class);
@ -126,8 +130,9 @@ public class WebFluxConfigurationSupportTests {
RequestMappingHandlerMapping mapping = context.getBean(name, RequestMappingHandlerMapping.class); RequestMappingHandlerMapping mapping = context.getBean(name, RequestMappingHandlerMapping.class);
assertNotNull(mapping); assertNotNull(mapping);
assertFalse(mapping.useSuffixPatternMatch()); assertFalse(mapping.getPatternRegistry().useTrailingSlashMatch());
assertFalse(mapping.useTrailingSlashMatch()); assertTrue(mapping.getPatternRegistry().useSuffixPatternMatch());
assertThat(mapping.getPatternRegistry().getFileExtensions(), Matchers.contains(".json", ".xml"));
} }
@Test @Test
@ -306,8 +311,15 @@ public class WebFluxConfigurationSupportTests {
@Override @Override
public void configurePathMatching(PathMatchConfigurer configurer) { public void configurePathMatching(PathMatchConfigurer configurer) {
configurer.setUseSuffixPatternMatch(false);
configurer.setUseTrailingSlashMatch(false); configurer.setUseTrailingSlashMatch(false);
configurer.setUseSuffixPatternMatch(true);
configurer.setUseRegisteredSuffixPatternMatch(true);
}
@Override
protected void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder) {
builder.mediaType("json", MediaType.APPLICATION_JSON);
builder.mediaType("xml", MediaType.APPLICATION_XML);
} }
} }

29
spring-webflux/src/test/java/org/springframework/web/reactive/result/condition/PatternsRequestConditionTests.java
Unescape View File

@ -21,7 +21,6 @@ import java.util.Collections;
import java.util.Iterator; import java.util.Iterator;
import java.util.Set; import java.util.Set;
import org.junit.Ignore;
import org.junit.Test; import org.junit.Test;
import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.http.server.reactive.ServerHttpRequest;
@ -30,6 +29,7 @@ import org.springframework.mock.http.server.reactive.test.MockServerHttpResponse
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.adapter.DefaultServerWebExchange; import org.springframework.web.server.adapter.DefaultServerWebExchange;
import org.springframework.web.util.patterns.PathPattern; import org.springframework.web.util.patterns.PathPattern;
import org.springframework.web.util.patterns.PathPatternRegistry;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNotNull;
@ -119,7 +119,8 @@ public class PatternsRequestConditionTests {
assertNotNull(match); assertNotNull(match);
assertEquals("/{foo}", match.getPatterns().iterator().next().getPatternString()); assertEquals("/{foo}", match.getPatterns().iterator().next().getPatternString());
condition = new PatternsRequestCondition(new String[] {"/foo"}, null, true, false, null); condition = new PatternsRequestCondition(new String[] {"/foo"}, null,
createPatternRegistry(true, false, null));
match = condition.getMatchingCondition(exchange); match = condition.getMatchingCondition(exchange);
assertNotNull(match); assertNotNull(match);
@ -132,7 +133,8 @@ public class PatternsRequestConditionTests {
public void matchSuffixPatternUsingFileExtensions() throws Exception { public void matchSuffixPatternUsingFileExtensions() throws Exception {
String[] patterns = new String[] {"/jobs/{jobName}"}; String[] patterns = new String[] {"/jobs/{jobName}"};
Set<String> extensions = Collections.singleton("json"); Set<String> extensions = Collections.singleton("json");
PatternsRequestCondition condition = new PatternsRequestCondition(patterns, null, true, false, extensions); PatternsRequestCondition condition = new PatternsRequestCondition(patterns, null,
createPatternRegistry(true, false, extensions));
ServerWebExchange exchange = createExchange("/jobs/my.job"); ServerWebExchange exchange = createExchange("/jobs/my.job");
PatternsRequestCondition match = condition.getMatchingCondition(exchange); PatternsRequestCondition match = condition.getMatchingCondition(exchange);
@ -152,10 +154,12 @@ public class PatternsRequestConditionTests {
@Test @Test
public void matchSuffixPatternUsingFileExtensions2() throws Exception { public void matchSuffixPatternUsingFileExtensions2() throws Exception {
PatternsRequestCondition condition1 = new PatternsRequestCondition( PatternsRequestCondition condition1 = new PatternsRequestCondition(
new String[] {"/prefix"}, null, true, false, Collections.singleton("json")); new String[] {"/prefix"}, null,
createPatternRegistry(true, false, Collections.singleton("json")));
PatternsRequestCondition condition2 = new PatternsRequestCondition( PatternsRequestCondition condition2 = new PatternsRequestCondition(
new String[] {"/suffix"}, null, true, false, null); new String[] {"/suffix"}, null,
createPatternRegistry(true, false, null));
PatternsRequestCondition combined = condition1.combine(condition2); PatternsRequestCondition combined = condition1.combine(condition2);
@ -174,14 +178,16 @@ public class PatternsRequestConditionTests {
assertNull("Should not match by default", match); assertNull("Should not match by default", match);
condition = new PatternsRequestCondition(new String[] {"/foo"}, null, false, true, null); condition = new PatternsRequestCondition(new String[] {"/foo"}, null,
createPatternRegistry(false, true, null));
match = condition.getMatchingCondition(exchange); match = condition.getMatchingCondition(exchange);
assertNotNull(match); assertNotNull(match);
assertEquals("Trailing slash should be insensitive to useSuffixPatternMatch settings (SPR-6164, SPR-5636)", assertEquals("Trailing slash should be insensitive to useSuffixPatternMatch settings (SPR-6164, SPR-5636)",
"/foo/", match.getPatterns().iterator().next().getPatternString()); "/foo/", match.getPatterns().iterator().next().getPatternString());
condition = new PatternsRequestCondition(new String[] {"/foo"}, null, true, true, null); condition = new PatternsRequestCondition(new String[] {"/foo"}, null,
createPatternRegistry(true, true, null));
match = condition.getMatchingCondition(exchange); match = condition.getMatchingCondition(exchange);
assertNotNull(match); assertNotNull(match);
@ -232,4 +238,13 @@ public class PatternsRequestConditionTests {
return new DefaultServerWebExchange(request, new MockServerHttpResponse()); return new DefaultServerWebExchange(request, new MockServerHttpResponse());
} }
private PathPatternRegistry createPatternRegistry(boolean useSuffixPatternMatch, boolean useTrailingSlashMatch,
Set<String> extensions) {
PathPatternRegistry registry = new PathPatternRegistry();
registry.setUseSuffixPatternMatch(useSuffixPatternMatch);
registry.setUseTrailingSlashMatch(useTrailingSlashMatch);
registry.setFileExtensions(extensions);
return registry;
}
} }

7
spring-webflux/src/test/java/org/springframework/web/reactive/result/method/RequestMappingInfoHandlerMappingTests.java
Unescape View File

@ -64,6 +64,7 @@ import org.springframework.web.server.UnsupportedMediaTypeStatusException;
import org.springframework.web.server.adapter.DefaultServerWebExchange; import org.springframework.web.server.adapter.DefaultServerWebExchange;
import org.springframework.web.server.support.HttpRequestPathHelper; import org.springframework.web.server.support.HttpRequestPathHelper;
import org.springframework.web.util.patterns.PathPattern; import org.springframework.web.util.patterns.PathPattern;
import org.springframework.web.util.patterns.PathPatternRegistry;
import static org.hamcrest.CoreMatchers.containsString; import static org.hamcrest.CoreMatchers.containsString;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
@ -545,10 +546,12 @@ public class RequestMappingInfoHandlerMappingTests {
protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) { protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
RequestMapping annot = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class); RequestMapping annot = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class);
if (annot != null) { if (annot != null) {
PathPatternRegistry pathPatternRegistry = new PathPatternRegistry();
pathPatternRegistry.setUseSuffixPatternMatch(true);
pathPatternRegistry.setUseTrailingSlashMatch(true);
BuilderConfiguration options = new BuilderConfiguration(); BuilderConfiguration options = new BuilderConfiguration();
options.setPathHelper(getPathHelper()); options.setPathHelper(getPathHelper());
options.setSuffixPatternMatch(true); options.setPathPatternRegistry(pathPatternRegistry);
options.setTrailingSlashMatch(true);
return paths(annot.value()).methods(annot.method()) return paths(annot.value()).methods(annot.method())
.params(annot.params()).headers(annot.headers()) .params(annot.params()).headers(annot.headers())
.consumes(annot.consumes()).produces(annot.produces()) .consumes(annot.consumes()).produces(annot.produces())

63
spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/RequestMappingHandlerMappingTests.java
Unescape View File

@ -22,10 +22,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set; import java.util.Set;
import java.util.SortedSet;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import org.hamcrest.Matchers; import org.hamcrest.Matchers;
@ -43,19 +40,12 @@ import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.context.support.StaticWebApplicationContext; import org.springframework.web.context.support.StaticWebApplicationContext;
import org.springframework.web.reactive.accept.MappingContentTypeResolver;
import org.springframework.web.reactive.result.method.RequestMappingInfo; import org.springframework.web.reactive.result.method.RequestMappingInfo;
import org.springframework.web.util.patterns.PathPattern;
import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertArrayEquals; import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.contains;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
/** /**
* Unit tests for {@link RequestMappingHandlerMapping}. * Unit tests for {@link RequestMappingHandlerMapping}.
@ -74,59 +64,6 @@ public class RequestMappingHandlerMappingTests {
this.handlerMapping.setApplicationContext(wac); this.handlerMapping.setApplicationContext(wac);
} }
@Test
public void useRegisteredSuffixPatternMatch() {
assertFalse(this.handlerMapping.useSuffixPatternMatch());
assertFalse(this.handlerMapping.useRegisteredSuffixPatternMatch());
MappingContentTypeResolver contentTypeResolver = mock(MappingContentTypeResolver.class);
when(contentTypeResolver.getKeys()).thenReturn(Collections.singleton("json"));
this.handlerMapping.setUseSuffixPatternMatch(true);
this.handlerMapping.setUseRegisteredSuffixPatternMatch(true);
this.handlerMapping.setContentTypeResolver(contentTypeResolver);
this.handlerMapping.afterPropertiesSet();
assertTrue(this.handlerMapping.useSuffixPatternMatch());
assertTrue(this.handlerMapping.useRegisteredSuffixPatternMatch());
assertEquals(Collections.singleton("json"), this.handlerMapping.getFileExtensions());
}
@Test
public void useRegisteredSuffixPatternMatchInitialization() {
MappingContentTypeResolver contentTypeResolver = mock(MappingContentTypeResolver.class);
when(contentTypeResolver.getKeys()).thenReturn(Collections.singleton("json"));
final Set<String> actualExtensions = new HashSet<>();
RequestMappingHandlerMapping localHandlerMapping = new RequestMappingHandlerMapping() {
@Override
protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
actualExtensions.addAll(getFileExtensions());
return super.getMappingForMethod(method, handlerType);
}
};
this.wac.registerSingleton("testController", ComposedAnnotationController.class);
this.wac.refresh();
localHandlerMapping.setContentTypeResolver(contentTypeResolver);
localHandlerMapping.setUseRegisteredSuffixPatternMatch(true);
localHandlerMapping.setApplicationContext(this.wac);
localHandlerMapping.afterPropertiesSet();
assertEquals(Collections.singleton("json"), actualExtensions);
}
@Test
public void useSuffixPatternMatch() {
assertFalse(this.handlerMapping.useSuffixPatternMatch());
assertFalse(this.handlerMapping.useRegisteredSuffixPatternMatch());
this.handlerMapping.setUseRegisteredSuffixPatternMatch(true);
assertTrue("'true' registeredSuffixPatternMatch should enable suffixPatternMatch",
this.handlerMapping.useSuffixPatternMatch());
}
@Test @Test
public void resolveEmbeddedValuesInPatterns() { public void resolveEmbeddedValuesInPatterns() {
this.handlerMapping.setEmbeddedValueResolver( this.handlerMapping.setEmbeddedValueResolver(

Write Preview
Loading…
Cancel
Save