SpringMVC（一）

淡淡的烟草味﹌ 2022-02-16 09:12 253阅读 0赞

*  一、基本概念
    
     *  1.1、三层架构
     *  1.2、MVC
 *  二、SpringMVC概述
    
     *  2.1 概述
     *  2.2 SpringMVC 的优势
     *  2.3 SpringMVC 与 Struts2 比较
 *  三、SpringMVC组件及配置
    
     *  3.1 DispatcherServlet 前端控制器
     *  3.2 HandlerMapping 处理器映射器
     *  3.3 Handler 处理器【Controller】
     *  3.4 HandlAdapter 处理器适配器
     *  3.5 View Resolver 视图解析器
     *  3.6 View 视图
     *  3.7 mvc:annotation-driven
     *  3.8 @RequestMapping
 *  四、请求参数的绑定
    
     *  4.1 绑定的机制
     *  4.2 绑定参数支持的数据类型及其应用
        
         *  4.2.1 基本类型和 String 类型作为参数
         *  4.2.2 POJO 类型作为参数
         *  4.2.3 POJO 引用了其他POJO
         *  4.2.4 POJO 类中包含集合类型参数
         *  4.2.5 请求参数乱码问题
            
             *  4.2.5.1 POST请求，乱码解决方式
         *  4.2.6 自定义类型转换器
 *  五、常用注解
    
     *  @RequestParam
     *  @RequestBody
     *  @PathVaribale
        
         *  HiddentHttpMethodFilter
     *  @RequestHeader
     *  @CookieValue
     *  @ModelAttribute
        
         *  5.6.1 基于 POJO 属性的基本使用
         *  5.6.2 基于Map的使用 —— ModelAttribute 修饰方法没有返回值
         *  5.6.3 基于Map的使用 —— ModelAttribute 修饰方法有返回值
     *  @SessionAttribute
 *  六、响应数据和结果视图

# 一、基本概念 #

### 1.1、三层架构 ###

我们的开发架构一般都是基于两种形式，一种是 C/S 架构，也就是客户端/服务器，另一种是 B/S 架构，也就 是浏览器服务器。在 JavaEE 开发中，几乎全都是基于 B/S 架构的开发。那么在 B/S 架构中，系统标准的三层架构，包括:表现层、业务层、持久 层。

#### 表现层 ####

就是我们常说的 WEB 层。它负责接收客户端请求，向客户端响应结果，通常客户端使用 http 协议请求 web 层，web 需要接收 http 请求，完成 http 响应。  
表现层包括展示层和控制层：控制层负责接收请求，展示层负责结果的展示。  
表现层依赖业务层，接收到客户端请求一般会调用业务层进行业务处理，并将处理结果响应给客户端。  
表现层的设计一般都使用 MVC 模型。(MVC 是表现层的设计模型，和其他层没有关系)

#### 业务层 ####

也就是我们常说的 service 层。它负责业务逻辑处理，和我们开发项目的需求息息相关。web 层依赖业 务层，但是业务层不依赖 web 层。  
业务层在业务处理时可能会依赖持久层，如果要对数据持久化需要保证事务一致性。(也就是我们说的， 事务应该放到业务层来控制)

#### 持久层 ####

也就是我们是常说的 dao 层。负责数据持久化，包括数据层即数据库和数据访问层，数据库是对数据进 行持久化的载体，数据访问层是业务层和持久层交互的接口，业务层需要通过数据访问层将数据持久化到数据库  
中。通俗的讲，持久层就是和数据库交互，对数据库表进行CRUD操作。

### 1.2、MVC ###

MVC 全名是 Model View Controller，即模型-Model、视图-View、控制器-Controller， 是一种用于设计创建 Web 应用程序**表现层的模式**。

Model(模型): 通常指的就是我们的数据模型。作用一般情况下用于封装数据。  
View(视图):  
通常指的就是我们的 jsp 或者 html。作用一般就是展示数据的。 通常视图是依据模型数据创建的。

Controller(控制器): 是应用程序中处理用户交互的部分。作用一般就是处理程序逻辑的。

# 二、SpringMVC 概述 #

### 2.1 概述 ###

