Skip to content

Expose matched PathPattern as MVC request attribute #37272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Eymenonar wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −0
Open

Expose matched PathPattern as MVC request attribute #37272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions spring-webmvc/src/main/java/org/springframework/web/servlet/HandlerMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,14 @@ public interface HandlerMapping {
*/
String BEST_MATCHING_PATTERN_ATTRIBUTE = HandlerMapping.class.getName() + ".bestMatchingPattern";

/**
* Name of the {@link HttpServletRequest} attribute that contains the best
* matching {@link org.springframework.web.util.pattern.PathPattern}, when
* parsed patterns are in use.
* @since 7.1
*/
String BEST_MATCHING_PATH_PATTERN_ATTRIBUTE = HandlerMapping.class.getName() + ".bestMatchingPathPattern";

/**
* Name of the boolean {@link HttpServletRequest} attribute that indicates
* whether type-level mappings should be inspected.
Expand Down
1 change: 1 addition & 0 deletions ...ain/java/org/springframework/web/servlet/mvc/method/RequestMappingInfoHandlerMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ private void extractMatchDetails(
uriVariables = result.getUriVariables();
request.setAttribute(MATRIX_VARIABLES_ATTRIBUTE, result.getMatrixVariables());
}
request.setAttribute(BEST_MATCHING_PATH_PATTERN_ATTRIBUTE, bestPattern);
request.setAttribute(BEST_MATCHING_PATTERN_ATTRIBUTE, bestPattern.getPatternString());
ServerHttpObservationFilter.findObservationContext(request)
.ifPresent(context -> context.setPathPattern(bestPattern.getPatternString()));
Expand Down
16 changes: 16 additions & 0 deletions ...ava/org/springframework/web/servlet/mvc/method/RequestMappingInfoHandlerMappingTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
import org.springframework.web.util.ServletRequestPathUtils;
import org.springframework.web.util.UrlPathHelper;
import org.springframework.web.util.pattern.PathPattern;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
Expand Down Expand Up @@ -317,6 +318,21 @@ void handleMatchBestMatchingPatternAttribute(TestRequestMappingInfoHandlerMappin
assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)).isEqualTo("/{path1}/2");
}

@Test
void handleMatchBestMatchingPathPatternAttribute() {
TestRequestMappingInfoHandlerMapping mapping = new TestRequestMappingInfoHandlerMapping();
RequestMappingInfo info = mapping.createInfo("/{path1}/2", "/**");
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2");
ServletRequestPathUtils.parseAndCache(request);

mapping.handleMatch(info, "/1/2", request);

assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)).isEqualTo("/{path1}/2");
assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATH_PATTERN_ATTRIBUTE))
.isInstanceOfSatisfying(PathPattern.class,
pattern -> assertThat(pattern.getPatternString()).isEqualTo("/{path1}/2"));
}

@SuppressWarnings("removal")
@PathPatternsParameterizedTest
void handleMatchBestMatchingPatternAttributeInObservationContext(TestRequestMappingInfoHandlerMapping mapping) {
Expand Down