在SpringBoot项目中这几个注解你们还用吗？-51CTO.COM

环境：SpringBoot3.3.0

1. 简介

在SpringBoot应用开发中，传统的请求属性处理方式如@ModelAttribute，@SessionAttribute，@RequestAttribute以及RedirectAttributes似乎用的越来越少了，但是在一些特定场景下它们发挥着不可或缺的作用尤其是当涉及到表单提交、会话状态管理和重定向属性传递时。

@ModelAttribute：主要用于绑定请求中的数据到方法参数或模型属性上，常用于处理表单提交，使得复杂的对象绑定变得简单直接。它允许你预处理传入的数据，或者初始化一个命令对象供表单使用。
@SessionAttribute：用于从HttpSession中存取属性，这对于存储非敏感的用户信息或临时数据非常有用，比如用户设置或购物车信息。
@RequestAttribute：处理单一请求上下文，允许你在控制器间通过HttpServletRequest传递自定义属性，适合传递那些不需要跨请求持久化的数据。
RedirectAttributes：是在执行重定向操作时用来传递闪存属性的利器，这些属性在重定向后的一次请求中可用，之后自动移除，非常适合于向用户展示操作成功或失败的消息，同时保持URL的干净。

接下来将详细接上上面几个注解及类的使用。

2. 实战案例

2.1 @ModelAttribute

该注解可用于方法参数及方法上；

用于方法参数

@GetMapping("/product/{cateId}/{id}")
public ProductDTO test(@ModelAttribute ProductDTO dto) {
  return dto ;
}

图片

首先，SpringMVC会自动将请求URI中的占位符数据绑定到当前ProductDTO对象上，这个绑定与@ModelAttribute注解没有关系。而这里注解的作用是将当前ProductDTO对象绑定到模型数据中，接下来如果你使用的thymeleaf则可以直接在页面中访问，如下示例：

@GetMapping("/product/{cateId}/{id}")
public String test(@ModelAttribute ProductDTO dto) {
  return "modelattribute" ;
}

在页面中直接访问ProductDTO；

<div th:if="${productDTO}">
  <ul>
    <li>cateId: <a th:text="${productDTO.cateId}"></a></li>
    <li>id: <a th:text="${productDTO.id}"></a></li>
  </ul>
</div>

页面显示

图片

在上面你看到了，默认访问的key是当前类型的首字母改为小写，我们可以通过配置属性修改默认key

public String test(@ModelAttribute("dto") ProductDTO dto)

这样在页面中访问的key将是：dto。

用于方法

@GetMapping("/product/{cateId}/{id}")
public String test() {
  return "modelattribute" ;
}
@ModelAttribute("dto")
public ProductDTO dto(ProductDTO dto) {
  System.out.println("dto....") ;
  return dto ;
}

将注解用于方法上后，当前的Controller中的所有接口都会先执行该方法将请求中的参数信息绑定到ProductDTO对象中，最后将该dto绑定到模型数据上。通过上面的配置你在页面上一样也可以访问该对象数据。

2.2 @SessionAttribute

该注解只能用于方法参数上。

该注解的作用用于读取session中的数据到当前的参数中，如下示例：

@GetMapping("/user")
@ResponseBody
public User user(@SessionAttribute("user") User user) {
  return user ;
}
// 模拟登录后将User对象存入Session中
@GetMapping("/login")
@ResponseBody
public String login(HttpSession session) {
  session.setAttribute("user", new User(666L, "Admin")) ;
  return "login success" ;
}

这里会读取Session中key=user的数据到当前User对象中，你需要先登录，然后再访问/user接口。

如果session中没有user，那么程序将会报错

图片

错误提示，session对象中没有user属性。通过如下方式设置不是必须的；

public User user(@SessionAttribute(value = "user", required = false) User user)

也可以将参数设置为Optional；

public User user(@SessionAttribute("user") Optional<User> user)

通过上面2中方式设置，在Session中不存在对应的属性时也不会报错。

注：还有一个@SessionAttributes注解，该注解可以用于类上。

2.3 @RequestAttribute

该注解同样只能用于方法参数上。

与 @SessionAttribute 类似，你也可以使用 @RequestAttribute 注解来访问先前创建的请求属性（例如，由 Servlet Filter或 HandlerInterceptor 创建的属性），如下示例：

先定义一个Filter，该Filter作用是向Request中设置值；

@Component
public class UserFilter extends OncePerRequestFilter {


  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
      throws ServletException, IOException {
    request.setAttribute("user", new User(888L, "Guest")) ;
    filterChain.doFilter(request, response) ;
  }
}

接下来在Controller中通过@RequestAttribute访问user属性。

@GetMapping("/user")
@ResponseBody
public User user(@RequestAttribute("user") Optional<User> user) {
  return user.orElse(new User()) ;
}

图片

与@SessionAttribute一样，参数可以通过Optional设置不是必须的。

2.4 RedirectAttributes

当页面通过redirect进行跳转时，可以通过该类定义在接口方法参数中，将数据保存到该对象中后，你就可以在调整到的页面中使用配置的属性了，如下示例：

@GetMapping("")
public String index(RedirectAttributes ra) {
  // 将你需要的数据存入该对象中
  ra.addFlashAttribute("message", "hello") ;
  // redirect其它页面
  return "redirect:/page/tm" ;
}
@GetMapping("tm")
public String tm(RedirectAttributes ra) {
  return "test" ;
}

test.html页面如下：

<body>
  <h1>Test Page</h1>
  <div th:if="${message}">
    <h2 th:text="${message}" />
  </div>
</body>

访问上面的/page，将redirec到最终的test.html页面；

图片

redirect过来后我们可以访问到配置的数据。