SpringMVC 是一种基于 Java 的实现 MVC 设计模型的请求驱动类型的轻量级 Web 框架，属于 SpringFrameWork 的后续产品，已经融合在 Spring Web Flow 里面。Spring 框架提供了构建 Web 应用程序的全功 能 MVC 模块。使用 Spring 可插入的 MVC 架构，从而在使用Spring进行WEB开发时，可以选择使用 Spring 的 Spring MVC 框架或集成其他 MVC 开发框架，如 Struts1(现在一般不用)，Struts2 等。

### 2.2 SpringMVC 的优势 ###

1、清晰的角色划分:

前端控制器(DispatcherServlet)
    请求到处理器映射(HandlerMapping) 
    处理器适配器(HandlerAdapter)
    视图解析器(ViewResolver) 
    处理器或页面控制器(Controller) 
    验证器( Validator)
    命令对象(Command 请求参数绑定到的对象就叫命令对象)
    表单对象(Form Object 提供给表单展示和提交到的对象就叫表单对象)。

2、分工明确，而且扩展点相当灵活，可以很容易扩展，虽然几乎不需要。  
3、由于命令对象就是一个 POJO，无需继承框架特定 API，可以使用命令对象直接作为业务对象。  
4、和 Spring 其他框架无缝集成，是其它 Web 框架所不具备的。  
5、可适配，通过 HandlerAdapter 可以支持任意的类作为处理器。  
6、可定制性，HandlerMapping、ViewResolver 等能够非常简单的定制。  
7、功能强大的数据验证、格式化、绑定机制。  
8、利用 Spring 提供的 Mock 对象能够非常简单的进行 Web 层单元测试。  
9、本地化、主题的解析的支持，使我们更容易进行国际化和主题的切换。  
10、强大的 JSP 标签库，使 JSP 编写更容易。

### 2.3 SpringMVC 与 Struts2 比较 ###

共同点:  
它们都是表现层框架，都是基于 MVC 模型编写的。 它们的底层都离不开原始 ServletAPI。 它们处理请求的机制都是一个核心控制器。  
区别:  
Spring MVC 的入口是 Servlet, 而 Struts2 是 Filter  
Spring MVC 是基于方法设计的，而 Struts2 是基于类，Struts2 每次执行都会创建一个动作类。所 以 Spring MVC 会稍微比 Struts2 快些。  
Spring MVC 使用更加简洁,同时还支持 JSR303, 处理 ajax 的请求更方便  
(JSR303 是一套 JavaBean 参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注  
解加在我们 JavaBean 的属性上面，就可以在需要校验的时候进行校验了。)  
Struts2 的 OGNL 表达式使页面的开发效率相比 Spring MVC 更高些，但执行效率并没有比 JSTL 提  
升，尤其是 struts2 的表单标签，远没有 html 执行效率高。

# 三、SpringMVC组件 #

### 3.1 DispatcherServlet:前端控制器 ###

用户请求到达前端控制器，它就相当于 mvc 模式中的 c，dispatcherServlet 是整个流程控制的中心，由 它调用其它组件处理用户的请求，dispatcherServlet 的存在降低了组件之间的耦合性。

作用：  
1、文件上传解析，如果请求类型是multipart将通过MultipartResolver进行文件上传解析；  
2、通过HandlerMapping，将请求映射到处理器（返回一个HandlerExecutionChain，它包括一个处理器、多个HandlerInterceptor拦截器）；  
3、通过HandlerAdapter支持多种类型的处理器(HandlerExecutionChain中的处理器)；  
4、通过ViewResolver解析逻辑视图名到具体视图实现；  
5、本地化解析；  
6、渲染具体的视图等；  
7、如果执行过程中遇到异常将交给HandlerExceptionResolver来解析。

DispatcherServlet初始化主要做了如下两件事情：  
1、初始化SpringMVC使用的Web上下文，并且可能指定父容器为（ContextLoaderListener加载了根上下文）；  
2、初始化DispatcherServlet使用的策略，如HandlerMapping、HandlerAdapter等。

### 3.2 HandlerMapping:处理器映射器 ###

HandlerMapping 负责根据用户请求找到 Handler 即处理器（Controller），SpringMVC 提供了不同的映射器实现不同的 映射方式，例如:配置文件方式，实现接口方式，注解方式等。

