Improve PathMatcher to PathPatternParser migration in mvc XML configuration #34064
Assignees
Labels
in: web
Issues in web modules (web, webmvc, webflux, websocket)
status: backported
An issue that has been backported to maintenance branches
type: enhancement
A general enhancement
Milestone
Comments
bclozel
added
in: web
bclozel
added
the
for: backport-to-6.1.x
github-actions
bot
added
status: backported
bclozel
added a commit
that referenced
this issue
Dec 17, 2024
Prior to this commit, the MVC namespace for the XML Spring configuration model would use the `PathMatcher` bean instance when provided like this: ``` <bean id="pathMatcher" class="org.springframework.util.AntPathMatcher"/> <mvc:annotation-driven> <mvc:path-matching path-matcher="pathMatcher"/> </mvc:annotation-driven> <mvc:resources mapping="/resources/**" location="classpath:/static/"/> ``` With this configuration, the handler mapping for annotated controller would use the given `AntPathMatcher` instance but the handler mapping for resources would still use the default, which is `PathPatternParser` since 6.0. This commit ensures that when a custom `path-matcher` is defined, it's consistently used for all MVC handler mappings as an alias to the well-known bean name. This allows to use `AntPathMatcher` consistently while working on a migration path to `PathPatternParser` This commit also adds a new XML attribute to the path matching configuration that makes it possible to use a custom `PathPatternParser` instance: ``` <bean id="patternParser" class="org.springframework.web.util.pattern.PathPatternParser"/> <mvc:annotation-driven> <mvc:path-matching pattern-parser="patternParser"/> </mvc:annotation-driven> ``` Closes gh-34102 See gh-34064
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As of Spring Framework 6.0, several path matching options have been deprecated and the
PathPatternParseris being chosen by default over theAntPathMatcher. The Java configuration upgrade has been done progressively and deprecated options are going to be retired in #34036 and #34018.We received feedback from customers about gaps in the upgrade experience in the mvc XML configuration namespace. While this configuration option is going to be deprecated itself in #34063, we should ensure that the upgrade experience is good.
Targeting this issue for 6.2.x with backports in 6.1.x and commercial versions.
The text was updated successfully, but these errors were encountered: