[Spring MVC] - ModelAttribute使用.docx

在Spring MVC里，@ModelAttribute通常使用在Controller方法的参数注解中，用于解释model entity，但同时，也可以放在方法注解里。 如果把@ModelAttribute放在方法的注解上时，代表的是： 该Controller的所有方法在调用前，先执行此@ModelAttribute方法 。 比如我们有一个Controller：TestController 在Spring MVC框架中，`@ModelAttribute`是一个非常重要的注解，它主要用于数据绑定和模型对象的处理。在本文中，我们将深入探讨`@ModelAttribute`的使用及其在控制器（Controller）中的作用。 `@ModelAttribute`最常见的用法是作为控制器方法参数的注解。当我们在一个控制器方法的参数上使用`@ModelAttribute`时，Spring MVC会尝试从请求中获取与注解参数名相匹配的数据，例如表单提交的数据或URL路径变量。然后，这些数据会被用来初始化或者更新一个模型实体对象。例如，如果我们有一个`Account`类，Spring会尝试将请求中的数据映射到`Account`对象，使得我们可以在后续的业务逻辑中使用。 ```java @RequestMapping(value="login", method=RequestMethod.POST) public ModelAndView login(@ModelAttribute @Valid Account account, BindingResult result) { // ... } ``` 在这个例子中，`@ModelAttribute`与`@Valid`一起使用，对提交的`Account`对象进行数据校验。 然而，`@ModelAttribute`并不仅仅局限于参数注解。当它被放在控制器类的方法上时，这个方法会在控制器的任何其他处理方法执行之前运行。例如： ```java @Controller @RequestMapping(value="test") public class TestController { @ModelAttribute public void preRun() { System.out.println("Test Pre-Run"); } // 其他方法... } ``` 这里的`preRun()`方法会在所有`TestController`中的处理方法之前被调用，这可以用于执行一些全局性的操作，如日志记录、权限验证或者初始化通用的数据。 此外，我们还可以利用`@ModelAttribute`将数据添加到模型（Model），使其可以在视图（View）中使用。下面是一个示例，展示如何创建一个包含列表的模型对象： ```java @Controller @RequestMapping("/example") public class ExampleController { @RequestMapping(method = RequestMethod.GET) public String example(@ModelAttribute("myList") List<String> myList) { if (myList == null) { myList = new ArrayList<>(); myList.add("Item 1"); myList.add("Item 2"); } return "exampleView"; } } ``` 在这个例子中，`myList`模型属性将在视图渲染时可用，我们可以直接在JSP或Thymeleaf模板中引用它。 另外，`@ModelAttribute`可以与其他注解结合，实现更复杂的功能。例如，可以结合`@SessionAttributes`注解来实现会话级别的模型数据共享。这在处理多步表单或者需要跨多个请求维护状态的情况下非常有用。 像在`BaseController`中所示，`@ModelAttribute`还可以用于设置`HttpServletRequest`、`HttpServletResponse`和`HttpSession`的实例，这样可以在控制器方法中方便地访问HTTP请求和响应的相关信息。 总结起来，`@ModelAttribute`在Spring MVC中扮演了多种角色，包括数据绑定、控制器预处理方法、模型数据的创建以及HTTP上下文的设置。理解并灵活运用`@ModelAttribute`可以极大地提高我们的Spring MVC应用程序的效率和可维护性。