### 3.3 Handler:处理器 ###

也就是Controller。  
它就是我们开发中要编写的具体业务控制器。由 DispatcherServlet 把用户请求转发到 Handler。由 Handler 对具体的用户请求进行处理。

### 3.4 HandlAdapter:处理器适配器 ###

通过 HandlerAdapter 对处理器进行执行，这是适配器模式的应用，通过扩展适配器可以对更多类型的处理器进行执行。  
处理器适配器向前端控制器返回 ModelAndView（ModelAndView 是 SpringMVC 框架的底层框架，可以设置视图View和数据Model），交给视图解析器InternalResourcesViewResolver 解析。

### 3.5 View Resolver:视图解析器 ###

View Resolver 负责将处理结果生成 View 视图，View Resolver 首先根据逻辑视图名解析成物理视图名即具体的页面地址，再生成 View 视图对象，最后对 View 进行渲染将处理结果通过页面展示给用户。

比如，在web.xml中配置：

<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        
        <property name="prefix" value="/WEB-INF/pages/"/>
        
        <property name="suffix" value=".jsp"/>
    </bean>

### 3.6 View:视图 ###

SpringMVC 框架提供了很多的 View 视图类型的支持，包括:jstlView、freemarkerView、pdfView 等。我们最常用的视图就是 jsp。  
一般情况下需要通过页面标签或页面模版技术将模型数据通过页面展示给用户，需要由程序员根据业务需求开  
发具体的页面。

### 3.7 mvc:annotation-driven ###

在 SpringMVC 的各个组件中，处理器映射器、处理器适配器、视图解析器称为 SpringMVC 的三大组件。  
使用`<mvc:annotation-driven>`自动加载 RequestMappingHandlerMapping(处理映射器)和 RequestMappingHandlerAdapter ( 处 理 适 配 器 ) ， 可 用 在 SpringMVC.xml 配 置 文 件 中 使 用 `<mvc:annotation-driven>`替代注解处理器和适配器的配置。

<mvc:annotation-driven/>

相当于在 xml 中配置了：

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"></bean>
    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"></bean>
    
    
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"></bean>
    <bean class="org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter"></bean>
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"></bean>
    
    
    <bean class="org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver"></bean>
    <bean class="org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver"></bean>
    <bean class="org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver"></bean>

注意：一般开发中，我们都需要写上此标签(虽然从入门案 例中看，我们不写也行，随着课程的深入，该标签还有具体的使用场景 )。

### 3.8 @RequestMapping ###

@RequestMapping 相当于处理器映射器，向前端控制器返回Handler（Controller）。

1、出现的位置：  
①类上:  
请求 URL 的第一级访问目录。此处不写的话，就相当于应用的根目录。写的话需要以/开头。  
用在类上的好处：模块化管理 URL。

比如：

@RequestMapping("/user")  // 用户模块
    public class UserController { }

②方法上:  
请求 URL 的第二级访问目录。

比如：

@RequestMapping("/findAll.do") 
    public ModelAndView findAll() { }

2、属性

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>用于指定请求的 URL。它和 path 属性的作用是一样的。</td> 
  </tr> 
  <tr> 
   <td>method</td> 
   <td>用于指定请求的方式。</td> 
  </tr> 
  <tr> 
   <td>params</td> 
   <td>用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的 key 和 value 必须和 配置的一模一样。</td> 
  </tr> 
  <tr> 
   <td>headers</td> 
   <td>用于指定限制请求消息头的条件。</td> 
  </tr> 
 </tbody> 
</table>

注意:  
以上四个属性只要出现 2 个或以上时，他们的关系是与的关系。

params示例：  
params = \{“accountName”\}，表示请求参数必须有 accountName  
params = \{“moeny!200”\}，表示请求参数中money不能是200。

综合使用示例：

