2、SpringMVC之@RequestMapping

SpringMVC之@RequestMapping注解

介绍

@RequestMapping 是 Spring Web 应用开发框架中的注解，在 Spring MVC 中，@RequestMapping 注解是一个非常核心的组件，用于将 Web 请求映射到指定的处理方法，同时还支持各种参数匹配、路径模式、HTTP 方法限制等特性。@RequestMapping 注解在 Spring MVC 中的广泛应用，体现了 Spring 框架强大的注解机制，也成为了 Spring MVC 的一大特色和优势。

1、注解功能

@RequestMapping这个注解用来建立页面请求和处理请求的控制器建立映射关系。

2、@RequestMapping注解的实现方式

本小节举例参考下方java代码。

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

RequestMappingController类上加了@RequestMapping（"/test"）注解，请求testRequestMapping方法时，请求路径设置为：

.../test/testRequestMapping

若类上没有注释，只在testRequestMapping方法上注释，请求路径为：

.../testRequestMapping

@RequestMapping标识一个方法：设置映射请求请求路径的具体信息。上述没有在类上注释相同

@Controller
@RequestMapping("/test")
public class RequestMappingController {

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

}

3、@RequestMapping注解的value属性

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

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

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

<a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMapping</a><br>
<a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a><br>

@RequestMapping(
        value = {"/testRequestMapping", "/test"},
    // 	method = {RequestMethod.GET, RequestMethod.POST},
    //	params = {"username","password!=123456"},
    //	headers = "X-Custom-Header=true"
)
public String testRequestMapping(){
    return "success";
}

4、@RequestMapping注解的method属性

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

@RequestMapping注解的method属性是一个RequestMethod类型的数组，表示该请求映射能够匹配多种请求方式的请求

若当前请求的请求地址满足请求映射的value属性，但是请求方式不满足method属性，则浏览器报错405：Request method ‘POST’ not supported

<a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a><br>
<form th:action="@{/test}" method="post">
    <input type="submit">
</form>

@RequestMapping(
        value = {"/testRequestMapping", "/test"},
     	method = {RequestMethod.GET, RequestMethod.POST},
    //	params = {"username","password!=123456"},
    //	headers = "X-Custom-Header=true"
)
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。

---

5、@RequestMapping注解的params属性

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

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

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

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

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

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

<a th:href="@{/test(username='admin',password=123456)">测试@RequestMapping的params属性-->/test</a><br>

@RequestMapping(
        value = {"/testRequestMapping", "/test"},
     	method = {RequestMethod.GET, RequestMethod.POST},
    	params = {"username","password!=123456"},
    //	headers = "X-Custom-Header=true"
)
public String testRequestMapping(){
    return "success";
}

6、@RequestMapping注解的headers属性

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

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

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

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

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

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

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

@RequestMapping(
        value = {"/testRequestMapping", "/test"},
     	method = {RequestMethod.GET, RequestMethod.POST},
    	params = {"username","password!=123456"},
    	headers = "X-Custom-Header=true"
)
public String testRequestMapping(){
    return "success";
}

上述代码，只有HTTP请求头中包含"X-Custom-Header: true"这个键值对时，才会映射到getUsers方法进行处理。

SpringMVC支持ant风格的路径

？：表示任意的单个字符

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

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

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

举例：

1. "/user" 匹配URL为/user的请求，不匹配/user/1。
2. "/u？er" 匹配URL为/user的请求，？代表任意一个字符。
3. "/user/*" 匹配URL为/user/1、/user/2等请求。
4. "/user/**" 匹配URL为/user/1、/user/2等以/user开头的所有请求。
5. "/*/delete" 匹配所有以 / 开头且以 /delete结尾的 URL，如 /abc/delete。
6. "/*/**/delete" 匹配所有以 / 开头且在任意一级目录下以 /delete 结尾的 URL，如 /abc/efg/delete。

重点->SpringMVC支持路径中的占位符

原始方式：/deleteUser?id=1

rest方式：/deleteUser/1

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

<a th:href="@{/testRest/1/admin}">测试路径中的占位符-->/testRest</a><br>

@RequestMapping("/testRest/{id}/{username}")
public String testRest(@PathVariable("id") String id, @PathVariable("username") String username){
    System.out.println("id:"+id+",username:"+username);
    return "success";
}
//最终输出的内容为-->id:1,username:admin

---

补充

@PathVariable("id") String id的形参必须和注解传入参数名称相同，不相同则会报错。

@GetMapping("/users/{id}")
public String getUserById(@PathVariable("id") long userId, Model model) {
    // ...
}

这个例子的意思是，从路径中提取一个名为 id 的参数，并根据方法中的 userId 参数进行赋值。如果这里的参数名和路径变量名不匹配，则 Spring MVC 会提示无法匹配参数值。

解决办法：

为了确保正确的参数值被传递，我们需要保持方法参数名和路径变量名一致（或者通过指定 value 属性来精确匹配名称）。当然，这个规则只是一种最佳实践，并不是绝对必要的约束。如果您有特殊情况需要使用不同的参数名，可以通过增加 @RequestParam 注解来指定名称，例如：

@GetMapping("/users/{id}")
public String getUserById(@PathVariable("id") long userId, @RequestParam("name") String userName, Model model) {
    // ...
}

这个例子中，我们通过增加 @RequestParam("name") 注解，将 HTTP 请求中的 name 参数转化为方法的 userName 参数，实现了参数名的统一。

---