@RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
先来看下@RequestMapping的源代码
@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 {};
RequestMethod[] method() default {};
String[] params() default {};
String[] headers() default {};
String[] consumes() default {};
String[] produces() default {};
}
分析一下:
- @Target({ElementType.METHOD, ElementType.TYPE})
表示该注解只能用于方法和类上
- String name() default "";
name属性映射的名称,使用较少,默认为空。
- @AliasFor("path") String[] value() default {};
- @AliasFor("value")String[] path() default {};
这里的value和path一起说下,@AliasFor表示这两个属性互为别名,一旦使用了该注解,就必然需要两个属性,体现出他们的相互性。在使用中也是完全一致的,例:
@RequestMapping(value = "data")
@RequestMapping(path = "data")
可以为value配置多个值:
@RequestMapping(value = {"list", ""})
表示请求list和空字符串均会执行该注解下的方法。
- RequestMethod[] method() default {};
表示请求的方法,默认为Get,类型为枚举类型
public enum RequestMethod {
GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
}
使用,例:
@RequestMapping(value = { "/getalerts" }, method = RequestMethod.GET)
指定请求方法后,如果请求使用的不是指定的请求方法,会报错。
- String[] params() default {};
对请求中参数的要求,指定request中必须包含某些参数值是,才让该方法处理。
params:可以限制请求参数
param1: 表示请求必须包含名为 param1 的请求参数
!param1: 表示请求不能包含名为 param1 的请求参数
param1 != value1: 表示请求包含名为 param1 的请求参数,但其值不能为 value1
{“param1=value1”, “param2”}: 请求必须包含名为 param1 和param2 的两个请求参数,且 param1 参数的值必须为 value1
- String[] headers() default {};
指定request中必须包含某些指定的header值,才能让该方法处理请求。
- String[] consumes() default {};
指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;
- String[] produces() default {};
指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;