@Controller
    @RequestMapping("/user") // 一级目录
    public class UserController { 
        @RequestMapping("/findAll.do") 
        public ModelAndView findAll() { 
            ModelAndView mv = new ModelAndView();
            mv.addObject("key", "value");
            mv.setViewName("");
            return mv;
        }

如果要访问findAll方法，那么需要`应用根目录+ /user/findAll.do`

# 四、请求参数的绑定 #

### 4.1 绑定的机制 ###

表单中请求参数都是基于 key=value 的。SpringMVC 绑定请求参数的过程是通过把表单提交请求参数，作为控制器中方法参数进行绑定的。

### 4.1 支持的数据类型及其应用 ###

##### 4.2.1 基本类型和 String 类型作为参数 #####

定义一个超链接，点击后访问Controller：

<a href="param/testParam?username=Alex&password=123456">请求参数绑定</a>

Controller定义如下：

@Controller
    @RequestMapping("/param")
    public class ParamController { 
        @RequestMapping("/testParam")
        public String testParam(String username, Integer age) { 
            System.out.println("ParamController 控制器执行了" + username + age);
            return "success";
        }
    }

输出结果：

ParamController 控制器执行了Alex20

##### 4.2.2 POJO 类型作为参数 #####

定义表单，作为请求端：

定义Controller：

@Controller
    @RequestMapping("/param")
    public class ParamController { 
    	@RequestMapping("/testParam")
    	public String testParam(String username, String password, Integer age) { 
        	System.out.println("ParamController 控制器执行了" + username + password);
        	return "success";
    	}
    }

输出结果：

saveAccout：Account{username='master', password='123', money=9000.0, user=null}

**注：表单中提交的字段，如果与 Account 实体类属性名一致，SpringMVC会自动把数据封装到 Account 中**

##### 4.2.3 POJO 引用了其他POJO #####

比如Account类引用了User实体类。

public class Account implements Serializable { 
        private String username;
        private String password;
        private Double money;
        private User user;
    	// 省略getter和setter实现方法
    }

User.java：

public class User implements Serializable { 
        private String uname;
        private Integer age;
        private Date birthday;
    	// 省略getter和setter实现方法
    }

请求时，表单如何传参？  
定义表单如下：

##### 4.2.4 POJO 类中包含集合类型参数 #####

定义JavaBean，含有集合引用：  
AccountContainList.java：

public class AccountContainList implements Serializable { 
        private String username;
        private String password;
        private Double money;
    
        private List<User> list;
        private Map<String, User> map;
        // 省略getter/setter方法实现
    }

定义Controller

@Controller
    @RequestMapping("/param")
    public class ParamController { 
        @RequestMapping("/testListMap")
        public String testListMap(AccountContainList accountContainList) { 
            System.out.println("testListMap：" + accountContainList);
            return "success";
        }
    }

定义表单：

##### 4.2.5 请求参数乱码问题 #####

表单：

输入中文请求，Controller会输出如下结果：

ParamController 控制器执行了æ—¥æœˆå½“ç©ºç§90

如上表单，当我们在POST请求时，传入的参数中含有中文时，会出现乱码。

##### 4.2.5.1 POST请求，乱码解决方式 #####

POST请求乱码解决方案，在web.xml中做如下配置：

<filter>
        <filter-name>characterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        
        <init-param>
          <param-name>encoding</param-name>
          <param-value>UTF-8</param-value>
        </init-param>
        
        <init-param>
          <param-name>forceEncoding</param-name>
          <param-value>true</param-value>
        </init-param>
      </filter>
      
      <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
      </filter-mapping>
    
      
      
      <mvc:resources location="/css/" mapping="/css/**"/>
      <mvc:resources location="/images/" mapping="/images/**"/> 
      <mvc:resources location="/scripts/" mapping="/javascript/**"/>

##### 4.2.5.2 GET请求，乱码解决方式 #####

tomacat 对 GET 和 POST 请求处理方式是不同的，GET 请求的编码问题，要改 tomcat 的 server.xml 配置文件，如下:

改为：

如果遇到 ajax 请求仍然乱码，如下修改：

##### 4.2.6 自定义类型转换器 #####

如果我们传参传入的是 ‘2019-04-26’，Controller接收参数是用Date类型接收的，编译器就会抛出异常。

我们可以自定义类型转换器，解决这个问题。

第一步：定义一个类，实现 Converter 接口。  
Converter接口有两个泛型 <S, T> ，S:表示接受的类型，T:表示目标类型。

public class StringToDateConverter implements Converter<String, Date> { 
        /** * 将字符串转换为日期 * @param source 传入的值 * @return */
        @Override
        public Date convert(String source) { 
            // 判断是否为空
            if (source == null) { 
                throw new RuntimeException("请传入参数");
            }
            DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
            // 把字符串转换为日期
            Date date = null;
            try { 
                date = df.parse(source);
                return date;
            } catch (ParseException e) { 
                throw new RuntimeException("数据类型转换出现错误");
            }
        }
    }

第二步:在 SpringMVC 配置文件中配置类型转换器。  
SpringMVC 配置类型转换器的机制是，将自定义的转换器注册到类型转换服务中去。  
springMVC.xml：

<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
        
        <property name="converters">
            <set>
                
                <bean class="com.hxh.utils.StringToDateConverter"/>
            </set>
        </property>
    </bean>

第三步:在 annotation-driven 标签中引用配置的类型转换服务。

<mvc:annotation-driven conversion-service="conversionService"/>

##### 4.2.7 使用 ServletAPI 对象作为方法参数 #####

**我们可以把上述对象 ，直接写在控制的方法参数中使用。**  
SpringMVC 还支持使用原始 ServletAPI 对象作为控制器方法的参数。支持原始 ServletAPI 对象有:  
HttpServletRequest  
HttpServletResponse  
HttpSession  
java.security.Principal  
Locale  
InputStream  
OutputStream  
Reader  
Writer  
比如：

@RequestMapping("/testModelAttribute")
    public String testModelAttribute(HttpServletRequest request, HttpServletResponse response) { 
        
        return "success";
    }

# 五、常用注解 #

##### @RequestParam #####

1、作用：  
获取请求中的指定名称的参数，并将其传递给控制器中的形参赋值。  
通常情况下，请求参数字段名与Controller方法的形参不一致时会使用该注解。  
2、属性  
value:请求参数中的名称。  
required:请求参数中是否必须提供此参数。默认值:true。表示必须提供，如果不提供将报错400。  
3、示例：  
请求URL：`http://localhost:8080/anno/anno/testRequestParam?username=Alex`  
控制器代码：

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

分析：url传入的参数名为username，控制器中的形参是name。  
此时就可以使用@RequestParam注解获取传入参数username，赋值给name。

##### @RequestBody #####

1、作用:  
用于获取请求体内容。直接使用得到是 key=value&key=value…结构的数据。  
get 请求方式不适用。  
2、属性:  
required:是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值 为 false，get 请求得到是 null  
3、示例  
表单：

控制器代码：

@RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody String body) { 
        System.out.println("testRequestBody，请求体 = " + body);
        return "success";
    }

