SpringMVC常用注解

# 70.SpringMVC常用注解

接下来我们讲解下常用的、重要的注解，每个注解都有自己的功能。　　‍

‍

# RequestParam

作用：把请求中指定名称的参数给控制器中的形参赋值。

属性：

value：请求参数中的名称。
required：请求参数中是否必须提供此参数。默认值：true，表示必须提供，如果不提供将报错。

‍

之前我们的前端参数名，必须和Java方法的参数名一样，不然会绑定失败；

<a href="param/testParam?username=peterjxl">请求参数绑定</a>

@RequestMapping(path = "/testParam")
public String testParam(String username) {
    System.out.println("testParam");
    System.out.println("username: " + username);
    return "success";
}

1
2
3
4
5
6

‍

而有时候我们会遇到不一样的情况，此时就可以用该注解了。我们新建一个anno.jsp，加一个超链接：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>演示SpringMVC的常用注解</title>
    </head>
    <body>
      <a href="anno/testRequestParam?name=张三">测试@RequestParam</a>  <br/>
    </body>
</html>

1
2
3
4
5
6
7
8
9

‍

新建控制器类：

@Controller
@RequestMapping(path = "/anno")
public class AnnoController {

    @RequestMapping("/testRequestParam")
    public String testRequestParam(@RequestParam(name = "name", required = true)String username) {
        System.out.println("testRequestParam");
        System.out.println(username);
        return "success";
    }
}

1
2
3
4
5
6
7
8
9
10
11

@RequestParam是作用在方法参数上的，我们重启并测试，可以看到前端传参是name，但是方法名username也能成功复制。

‍

# RequestBody

作用：用于获取请求体内容。直接使用得到是键值对结构的数据（key=value&key=value...）。get 请求方式不适用，因为get没有请求体。

属性：required表示是否必须有请求体。默认值是true。当取值为 true 时，get 请求方式会报错。如果取值为 false，get 请求得到是 null。

我们新增一个表单：

<form action="anno/testRequestBody" method="post">
    User姓名：<input type="text" name="username" /> <br/>
    User年龄：<input type="text" name="age" /> <br/>
    <input type="submit" value="提交" />
</form>

1
2
3
4
5

‍

新增一个方法：

@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String body) {
    System.out.println("testRequestBody");
    System.out.println(body);
    return "success";
}

1
2
3
4
5
6

‍

我们随便输入一些数据，然后提交

‍

可以看到后台打印的内容：

username=hehe&age=20

‍

我们后续讲到异步和JSON的时候，会再次讲到这个

‍

# PathVaribale

作用：用于绑定 url 中的占位符。例如：请求 url 中 /delete/{id}，这个{id}就是 url 占位符。url 支持占位符是 Spring3.0 之后加入的，是 SpringMVC 支持 rest 风格 URL 的一个重要标志。

属性：value用于指定 url 中占位符名称。required指定是否必须提供占位符。

也就是前端可以直接传一个id值（不用post方式里加上，或者get方式里指定参数），后台可以直接获取到值。我们来讲解下rest风格是什么：

‍

# REST 风格 URL

什么是 rest：REST（英文：Representational State Transfer，简称 REST）描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，他是 HTTP 规范的主要编写者之一。

在目前主流的三种 Web 服务交互方案中，REST 相比于 SOAP（Simple Object Access protocol，简单对象访问协议）以及 XML-RPC 更加简单明了，无论是对 URL 的处理还是对 Payload 的编码，REST 都倾向于用更加简单轻量的方法设计和实现。值得注意的是 REST 并没有一个明确的标准，而更像是一种设计的风格。

它本身并没有什么实用性，其核心价值在于如何设计出符合 REST 风格的网络接口。

restful 的优点：它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。

restful 的特性：

资源（Resources）：网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的存在。可以用一个 URI（统一资源定位符）指向它，每种资源对应一个特定的 URI 。要获取这个资源，访问它的 URI 就可以，因此 URI 即为每一个资源的独一无二的识别符。
表现层（Representation）：把资源具体呈现出来的形式，叫做它的表现层（Representation）。比如，文本可以用 txt 格式表现，也可以用 HTML 格式、XML 格式、JSON 格式表现，甚至可以采用二进制格式。
状态转化（State Transfer）：每发出一个请求，就代表了客户端和服务器的一次交互过程。HTTP 协议，是一个无状态协议，即所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生“状态转化”（State Transfer）。而这种转化是建立在表现层之上的，所以就是 “表现层状态转化”。具体说，就是 HTTP 协议里面，四个表示操作方式的动词：GET 、POST 、PUT、DELETE。它们分别对应四种基本操作：GET 用来获取资源，POST 用来新建资源，PUT 用来更新资源，DELETE 用来删除资源。

