Spring MVC @RequestMapping注解详解

Posted JustDo

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring MVC @RequestMapping注解详解相关的知识,希望对你有一定的参考价值。

@RequestMapping 参数说明

  value:定义处理方法的请求的 URL 地址。(重点)

  method:定义处理方法的 http method 类型,如 GET、POST 等。(重点)

  params:定义请求的 URL 中必须包含的参数。或者不包含某些参数。(了解)

  headers:定义请求中 Request Headers 必须包含的参数。或者不包含某些参数。(了解)

 

 

@RequestMapping 的用法

  @RequestMapping 有两种标注方式,一种是标注在类级别上,一种是标注在方法级别上。标注在方法上时,value 表示访问该方法的 URL 地址。标注在类上时,value 相当于一个命名空间,即访问该 Controller 下的任意方法都需要带上这个命名空间。例如:

Java代码

 1 @Controller
 2 @RequestMapping("/example")
 3 public class ExampleController {
 4 
 5     @RequestMapping
 6     public String execute(){
 7         return "example_page";
 8     }
 9     
10     @RequestMapping("/todo")
11     public String doSomething(){
12         return "example_todo_page";
13     }
14     
15 }

  1:/example.action:执行的是 execute() 方法。execute() 方法的 @RequestMapping 注解缺省 value 值,在这种情况下,当访问命名空间时默认执行的是这个方法。方法级别上的 @RequestMapping 标注是必须的,否则方法无法被正确访问。

  2:/example/todo.action执行的是 doSomething() 方法。类级别上的 @RequestMapping 标注不是必须的,在不写的情况下,方法上定义的 URL 都是绝对地址,否则,方法上定义的 URL 都是相对于它所在的 Controller 的。

 

@RequestMapping(method):指定页面请求方式

1 @RequestMapping(value = "/register", method = RequestMethod.GET)
2 public String register(){
3     return "example_register_page";
4 }

  method 的值一旦指定,那么,处理方法就只对指定的 http method 类型的请求进行处理。 这里方法/register只能使用get请求,使用post请求无法访问

1 @RequestMapping(value = "/register", method = RequestMethod.GET)
2 public String register1(){
3     return "example_register_get_page";
4 }
5 
6 @RequestMapping(value = "/register", method = RequestMethod.POST)
7 public String register2(){
8     return "example_register_post_page";
9 }

  可以为多个方法映射相同的 URI,不同的 http method 类型,Spring MVC 根据请求的 method 类型是可以区分开这些方法的。当 /example/register.action 是以 GET 的方式提交的时候,Spring MVC 调用 register1() 来处理请求;若是以 POST 的方式提交,则调 register2() 来处理提交的请求。

  method 若是缺省没指定,并不是说它默认只处理 GET 方式的请求,而是它可以处理任何方式的 http method 类型的请求。指定 method 是为了细化映射 ( 缩小处理方法的映射范围 ),在 method 没有指定的情况下,它的映射范围是最大的。

 

@RequestMapping(params)

  与 method 相类似,作用是为了细化映射。只有当 URL 中包含与 params 值相匹配的参数的请求,处理方法才会被调用。

 1 @RequestMapping(value = "/find", params = "target")
 2 public String find1(){
 3     return "example_find1_page";
 4 }
 5 
 6 @RequestMapping(value = "/find", params = "!target")
 7 public String find2(){
 8     return "example_find2_page";
 9 }
10 
11 @RequestMapping(value = "/search", params = "target=product")
12 public String search1(){
13     return "example_search1_page";
14 }
15 
16 @RequestMapping(value = "/search", params = "target!=product")
17 public String search2(){
18     return "example_search2_page";
19 }

  find1():请求的 URL 中必须要有 target 参数,才能够到达此方法。如 /example/find.action?target 或 /example/find.action?target=x 等

  find2():请求的 URL 中必须不能有 target 参数,才能够到达此方法。如 /example/find.action 或 /example/find.action?q=x 等

  search1():请求的 URL 中必须要有 target=product 参数,才能够到达此方法。如 /example/search.action?target=product 等

  search2():请求的 URL 中必须不能有 target=product 参数,才能够到达此方法。如 /example/search.action?target=article 等

 

 

@RequestMapping(headers)

  headers 的作用也是用于细化映射。只有当请求的 Request Headers 中包含与 heanders 值相匹配的参数,处理方法才会被调用。 

 

1 @RequestMapping(value = "/specify", headers = "accept=text/*")
2 public String specify(){
3     return "example_specify_page";
4 }

 

  请求的 Request Headers 中 Accept 的值必须匹配 text/* ( 如 text/html ),方法才会被调用。

 

@RequestMapping支持Ant风格的通配符

通配符说明示例
? 匹配一个任意字符 /a/?b 可以匹配/a/ab;/a/cb。但不能匹配/a/acb之类
* 匹配任意长度的字符 /a/ *b可以匹配/a/cb;/a/acb。但不能匹配/a/cb/vb
** 匹配多层路径 可以匹配/a/ab;/a/acb;/a/ab/abc/…/…

 

以上是关于Spring MVC @RequestMapping注解详解的主要内容,如果未能解决你的问题,请参考以下文章

spring boot为啥引入两个mapping会报错

Spring Cloud Spring Boot mybatis分布式微服务云架构(十三)使用Spring Security安全控制

Spring Boot2 系列教程 (十五) | 服务端参数校验之一

Spring MVC学习笔记---Spring MVC 的HelloWorld

Spring MVC学习笔记---Spring MVC 的HelloWorld

Spring MVC学习—MVC的介绍以及Spring MVC的入门案例