表单提交，Controller输出结果：

testRequestBody，请求体 = username=master&password=111111

##### @PathVaribale #####

1、作用:  
用于绑定 url 中的占位符。例如:请求 url 中 `/delete/{id}`，这个`{id}`就是 url 占位符。  
url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。  
2、属性:  
value:用于指定 url 中占位符名称。  
required:是否必须提供占位符。  
3、示例  
超链接：

<a href="anno/testPathVariable/10">@PathVaribale</a>

控制器：

/** * @PathVaribale * 属性： * name/value：值与路径大括号{}中的字段名一致 * 为了具体区别形参id，我们在 RequestMapping和PathVariable注解中使用 sid * @return */
    @RequestMapping("/testPathVariable/{sid}")
    public String testPathVariable(@PathVariable(value = "sid") String id) { 
        System.out.println("testPathVariable，id = " + id);
        return "success";
    }

##### HiddentHttpMethodFilter #####

1、作用:  
由于浏览器 form 表单只支持 GET 与 POST 请求，而DELETE、PUT 等 method 并不支持，Spring3.0 添 加了一个过滤器，可以将浏览器请求改为指定的请求方式，发送给我们的控制器方法，使得支持 GET、POST、PUT  
与 DELETE 请求。  
2、使用方法:  
第一步:在 web.xml 中配置该过滤器。  
第二步:请求方式必须使用 post 请求。  
第三步:按照要求提供\_method 请求参数，该参数的取值就是我们需要的请求方式

jsp 中示例代码：  
保存：

