Spring @RequestMapping 注解使用技巧

左手的ㄟ右手 2023-08-17 17:13 116阅读 0赞

# Spring @RequestMapping 注解 #

@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。

在这篇文章中，你将会看到 @RequestMapping 注解在被用来进行 Spring MVC 控制器方法的映射可以如何发挥其多才多艺的功能的。

## 一、Request Mapping 基础用法 ##

要配置 Web 请求的映射，就需要你用上 @RequestMapping 注解。  
@RequestMapping 注解可以在控制器类的级别和/或其中的方法的级别上使用。  
在类的级别上的注解会将一个特定请求或者请求模式映射到一个控制器之上。之后你还可以另外添加方法级别的注解来进一步指定到处理方法的映射关系。

下面是一个同时在类和方法上应用了 @RequestMapping 注解的示例：  
![在这里插入图片描述][format_png]  
如上述代码所示，到 /home 的请求会由 get() 方法来处理，而到 /home/index 的请求会由 index() 来处理。

## 二、@RequestMapping 来处理多个 URI ##

你可以将多个请求映射到一个方法上去，只需要添加一个带有请求路径值列表的 @RequestMapping 注解就行了。  
![在这里插入图片描述][format_png 1]  
如你在这段代码中所看到的，@RequestMapping 支持统配符以及ANT风格的路径。前面这段代码中，如下的这些 URL 都会由 indexMultipleMapping() 来处理：

localhost:8080/home

localhost:8080/home/

localhost:8080/home/page

localhost:8080/home/pageabc

localhost:8080/home/view/

localhost:8080/home/view/view

## 三、带有 @RequestParam 的@RequestMapping ##

@RequestParam 注解配合 @RequestMapping 一起使用，可以将请求的参数同处理方法的参数绑定在一起。

@RequestParam 注解使用的时候可以有一个值，也可以没有值。这个值指定了需要被映射到处理方法参数的请求参数, 代码如下所示：  
![在这里插入图片描述][format_png 2]  
在代码的第6行，id 这个请求参数被映射到了 thegetIdByValue() 这个处理方法的参数 personId 上。

如果请求参数和处理方法参数的名称一样的话，@RequestParam 注解的 value 这个参数就可省掉了, 如代码的第11行所示。

@RequestParam 注解的 required 这个参数定义了参数值是否是必须要传的。  
![在这里插入图片描述][format_png 3]  
在这段代码中，因为 required 被指定为 false，所以 getName() 处理方法对于如下两个 URL 都会进行处理：

/home/name?person=xyz

/home/name

@RequestParam 的 defaultValue 取值就是用来给取值为空的请求参数提供一个默认值的。  
![在这里插入图片描述][format_png 4]

[format_png]: /images/20230808/b7c3f98021da4d4a99782b59d70a80df.png
[format_png 1]: /images/20230808/19bb7c8d722a423d8353c7746aaea8cc.png
[format_png 2]: /images/20230808/311fed9356f443d9bf043f727af7c059.png
[format_png 3]: /images/20230808/fb3aea8a70944942940d74a19dda4f60.png
[format_png 4]: /images/20230808/873b8c946733478d81a00b073b3d78de.png