Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Require explicit path mappings for @RequestMapping methods

Browse Source 
Prior to this commit, handler methods in Spring MVC controllers were
not required to provide explicit path mappings via @RequestMapping (or
any of its specializations such as @GetMapping). Such handler methods
were effectively mapped to all paths. Consequently, developers may have
unwittingly mapped all requests to a single handler method.

This commit addresses this by enforcing that @RequestMapping methods
are mapped to an explicit path. Note, however, that this is enforced
after type-level and method-level @RequestMapping information has been
merged.

Developers wishing to map to all paths should now add an explicit path
mapping to "/**" or "**".

Closes gh-22543
This commit is contained in:
Sam Brannen
2019-04-04 16:55:54 +02:00
parent de69871354
commit c0b52d09f5
6 changed files with 71 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-web/src/main/java/org/springframework/web/bind/annotation/GetMapping.java
View File

@@ -31,7 +31,6 @@ import org.springframework.core.annotation.AliasFor;
* <p>Specifically, {@code @GetMapping} is a <em>composed annotation</em> that
* acts as a shortcut for {@code @RequestMapping(method = RequestMethod.GET)}.
*
*
* @author Sam Brannen
* @since 4.3
* @see PostMapping

19
spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java
View File

@@ -88,26 +88,33 @@ public @interface RequestMapping {
/**
* The primary mapping expressed by this annotation.
* <p>This is an alias for {@link #path}. For example
* <p>This is an alias for {@link #path}. For example,
* {@code @RequestMapping("/foo")} is equivalent to
* {@code @RequestMapping(path="/foo")}.
* <p><b>Supported at the type level as well as at the method level!</b>
* When used at the type level, all method-level mappings inherit
* this primary mapping, narrowing it for a specific handler method.
* <p><strong>NOTE</strong>: Each handler method must be mapped to a
* non-empty path, either at the type level, at the method level, or a
* combination of the two. If you wish to map to all paths, please map
* explicitly to {@code "/**"} or {@code "**"}.
*/
@AliasFor("path")
String[] value() default {};
/**
* The path mapping URIs (e.g. "/myPath.do").
* Ant-style path patterns are also supported (e.g. "/myPath/*.do").
* At the method level, relative paths (e.g. "edit.do") are supported
* The path mapping URIs (e.g. {@code "/myPath.do"}).
* <p>Ant-style path patterns are also supported (e.g. {@code "/myPath/*.do"}).
* At the method level, relative paths (e.g. {@code "edit.do"}) are supported
* within the primary mapping expressed at the type level.
* Path mapping URIs may contain placeholders (e.g. "/${connect}").
* Path mapping URIs may contain placeholders (e.g. <code>"/${connect}"</code>).
* <p><b>Supported at the type level as well as at the method level!</b>
* When used at the type level, all method-level mappings inherit
* this primary mapping, narrowing it for a specific handler method.
* @see org.springframework.web.bind.annotation.ValueConstants#DEFAULT_NONE
* <p><strong>NOTE</strong>: Each handler method must be mapped to a
* non-empty path, either at the type level, at the method level, or a
* combination of the two. If you wish to map to all paths, please map
* explicitly to {@code "/**"} or {@code "**"}.
* @since 4.2
*/
@AliasFor("value")