<form action="springmvc/testRestPOST" method="post">
    	用户名称:<input type="text" name="username"><br/>
    	 
    	<input type="submit" value="保存">
    </form>

更新：

删除：

查询 id=1：

控制器中示例代码:

/** * post请求:保存 * @param username * @return */
    @RequestMapping(value="/testRestPOST",method=RequestMethod.POST)
    public String testRestfulURLPOST(User user){ 
    	 System.out.println("rest post"+user); return "success";
    }
    
    /** * put请求:更新 * @param username * @return */
    @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"; 
    }
    
    /** * post请求:删除 * @param username * @return */
    @RequestMapping(value="/testRestDELETE/{id}",method=RequestMethod.DELETE) public String testRestfulURLDELETE(@PathVariable("id")Integer id){ 
    	System.out.println("rest delete "+id);
    	return "success"; 
    }
    
    /** * post请求:查询 * @param username * @return */
    @RequestMapping(value="/testRestGET/{id}",method=RequestMethod.GET)
    public String testRestfulURLGET(@PathVariable("id")Integer id){  
    	System.out.println("rest get "+id);
    	return "success";
    }

##### @RequestHeader #####

1、作用:  
用于获取请求消息头。  
2、属性:  
value:提供消息头名称 required:是否必须有此消息头  
注:  
在实际开发中一般不怎么用  
3、示例代码  
控制器代码：

/** * @RequestHeader * 作用：获取请求头信息 * 属性： * value/name：传入参数的字段名，value值与传入字段名必须一致。 * required：该参数是否必传。默认为true。 * true：该参数必传. * false：该参数可以不传。 * @return */
    @RequestMapping("/testRequestHeader")
    public String testRequestHeader(@RequestHeader(value = "accept", required = true) String header) { 
        System.out.println("testRequestHeader，header = " + header);
        return "success";
    }

##### @CookieValue #####

1、作用:  
用于把指定 cookie 名称的值传入控制器方法参数。  
2、属性:  
value:指定 cookie 的名称。 required:是否必须有此 cookie。  
3、示例代码  
控制器代码：

/** * @CookieValue * 作用：用于把指定 cookie 名称的值传入控制器方法参数。 * 属性: * value:指定 * cookie 的名称。 * required:是否必须有此 cookie。 * @return */
    @RequestMapping("/testCookieValue")
    public String testCookieValue(@CookieValue(value = "JSESSIONID", required = false) String cookie) { 
        System.out.println("testCookieValue,cookie = " + cookie);
        return "success";
    }

##### @ModelAttribute #####

1、作用:  
该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。  
出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。  
它可以修饰没有返回值的方法，也可 以修饰有具体返回值的方法。  
出现在参数上，获取指定的数据给参数赋值。  
2、属性:  
value:用于获取数据的 key。key 可以是 POJO 的属性名称。也可以是 map 结构的 key。  
3、应用场景:  
当表单提交数据不是完整的实体类数据时，**保证没有提交数据的字段使用数据库对象原来的数据。【注意：已经提交的字段值不会被数据库原来的数据覆盖，仅仅会给未提交的字段赋值】**

##### 5.6.1 基于 POJO 属性的基本使用 #####

表单：

控制器代码：

// ✅该方法会先执行
     @ModelAttribute
     public User showUser(String uname) { 
         // 模拟查询数据库
         User findUser = findUserByName(uname);
         System.out.println("showUser方法执行了=" + findUser);
         // 将查询数据库获取的 findUser返回
         return findUser;
     }
    
     // ✅然后执行该方法：
     @RequestMapping("/testModelAttribute")
     public String testModelAttribute(User user) { 
         System.out.println("testModelAttribute方法执行了=" + user);
         return "success";
     }

注意：  
①【不推荐】先执行的方法不要使用JavaBean接收传入的参数，否则会导致后执行的方法封装JavaBean失败！！！  
② 先执行的方法根据传入的参数uname查找到findUser，后执行的方法的JavaBean只会获取先执行方法查找到的缺省字段的值，其他值均是传入的值，不会被数据库新查找到的值覆盖

##### 5.6.2 基于Map的使用 —— ModelAttribute 修饰方法没有返回值 #####

