@RequestMapping属性详解 - SpringMVC高手进阶
目录- 前言
- RequestMapping接口源码解析
- RequestMapping属性介绍
- 1、name
- 2、value
- 3、path
- 4、method
- 5、params
- 6、headers
- 7、consumes
- 8、produces
- 1、name
- 2、value
- 3、path
- 4、method
- 5、params
- 6、headers
- 7、consumes
- 8、produces
前言
在日常java面试中springMVC已经是必不可少的一环了，昨天与几位朋友交流了一下面试SpringMVC框架时的心得。 我们发现大部分面试者仅了解SpringMVC的执行流程和组件这第一层，有些确实说的有模有样，也有些比较糊弄，但当追问到SpringMVC注解（Annotation）具体实现部分时，多显得异常狼狈。
因此，我在这记录一下我们常考查的注解实战性问题之一：
@RequestMapping注解的属性有哪些？分别都是干什么用的？
设想：如果是你回答这个问题，你有几成把握
RequestMapping接口源码解析
RequestMapping接口的源码如下，里面定义了八个属性（Spring4.3.8）。 注：SpringMVC在4.1版本对RequestMapping属性做了相应调整，去掉了path属性。
@Target({ElementType.METHOD, ElementType.TYPE}) // 可以在方法和类的声明中使用
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
String name() default "";// 指定映射的名称
@AliasFor("path")
String[] value() default {}; // 指定请求路径的地址
@AliasFor("value")
String[] path() default {}; // 指定请求路径的地址
// 指定请求的方式，是一个RequsetMethod数组，可以配置多个方法
RequestMethod[] method() default {};
// 指定参数的类型
String[] params() default {};
// 指定请求头内容
String[] headers() default {};
// 指定数据请求的格式
String[] consumes() default {};
// 指定返回的内容类型
String[] produces() default {};
}- 如上源码所示，在@Target中有两个属性，分别为 ElementType.METHOD 和 ElementType.TYPE ，也就是说@RequestMapping 可以在方法和类的声明中使用
- 可以看到注解中的属性除了 name() 返回的字符串，其它的方法均返回数组，也就是可以定义多个属性值，例如 value() 和 path() 都可以同时定义多个字符串值来接收多个URL请求
RequestMapping属性介绍
1、name
此处name属性，相当于方法的注释，使方法更易理解
@RequestMapping(value = "login",name = "用户登录")
@ResponseBody
public String login() {
return "success";
}官方文档说：它能让你非常方便的在JSP页面上使用它，形如这样子可以直接通过静态页面调用：
<%@ taglib uri="http://www.springframework.org/tags" prefix="s" %>
...
<a href="${s:mvcUrl('PAC#getAddress').arg(0,'US').buildAndExpand('123')}">Get Address</a>2、value
@Controller
@RequestMapping("user") //此处如果不省略，则为@RequestMapping(value="user")
public class UserController {
@RequestMapping("login")
@ResponseBody
public String login() {
return "success";
}
}指定请求的实际地址，指定的地址可以是URI 模板模式（Template Pattern）；
由于value属性是@RequestMapping注释的默认属性，因此如果只有唯一的属性，则可以省略该属性名，如果有超过一个属性，则必须写上value属性名称。即如下两个标注含义一样
@RequestMapping(value="login")
@RequestMapping("login")value属性支持通配符匹配：
@RequestMapping(value="login/*")；即：http://localhost:8080/login/1或者http://localhost:8080/login/hahaha都能够正常访问该接口
此处通过URL：http://localhost:8080/user/login进行访问，将由login()方法进行处理
3、path
与value同义，path(value)（path 和 value 互相引用，参见RequestMapping接口源码） path属性，和1中的value属性使用一致，两者都是用来作为映射使用的。
@RequestMapping(value=“login”)、@RequestMapping(path=“login”)，这两种情况都能对login()方法进行访问
path属性支持通配符匹配：
@RequestMapping(path="login/*")；即：http://localhost:8080/login/1或者http://localhost:8080/login/abc都能够正常访问
4、method
指定请求类型， 如GET、POST、PUT、DELETE等；
@RequestMapping(value = "login",method = RequestMethod.GET)
@ResponseBody
public String login() {
return "success";
}以上方法表示，该方法只支持GET请求。
此处也可以为
@RequestMapping(value = "login",method = {RequestMethod.GET,RequestMethod.POST})说明该方法可以同时支持GET和POST请求。
如果没有method属性，则说明该方法支持全部的HTTP请求。
5、params
该属性指定，请求中必须包含params属性规定的参数时，才能执行该请求
@RequestMapping(value = "login",params = "flag")
@ResponseBody
public String login() {
return "success";
}以上方法，说明请求中必须包含flag参数才能执行该请求，flag参数值不做要求
http://localhost:8080/login?flag=xxx // 正常访问
http://localhost:8080/login // 无法访问
@RequestMapping(value = "login",params = "flag=true")
@ResponseBody
public String login() {
return "success";
}以上方法，说明请求中必须包含flag参数，而且参数值必须为true才能执行该请求
http://localhost:8080/login?flag=true // 正常访问
http://localhost:8080/login?flag=false // 无法访问
http://localhost:8080/login // 无法访问
6、headers
- 用于HTTP协义交互的信息被称为HTTP报文，客户端发送的HTTP报文被称为请求报文，服务器发回给客户端的HTTP报文称为响应报文，报文由报文头部和报文体组成。
- 请求头部（Request Headers）：请求头包含许多有关客户端环境和请求正文的信息，例如浏览器支持的语言、请求的服务器地址、客户端的操作系统等。
- 响应头部（Rsponse Headers）：响应头也包含许多有用的信息，包括服务器类型、日期、响应内容的类型及编码，响应内容的长度等等。
该属性指定，请求中必须包含某些指定的header值，才能够让该方法处理请求
如Chrome浏览器：
可以通过点击F12（进入开发者模式）---->Network---->Name中点击网页---->右侧查看Headers即可，下边是我电脑中的一个请求头部示例：
Request Headers
Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Accept-Encoding:gzip, deflate, sdch
Accept-Language:zh-CN,zh;q=0.8
Cache-Control:max-age=0
Connection:keep-alive
Cookie:JSESSIONID=210075B5E521CWE3CDE938076295A57A
Host:localhost:8080
Upgrade-Insecure-Requests:1
User-Agent:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.93// 表示只接收本机发来的请求
@RequestMapping(path = "/login", headers="Referer=http://localhost:8080")
public String login() {
return "success";
}以上方法 ，必须满足请求的header中包含了指定的"Referer"请求头和值为"http://localhost:8080"时，才能执行该请求
7、consumes
指定处理请求的提交内容类型（Content-Type），例如：application/json、text/html时，才能够让该方法处理请求
@RequestMapping(value = "login",consumes = "application/json")
@ResponseBody
public String login() {
return "success";
}8、produces
指定返回的内容类型，返回的内容类型必须是request请求头（Accept）中所包含的类型
@RequestMapping(value = "login",produces = "application/json")
@ResponseBody
public String login() {
return "success";
}此外，produces属性还可以指定返回值的编码
@RequestMapping(value = "login",produces = "application/json，charset=utf-8")如上，则指明返回utf-8编码
腾讯云开发者