restful 的示例：

/account/1 HTTP GET ：得到 id = 1 的 account

/account/1 HTTP DELETE：删除 id = 1 的 account

/account/1 HTTP PUT：更新 id = 1 的 account

/account HTTP POST：新增 account

‍

# 实践

新增控制器方法：

@RequestMapping("/testPathVariable/{sid}")
public String testPathVariable(@PathVariable(name = "sid") String id) {
    System.out.println("testPathVariable");
    System.out.println(id);
    return "success";
}

1
2
3
4
5
6

‍

新增超链接：

<a href="anno/testPathVariable/10">测试@PathVariable</a> <br/>

‍

重启并测试，可以看到能输出10.

‍

# 基于 HiddentHttpMethodFilter 的示例

了解即可，使用起来比较麻烦，后续有更简便的方法

‍

作用：由于浏览器 form 表单只支持 GET 与 POST 请求，而 DELETE、PUT 等 method 并不支持，Spring3.0 添加了一个过滤器，可以将浏览器请求改为指定的请求方式，发送给我们的控制器方法，使得支持 GET、POST、PUT与 DELETE 请求。

使用方法：

在 web.xml 中配置该过滤器。
请求方式必须使用 post 请求。
按照要求提供_method 请求参数，该参数的取值就是我们需要的请求方式（PUT、DELETE等）。

其原理在于，要求前端传一个_method参数，该参数就是真正的请求方式；然后filter读取这个值，然后将该HTTP请求转为该方式的请求，然后才是handler处理请求

我们表单需要加上一个隐藏的 _method参数，例如（第3行，第10行）：

<!-- 删除 -->
<form action="springmvc/testRestDELETE/1" method="post">
    <input type="hidden" name="_method" value="DELETE">
    <input type="submit" value="删除">
</form>

<!-- 更新 -->
<form action="springmvc/testRestPUT/1" method="post">
    用户名称：<input type="text" name="username"><br/>
    <input type="hidden" name="_method" value="PUT">
    <input type="submit" value="更新">
</form>

1
2
3
4
5
6
7
8
9
10
11
12

‍

仍然控制器中指定方法

@RequestMapping(value="/testRestDELETE/{id}",method=RequestMethod.DELETE)
public String testRestfulURLDELETE(@PathVariable("id")Integer id){
    System.out.println("rest delete "+id);
    return "success";
}

@RequestMapping(value="/testRestPUT/{id}",method=RequestMethod.PUT)
public String testRestfulURLPUT(@PathVariable("id")Integer id,User user){
    System.out.println("rest put "+id+","+user);
    return "success";
}

1
2
3
4
5
6
7
8
9
10
11

‍

# RequestHeader

作用：用于获取请求消息头。

属性：value提供消息头名称，required：是否必须有此消息头

注：在实际开发中一般不怎么用。

‍

新增超链接：

  <a href="anno/testRequestHeader">测试@RequestHeader</a> <br/>

‍

新增控制器方法：

@RequestMapping("/testRequestHeader")
public String testRequestHeader(@RequestHeader(value = "Accept") String header) {
    System.out.println("testPathVariable");
    System.out.println(header);
    return "success";
}

1
2
3
4
5
6

‍

运行结果：

text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7

1
2

‍

# CookieValue

作用：用于把指定 cookie 名称的值传入控制器方法参数。

属性：
value：指定 cookie 的名称。
required：是否必须有此 cookie。

注：在实际开发中一般不怎么用。

‍

新增控制器方法：

@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) {
    System.out.println("testCookieValue");
    System.out.println(cookieValue);
    return "success";
}

1
2
3
4
5
6

‍

新增超链接：

<a href="anno/testCookieValue">测试@CookieValue</a> <br/>

‍

重启，并测试，可以看到能正常打印Cookie。

‍

# ModelAttribute

作用：

该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可
以修饰有具体返回值的方法。
出现在参数上，获取指定的数据给参数赋值。

‍

属性：value用于获取数据的 key。key 可以是 POJO 的属性名称，也可以是 map 结构的 key。

应用场景：当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。

例如：我们在编辑一个用户时，用户有一个密码字段，该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

‍

演示：新增表单

<form action="anno/testModelAttribute" method="post">
    User2姓名：<input type="text" name="uname" /> <br/>
    User2年龄：<input type="text" name="age" /> <br/>
    <input type="submit" value="提交" />
</form>

1
2
3
4
5

‍

新增两个方法：

@RequestMapping("/testModelAttribute")
public String testModelAttribute(User2 user) {
    System.out.println("testModelAttribute");
    System.out.println(user);
    return "success";
}

