526互联

spring-mvc系列：详解@RequestMapping注解（value、method、params、header等）

发布时间 2023-08-03 23:39:15作者: IT技术派

目录

一、@RequestMapping注解的功能

从注解名称上我们可以看到，@RequestMapping注解的作用就是将请求和处理请求的控制器方法关联起来，建立映射关系。

SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。

二、@RequestMapping注解的位置

@RequestMapping标识一个类：设置映射请求的请求路径的初始信息

@RequestMapping标识一个方法：设置映射请求请求路径的具体信息

package com.mcode.api.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * ClassName: RequestMappingController
 * Package: com.mcode.api.controller
 * Description:
 *
 * @Author: robin
 * @Create: 2023/8/3 - 10:32 PM
 * @Version: v1.0
 */
@Controller
@RequestMapping("/test")
public class RequestMappingController {

    //此时请求映射所映射的请求的请求路径为：/test/testRequestMapping 
    @RequestMapping("/testRequestMapping")
    public String testRequestMapping() {
        return "success";
    }
}

三、@RequestMapping注解的value属性

@RequestMapping注解的value属性通过请求的请求地址匹配请求映射

@RequestMapping注解的value属性是一个字符串类型的数组，表示该请求映射能够匹配多个请求地址所对应的请求

@RequestMapping注解的value属性必须设置，至少通过请求地址匹配请求映射

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
        a{
          display: block;
        }
    </style>
</head>
<body>
   <a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMapping</a>
   <a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a>
</body>
</html>

package com.mcode.api.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * ClassName: RequestMappingController
 * Package: com.mcode.api.controller
 * Description:
 *
 * @Author: robin
 * @Create: 2023/8/3 - 10:32 PM
 * @Version: v1.0
 */
@Controller
//@RequestMapping("/test")
public class RequestMappingController {

    @RequestMapping(value = {"test", "testRequestMapping"})
    public String testRequestMapping() {
        return "success";
    }
}

四、@RequestMapping注解的method属性

@RequestMapping注解的method属性通过请求的请求方式（get或post）匹配请求映射

@RequestMapping注解的method属性是一个RequestMethod类型的数组，表示该请求映射能够匹配多种请求方式的请求，若当前请求的请求地址满足请求映射的value属性，但是请求方式不满足method属性，则浏览器报错

405：Request method 'POST' not supported

image

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
        a{
          display: block;
        }
    </style>
</head>
<body>
   <a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMapping</a>
   <a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a>
   <form th:action="@{/test}" method="post">
       <input type="submit" value="提交">
   </form>
</body>
</html>

package com.mcode.api.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * ClassName: RequestMappingController
 * Package: com.mcode.api.controller
 * Description:
 *
 * @Author: robin
 * @Create: 2023/8/3 - 10:32 PM
 * @Version: v1.0
 */
@Controller
//@RequestMapping("/test")
public class RequestMappingController {

    @RequestMapping(value = {"test", "testRequestMapping"},
            method = RequestMethod.GET)
    public String testRequestMapping() {
        return "success";
    }
}

注：

1、对于处理指定请求方式的控制器方法，SpringMVC中提供了@RequestMapping的派生注解

处理get请求的映射-->@GetMapping

处理post请求的映射-->@PostMapping

处理put请求的映射-->@PutMapping

处理delete请求的映射-->@DeleteMapping

2、常用的请求方式有get，post，put，delete

但是目前浏览器只支持get和post，若在form表单提交时，为method设置了其他请求方式的字符

串（put或delete），则按照默认的请求方式get处理

若要发送put和delete请求，则需要通过spring提供的过滤器HiddenHttpMethodFilter

五、@RequestMapping注解的params属性

@RequestMapping注解的params属性通过请求的请求参数匹配请求映射

@RequestMapping注解的params属性是一个字符串类型的数组，可以通过四种表达式设置请求参数和请求映射的匹配关系

"param"：要求请求映射所匹配的请求必须携带param请求参数

"!param"：要求请求映射所匹配的请求必须不能携带param请求参数

"param=value"：要求请求映射所匹配的请求必须携带param请求参数且param=value

"param!=value"：要求请求映射所匹配的请求必须携带param请求参数但是param!=value

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
        a{
          display: block;
        }
    </style>
</head>
<body>
   <a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMapping</a>
   <a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a>
   <form th:action="@{/test}" method="post">
       <input type="submit" value="提交">
   </form>
   <a th:href="@{/test(username='admin',password=123456)}">测试@RequestMapping的params属性-->/test</a><br>
</body>
</html>

package com.mcode.api.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * ClassName: RequestMappingController
 * Package: com.mcode.api.controller
 * Description:
 *
 * @Author: robin
 * @Create: 2023/8/3 - 10:32 PM
 * @Version: v1.0
 */
@Controller
//@RequestMapping("/test")
public class RequestMappingController {

    @RequestMapping(value = {"test", "testRequestMapping"},
            method = RequestMethod.GET,
            params = {"username", "password!=123456"})
    public String testRequestMapping() {
        return "success";
    }
}

注：

若当前请求满足@RequestMapping注解的value和method属性，但是不满足params属性，此时页面回报错400：

Parameter conditions "username, password!=123456" not met for actual

request parameters: username={admin}, password=

六、@RequestMapping注解的header属性

@RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射

@RequestMapping注解的headers属性是一个字符串类型的数组，可以通过四种表达式设置请求头信息和请求映射的匹配关系

"header"：要求请求映射所匹配的请求必须携带header请求头信息

"!header"：要求请求映射所匹配的请求必须不能携带header请求头信息

"header=value"：要求请求映射所匹配的请求必须携带header请求头信息且header=value

"header!=value"：要求请求映射所匹配的请求必须携带header请求头信息且header!=value

若当前请求满足@RequestMapping注解的value和method属性，但是不满足headers属性，此时页面显示404错误，即资源未找到

七、SpringMVC支持ant分格的路径

？：表示任意的单个字符

@RequestMapping(value = "/a?a/testAnt")

*：表示任意的0个或多个字符

@RequestMapping("/a*a/testAnt")

**：表示任意的一层或多层目录

@RequestMapping("/**/testAnt")

注意：在使用**时，只能使用/**/xxx的方式

八、SpringMVC支持路径中的占位符

原始方式：/deleteUser?id=1

rest方式：/deleteUser/1

SpringMVC路径中的占位符常用于RESTful风格中，当请求路径中将某些数据通过路径的方式传输到服务器中，就可以在相应的@RequestMapping注解的value属性中通过占位符{xxx}表示传输的数据，在通过@PathVariable注解，将占位符所表示的数据赋值给控制器方法的形参

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
        a{
          display: block;
        }
    </style>
</head>
<body>
   <a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMapping</a>
   <a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a>
   <form th:action="@{/test}" method="post">
       <input type="submit" value="提交">
   </form>
   <a th:href="@{/test(username='admin',password=123456)}">测试@RequestMapping的params属性-->/test</a><br>
   <a th:href="@{/testRest/1/admin}">测试路径中的占位符-->/testRest</a><br>
</body>
</html>

package com.mcode.api.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * ClassName: RequestMappingController
 * Package: com.mcode.api.controller
 * Description:
 *
 * @Author: robin
 * @Create: 2023/8/3 - 10:32 PM
 * @Version: v1.0
 */
@Controller
//@RequestMapping("/test")
public class RequestMappingController {
    @RequestMapping("/testRest/{id}/{username}")
    public String testRest(@PathVariable("id") String id, @PathVariable("username") String username) {
        System.out.println("id:" + id + ",username:" + username);
        return "success";
    }
}

image