这篇文章主要介绍“SpringMVC @RequestMapping注解怎么使用”,在日常操作中,相信很多人在SpringMVC @RequestMapping注解怎么使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”SpringMVC @RequestMapping注解怎么使用”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!
1、@RequestMapping注解的作用
@RequestMapping注解的作用,就是将请求和处理请求的控制器方法关联起来,建立映射关系。
SpringMVC接收到一个请求,就会在映射关系中找到对应的控制器方法来处理这个请求。
@RequestMapping有很多属性,设置得越多,匹配的请求越精确。
控制器中有多个方法对应同一个请求,怎么处理?
编译前正常,运行时报错。说对于这个请求,已经存在对应的控制器方法了
多个控制器,对于同一个请求配置了不同的控制器方法,怎么处理?
编译前正常,运行时报错。说对于这个请求,已经存在对应的控制器方法了
也就是说,
请求和它的处理器方法必须是一一对应的关系。
2、@RequestMapping注解的位置
查看@RequestMapping注解的源码
@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented @Mapping public @interface RequestMapping { ... }
从@Target可以看出
ElementType.TYPE:可以标记类
ElementType.METHOD:可以标记方法
有两种情况,标记在类上和标记在方法上
@RequestMapping标识一个类:设置映射请求的请求路径的
初始信息
@RequestMapping标识一个方法:设置映射请求请求路径的
具体信息
@Controller @RequestMapping("/test") public class RequestMappingController { //此时请求映射所映射的请求的请求路径为:/test/testRequestMapping @RequestMapping("/testRequestMapping") public String testRequestMapping(){ return "success"; } }
使用场景
常用于区分不同模块的相同功能
比如用户模块和订单模块都有展示数据功能,请求路径都是/list。
如果单纯在两个控制器中配置两个针对/list的方法,则一个请求对应了两个控制方法,运行时会报错。
而为了功能命名的统一,也不希望设置不同的名称,比如/user_list 与 /order_list ,这样虽然可以解决问题,但不合理。
可以使用在类上配置@RequestMapping的方式,来区分用户和订单的 /list。
比如
@Controller @RequestMapping("/user") public class UserController { //此时请求映射所映射的请求的请求路径为:/user/list @RequestMapping("/list") public String getUserList(){ return "userList"; } } @Controller @RequestMapping("/order") public class OrderController { //此时请求映射所映射的请求的请求路径为:/order/list @RequestMapping("/list") public String getOrderList(){ return "orderList"; } }
在访问时,可以指定"/user/list" 和"/order/list"
3、value属性
(1)基础用法
阅读源码
public @interface RequestMapping { ... @AliasFor("path") String[] value() default {}; ... }
@RequestMapping中value属性的作用
value属性必须配置!
@RequestMapping注解的value属性
通过请求的请求地址匹配请求映射。
它是一个字符串类型的数组,表示该请求映射
能够匹配多个请求地址所对应的请求
@RequestMapping(value={"/text1", "/text2"}) public String toTarget(){ System.out.println("请求收到"); //返回视图名称 return "text"; }
通过/text1和/text2,都能匹配到这个控制器方法,跳转到text对应的视图页面
注意
有些特殊字符不能被匹配,例如 ? 或 / 或 空格
(2)路径中的占位符(重点)
SpringMVC支持路径中的占位符,在restful风格中会用到
什么是restful风格
通过拼接请求路径的方式,传递请求参数
原始方式:/deleteUser?id=1
rest方式:/deleteUser/1
服务器如何知道哪个/是目录,哪个/是参数?
参数部分,用{}占位符来填充。
例如 /test/{} 就可以匹配/test/1 ,而/test/test/1这样的更深目录,就不会被错误匹配到
但要注意,此时 /test 请求不能被 /test/{}匹配到。 /test/ 也不行。
如何使用restful风格传参
当请求路径中,将某些数据通过路径的方式传输到服务器中后;
就可以在相应的@RequestMapping注解的value属性中,通过占位符{自定义名称}表示传输的数据;
在控制器方法的参数部分添加@PathVariable注解,将占位符所表示的数据赋值给控制器方法的形参;
这样就实现了从前端页面传参给后端控制器方法。
总结:
占位符{}告诉控制方法,此处是一个rest风格的参数;
@PathVariable用于将这个参数与控制器方法的形参进行绑定,使之可以在方法中使用。
示例
单个参数
模拟传参
<a th:href="https://www.maopiaopiao.com">
控制器方法
@RequestMapping("/testPath/{id}") public String testPath(@PathVariable String id){ System.out.println("id = " + id); return "target"; }
4、method属性
阅读源码
public @interface RequestMapping { ... RequestMethod[] method() default {}; ... }
可以看出,method是一个RequestMethod类型的数组(RequestMethod就是请求方法)
RequestMethod是一个枚举类,包括:GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
@RequestMapping中method属性的作用
@RequestMapping注解的method属性通过请求的请求方式(get或post)匹配请求映射。
它是一个RequestMethod类型的数组,表示该请求映射能够匹配多种请求方式的请求
如果不设置method,默认是任何请求方式都能匹配(因为此时不以请求方式为条件)
使用场景
后续CRUD时,可以根据请求方式的不同,在同一个请求路径下,匹配不同的控制方法,执行不同的SQL语句。
示例
由于value属性必须设置,所以设置method属性后,意思是既要满足请求地址,又要满足请求方法。
@RequestMapping(value="/target", method = {RequestMethod.GET, RequestMethod.POST}) public String toTarget(){ System.out.println("请求收到"); //返回视图名称 return "target"; }
注意
如果当前请求的请求地址满足请求映射的value属性,但是请求方式不满足method属性,则浏览器报错405:Request Method 'POST' not supported,请求方式不被支持。
派生注解
1、对于处理指定请求方式的控制器方法,SpringMVC中提供了@RequestMapping的派生注解:
处理get请求的映射 --> @GetMapping
处理post请求的映射 --> @PostMapping
处理put请求的映射 --> @PutMapping
处理delete请求的映射 --> @DeleteMapping
派生注解的作用
使用这些派生注解,就不用去指定请求方法了。
例如@GetMapping("/test")相当于@RequestMapping(value="/test", method=RequestMethod.GET)
示例
@GetMapping("/get") public String getMapping(){ return "get"; }
意思是,匹配 请求名称为get,请求方法为get的请求。
2、常用的请求方式有get、post、put、delete
get:查询
post:修改
put:增加
delete:删除
但目前浏览器只支持get和post,如何发送其他类型的请求?
若在form表单提交时,为method设置了其他请求方式的字符串(put或delete),则会按照默认的请求方式get处理。
若要发送put和delete请求,需要通过Spring提供的过滤器HiddenHttpMethodFilter。是restful的内容
5、params属性(了解)
阅读源码
String[] params() default {};
params是一个字符串类型的数组
params属性的作用
@RequestMapping注解的params属性通过请求的请求参数 匹配请求映射
它是一个字符串类型的数组,可以通过四种表达式设置请求参数和请求映射的匹配关系:
"param":要求请求映射所匹配的请求必须携带param请求参数
"!param":要求请求映射所匹配的请求必须不能携带param请求参数
"param=value":要求请求映射所匹配的请求必须携带param请求参数且param=value
"param!=value":要求请求映射所匹配的请求必须携带param请求参数但是param!=value
如果设置了多个参数匹配,则必须同时满足,请求才能映射到。
示例
@RequestMapping( value = "/test" ,params = {"username","password!=123456"} ) public String testRequestMapping(){ return "success"; }
意思是匹配 请求名称为test,请求参数包括username,且请求参数中password不等于123456的请求
注意
若当前请求满足@RequestMapping注解的value和method属性,但是不满足params属性,此时页面会报错400:Parameter conditions "username, password!=123456" not met for actual request parameters: username={admin}, password={123456}
6、headers属性(了解)
阅读源码
String[] headers() default {};
headers属性的作用
@RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射
性是一个字符串类型的数组,可以通过四种表达式设置请求头信息和请求映射的匹配关系
"header":要求请求映射所匹配的请求必须携带header请求头信息
"!header":要求请求映射所匹配的请求必须不能携带header请求头信息
"header=value":要求请求映射所匹配的请求必须携带header请求头信息且header=value
"header!=value":要求请求映射所匹配的请求必须携带header请求头信息且header!=value
注意
若当前请求满足@RequestMapping注解的value和method属性,但是不满足headers属性,此时页面 显示404错误,即资源未找到