@ModelAttribute
public User2 showUser(String uname) {
    System.out.println("showUser");
    // 通过用户名查询数据库（模拟）
    User2 user = new User2();
    user.setUname(uname);
    user.setAge(20);
    user.setDate(new Date());
    return user;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

‍

运行结果：我们前端表单只输入了用户的姓名和年龄，日期没有输入，但是能正常赋值日期。

showUser
testModelAttribute
User2{uname='peter', age=20, date=Mon May 08 07:58:47 CST 2023}

1
2
3

‍

我们的showUser方法是有返回值的，但是也可以没有返回值，我们需要将信息存到map集合当中：

@ModelAttribute
public void showUser(String uname, Map<String, User2> map) {
    System.out.println("showUser");
    // 通过用户名查询数据库（模拟）
    User2 user = new User2();
    user.setUname(uname);
    user.setAge(20);
    user.setDate(new Date());
    map.put("abc", user);
}

1
2
3
4
5
6
7
8
9
10

‍

这里我们将用户信息存储到一个map集合当中，key是abc，值是对象。然后控制器方法要从 map集合中取出数据：

@RequestMapping("/testModelAttribute")
public String testModelAttribute(@ModelAttribute("abc") User2 user) {
    System.out.println("testModelAttribute");
    System.out.println(user);
    return "success";
}

1
2
3
4
5
6

‍

重启，测试，可以看到测试结果是一样的

‍

# SessionAttribute

‍

# 存储数据到request域对象

有时候我们想要共享数据，怎么做呢？我们先以将数据存储到request域对象中为例，虽然我们可以在方法参数里使用原生的Servlet API，但这样耦合度太高了；

为此SpringMVC提供了一个接口：Model，其有一个子类ModelMao是继承LinkHashMap的，当我们往里面存放数据的时候，就会存放到request域对象中。新增超链接：

<a href="anno/testSessionAttribute">测试@SessionAttribute</a> <br/>

‍

@RequestMapping("/testSessionAttribute")
public String getSessionAttribute(Model model) {
    System.out.println("getSessionAttribute");
    model.addAttribute("msg", "王小美");
    return "success3";
}

1
2
3
4
5
6

‍

新增success3.jsp：注意第一行末尾开启了EL表达式，然后第8行打印了下对象

<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
      <h1>testSessionAttribute</h1>
        ${requestScope}
    </body>
</html>

1
2
3
4
5
6
7
8
9
10

可以看到有值：

‍

# 存储到Session中

SpringMVC还提供了一个新的注解：@SessionAttribute，也能实现共享数据，该注解只能作用在类上。

作用：用于多次执行控制器方法间的参数共享。

属性：

value：用于指定存入的属性名称

type：用于指定存入的数据类型。

‍

我们做个小案例演示下：先在类上加一个注解，value写上msg，表明存储这个值到Session中：

@Controller
@RequestMapping(path = "/anno")
@SessionAttributes(value = {"msg"}) // 把msg=王小美存入到session域对象中
public class AnnoController {

1
2
3
4

‍

修改success3.jsp：

<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
      <h1>testSessionAttribute</h1>
        ${msg}
        ${sessionScope}
    </body>
</html>

1
2
3
4
5
6
7
8
9
10
11

‍

测试：可以看到能正常存储

‍

除此之外，其他控制器方法也能获取到这个值。我们新增一个方法：

@RequestMapping("/testGetSessionAttribute")
public String testGetSessionAttribute(ModelMap model) {
    System.out.println("testGetSessionAttribute");
    String msg = (String) model.get("msg");
    System.out.println(msg);
    return "success3";
}

1
2
3
4
5
6
7

‍

新增一个超链接：

<a href="anno/testGetSessionAttribute">测试获取@SessionAttribute</a> <br/>

‍

重启，然后注意我们先点击设置msg的那个超链接，然后再点击获取msg的超链接，不然会获取不到值。

‍

# 删除属性

‍

新增控制器方法：

@RequestMapping("/testDelSessionAttribute")
public String testDeleteSessionAttribute(SessionStatus status) {
    System.out.println("testDeleteSessionAttribute");
    status.setComplete();   // 删除session域对象中的msg
    return "success3";
}

1
2
3
4
5
6

‍

新增超链接：

<a href="anno/testDelSessionAttribute">测试删除@SessionAttribute</a> <br/>

‍

重启，先点击设置msg的超链接，然后点击查看msg的超链接；

点击删除，再测试下能否看到。可以看到是没有的，并且控制台打印了null，表示获取不到

‍

# 源码

本项目已将源码上传到GitHub (opens new window)和Gitee (opens new window)上。并且创建了分支demo6，读者可以通过切换分支来查看本文的示例代码。

在GitHub上编辑此页

上次更新: 2023/7/10 22:29:12

← 使用原生的Servlet-API 响应数据和结果视图→