@ModelAttribute注解详解

左手的ㄟ右手 2024-04-17 06:07 87阅读 0赞

### 1.@ModelAttribute在方法上注释 ###

#### 被@ModelAttribute注解的方法会在所有的controller方法执行之前执行 ####

@RequestMapping("say")
        public String sayHello(){ 
            System.out.println("sayHello");
            System.out.println(name);
            return "success";
        }
    
        @ModelAttribute
        public void showUser(String name){ 
            System.out.println("showUser");
        }

这里面的返回值是void这里访问/say时会先执行showUser方法

#### 当返回值是String ####

@RequestMapping("say")
        public String sayHello(String name){ 
            System.out.println("sayHello");
            System.out.println(name);
            return "success";
        }
    
        @ModelAttribute
        public String showUser(String name){ 
            System.out.println("showUser");
            return name;
        }

这里会将返回值String传回给访问路径的方法，作为参数。

#### 当返回值是引用类型，@ModelAttribute(value="")时 ####

使用@ModelAttribute注释的value属性，来指定model属性的名称。model属性对象就是方法的返回值。它无须要特定的参数。

@ModelAttribute(value = "username")
        public String showUser(Model model,String name){ 
            System.out.println("showUser");
            return name;
        }

这个与下面是相同的

@ModelAttribute
        public void showUser(Model model,String name){ 
            model.addAttribute("username",name);
            System.out.println("showUser");
        }

#### @ModelAttribute和@RequestMapping同时注释一个方法 ####

这里面返回的不是一个视图，而是一个model，通过访问hello，返回一个key=username，value=name。

@RequestMapping("hello")
        @ModelAttribute("username")
        public String showUser(String name){ 
            System.out.println("showUser");
            return name;
        }

### 1.@ModelAttribute在方法的参数上 ###

#### 从model中获取值 ####

@Controller 
     public class HelloWorldController {  
         @ModelAttribute("user") 
          public User addAccount() {  
              return new User("jz","123"); 
           } 
      
          @RequestMapping(value = "/helloWorld") 
          public String helloWorld(@ModelAttribute("user") User user) {  
                system.out.println(user);
                return "helloWorld"; 
             } 
      }

在这个例子里，@ModelAttribute(“user”) User user注释方法参数，参数user的值来源于addAccount()方法中的model属性。此时如果方法体没有标注@SessionAttributes(“user”)，那么scope为request，如果标注了，那么scope为session。下面的就是session下的：

@Controller 
    @SessionAttributes(value = "user")
     public class HelloWorldController {  
         @ModelAttribute("user") 
          public User addAccount() {  
              return new User("jz","123"); 
           } 
      
          @RequestMapping(value = "/helloWorld") 
          public String helloWorld(@ModelAttribute("user") User user) {  
                system.out.println(user);
                return "helloWorld"; 
             } 
      }

#### 从Form表单或URL参数中获取（实际上，不做此注释也能拿到user对象） ####

这里用于接收参数，其实不写注解也可以。  
①绑定请求参数到命令对象：放在功能处理方法的入参上时，用于将多个请求参数绑定到一个命令对象，从而简化绑定流程，而且自动暴露为模型数据用于视图页面展示时使用。

@Controller 
     public class HelloWorldController {  
         @RequestMapping(value = "/helloWorld") 
         public String helloWorld(@ModelAttribute User user) {  
             return "helloWorld"; 
          } 
     }

此处多了一个注解@ModelAttribute(“user”)，它的作用是将该绑定的命令对象以“user”为名称添加到模型对象中供视图页面展示使用。我们此时可以在视图页面使用$\{user.username\}来获取绑定的命令对象的属性。

@Controller 
     public class HelloWorldController {  
         @RequestMapping(value = "/helloWorld") 
         public String helloWorld(@ModelAttribute("account")  User user) {  
             return "helloWorld"; 
          } 
     }