使用步骤：  
1、@ModelAttribute 修饰的方法中，将数据库查询的数据存入map；  
2、然后在@RequestMapping修饰的方法中，用 @ModelAttribute(value = “userKey”) 修饰形参，它会根据指定的key值取值赋值给形参【**只会传入的数据中缺少的那部分数据，赋值给形参。比如：User实体类，传入了age，那么就不会用数据库查询出来的age覆盖传入的age】**

控制器代码：

@RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute(value = "userKey") User user) { 
        System.out.println("testModelAttribute方法执行了 ====" + user);
        return "success";
    }
    
    @ModelAttribute
    public void showUser(String uname, Map<String, User> map) { 
    
        // 根据 username，查询数据库
        User user = findUserByName(uname);
    
        // 把数据库查询结果封装的 User 对象存入 map 集合中。
        // 该方法执行完毕后，然后执行 testModelAttribute
        map.put("userKey", user);
        System.out.println("showUser方法执行了 ===== " + user);
    }

表单：

启动项目：  
![在这里插入图片描述][20190426124345310.png]  
表单输入数据：  
姓名：凯迪拉克  
年龄：60

控制器输出：

showUser方法执行了 ===== User{uname='凯迪拉克', age=20, birthday=Fri Apr 26 12:38:52 CST 2019}
    testModelAttribute方法执行了 ====User{uname='凯迪拉克', age=60, birthday=Fri Apr 26 12:38:52 CST 2019}

注意：虽然我们数据库查询出来的age=20，但是最终结果age=60，仍是传入的数据，也就是说先执行方法查询数据库得到的原有数据，不会覆盖传入的数据，只会给没有数据的字段赋值。

##### 5.6.3 基于Map的使用 —— ModelAttribute 修饰方法有返回值 #####

以下我们将 @ModelAttribute 注解修饰的方法称之为 **先执行的方法**；  
将@RequestMapping注解修饰的方法称之为 **后执行的方法**。

与没有返回值的唯一区别是：  
如果先执行的方法无返回值，那么后执行的方法的形参需@ModelAttribute(“key”) 修饰，并且指定key值，才能将存储在Map中的值赋值给形参；  
如果 @ModelAttribute 注解修饰的方法有返回值，那么后执行的方法的形参就不需要@ModelAttribute(“key”) 修饰了。

##### @SessionAttribute #####

1、作用:  
用于多次执行控制器方法间的参数共享。  
2、属性:  
value:用于指定存入的属性名称  
type:用于指定存入的数据类型。

Controller代码：  
以下分别是存取、获取、删除。

@SessionAttributes(value = { "username", "password"}) // 用于指定存入的属性名称。数据存入session域对象中。
    public class AnnotationController { 
    /** * @SessionAttribute * 作用：用于多次执行控制器方法间的参数共享。 * 属性: * value:用于指定存入的属性名称 * type:用于指定存入的数据类型。 * * @return */
        @RequestMapping("/testSessionAttribute")
        public String testSessionAttribute(Model model) { 
            System.out.println("testSessionAttribute 执行了");
            // 底层会存储到request域对象中
            model.addAttribute("username", "凯迪拉克");
            model.addAttribute("password", "654321");
            return "success";
        }
    
        /** * 取值 * @param modelMap * @return */
        @RequestMapping("/getSessionAttribute")
        public String getSessionAttribute(ModelMap modelMap) { 
            System.out.println("getSessionAttribute 执行了");
            String username = (String) modelMap.get("username");
            String password = (String) modelMap.get("password");
            System.out.println("username = " + username + ",password = " + password);
            return "success";
        }
    
        /** * 删除 * @param status * @return */
        @RequestMapping("/delSessionAttribute")
        public String delSessionAttribute(SessionStatus status) { 
            status.setComplete();
            return "success";
        }
    }

注：  
如果没有用注解 @SessionAttributes 修饰Controller，Model只会把值存入request域对象中。  
Controller被注解 @SessionAttributes 修饰后，Model会将值存入request、session域中。  
删除操作执行使用 SessionStatus接口，删除操作执行后，request域对象和session域对象中的值都会被删除。

[20190426124345310.png]: /images/20220216/c722ed4243d14418a366078a51bb95b4.png