Spring MVC是管理controller对象的容器

一、Spring MVC是什么

Spring MVC是一种基于 Java 的、实现 MVC 设计模型的、请求驱动类型的轻量级 Web 框架，属于SpringFrameWork 的后续产品，已经融合在 Spring Web Flow 中。

Spring MVC是一个MVC模式的WEB开发框架。它已经成为目前最主流的MVC框架之一，并且随着Spring 3.0的发布，全面超越 Struts2，成为最优秀的 MVC 框架。

Spring MVC通过一套注解，让一个简单的 Java 类成为处理请求的控制器，而无须实现任何接口，同时它还支持 RESTful 编程风格的请求。

Spring和Spring MVC的相同点：

• 都是容器（管理对象的地方）。

两者的区别：

• Spring可以说是一个管理bean的容器，也可以说是包括很多开源项目的总称。（Spring是管理service和dao层的容器）
• Spring MVC是Spring其中的一个开源项目，是基于Spring功能之上添加的Web框架，想用Spring MVC必须先依赖Spring。（Spring MVC是管理controller对象的容器）

二、Spring MVC的执行流程

Spring MVC的执行流程：

1. 用户发送请求至前端控制器 DispatcherServlet。
2. DispatcherServlet 收到请求调用 HandlerMapping 处理器映射器。
3. 处理器映射器找到具体的处理器(可以根据xml配置、注解进行查找)，生成处理器对象及处理器拦截器(如果有则生成)一并返回给 DispatcherServlet 。
4. DispatcherServlet 调用 HandlerAdapter 处理器适配器。
5. HandlerAdapter 经过适配调用具体的处理器(Controller，也叫后端控制器)。
6. Controller执行完成返回ModelAndView。
7. HandlerAdapter 将controller执行结果ModelAndView返回给 DispatcherServlet 。
8. DispatcherServlet 将ModelAndView传给ViewReslover视图解析器。
9. ViewReslover解析后返回具体 View。
10. DispatcherServlet 根据 View 进行渲染视图（即将模型数据填充至视图中）。DispatcherServlet 响应用户。

Spring MVC的六大组件：

1. DispatcherServlet 前端控制器。DispatcherServlet 是整个流程控制的中心，相当于 MVC 模式中的 C，由它调用其它组件处理用户的请求。DispatcherServlet 的存在降低了组件之间的耦合性。
2. HandlerMapping 处理器映射器。HandlerMapping 负责根据用户请求即找到对应 Handler 。Spring MVC提供了不同的映射器实现不同的映射方式，例如：配置文件方式，实现接口方式，注解方式等。
3. HandlerAdapter 处理器适配器。通过 HandlerAdapter 对处理器进行执行，这是适配器模式的应用，通过扩展适配器可以对更多类型的处理器进行执行。
4. Handler 处理器。Handler 就是我们开发中要编写的具体业务控制器。由 DispatcherServlet 把用户请求转发到 Handler。由 Handler 对具体的用户请求进行处理。
5. ViewResolver 视图解析器。ViewResolver 负责将处理结果生成 View 视图。ViewResolver 首先根据逻辑视图名解析成物理视图名，即具体的页面地址，再生成 View 视图对象，最后对 View 进行渲染将处理结果通过页面展示给用户。
6. View 视图。Spring MVC 框架提供了很多的 View 视图类型的支持，包括：jstlView、freemarkerView、pdfView等，最常用的视图就是 jsp。一般情况下需要通过页面标签或页面模版技术将模型数据通过页面展示给用户，需要由程序员根据业务需求开发具体的页面。

三、Spring MVC注解和XML配置

3.1 常用注解

详解springmvc常用5种注解：https://www.jb51.net/article/166604.htm

注解	说明
@RequestMapping	用于处理请求地址映射，可以作用于类和方法上。
@RequestParam	用于获取传入参数的值。 （当请求参数名称和方法形参不一致时在两者之间手动形成映射）
@PathViriable	用于定义路径参数值。 （用在restful风格的请求中，通过占位符解析url地址上的请求参数）
@ResponseBody	作用于方法上，可以将整个返回结果以某种格式返回，如json或xml格式。
@CookieValue	用于获取请求的Cookie值。
@ModelAttribute	用于把参数保存到Model对象中。
@SessionAttributes	将模型中的数据存储到request域中。
@Controller	用于实例化Bean，使用在控制层类上。
@Service	用于实例化Bean，使用在service层类上。
@Repository	用于实例化Bean，使用在dao层类上。
@Component	用于实例化Bean，使用在类上。

@RequestMapping 请求映射，常用属性如下

• value：用于指定请求的URL。它和path属性的作用是一样的。
• method：用于指定请求的方式。
• params：用于指定限制请求参数的条件，要求请求参数的key和value必须和配置的一模一样。该属性支持简单的表达式。如 params={"accountName"} 请求参数必须有accountName，params={"money!100"} 请求参数中money不能是100。

3.2 MVC命名空间的引入

命名空间：

xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"

约束地址：

http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd

3.3 组件扫描

Spring MVC基于Spring容器，所以在进行Spring MVC操作时，需要将Controller存储到Spring容器中，如果使用 @Controller 注解标注的话，就需要使用 <context:component-scan base-package=“com.example.controller"/> 进行组件扫描。

3.4 XML配置说明

Spring MVC有默认组件配置，默认组件都是 DispatcherServlet.properties 配置文件中配置的，该配置文件地址org/springframework/web/servlet/DispatcherServlet.properties ，该文件中配置了默认的视图解析器 org.springframework.web.servlet.ViewResolver=org.springframework.web.servlet.view.InternalResourceViewResolver

该解析器源码中可以看到其默认设置，如下：

REDIRECT_URL_PREFIX = "redirect:"  --重定向前缀
FORWARD_URL_PREFIX = "forward:"    --转发前缀（默认值）
prefix = "";     --视图名称前缀
suffix = "";     --视图名称后缀

我们可以通过属性注入的方式修改视图的前后缀：

<!--配置内部资源视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
  <property name="prefix" value="/"></property>
  <property name="suffix" value=".jsp"></property>
</bean>

Spring MVC入门案例：https://blog.csdn.net/weixin_60808029/article/details/124835656#Spring_MVC_712

四、Spring MVC的数据响应方式和获得请求数据

4.1 数据响应方式

有两种数据响应方式：页面跳转、回写数据。

第一种：页面跳转方式

1. 返回字符串形式

该方式会将返回的字符串与视图解析器的前后缀拼接后跳转。

@RequestMapping("/quick")
public String quickMethod(){
return "index";
}

<property name="prefix" value="/WEB-INF/views/" />
<property name="suffix" value=".jsp" />

上述代码代表的转发资源地址是：/WEB-INF/views/index.jsp 。

返回带有前缀的字符串：转发 forward:/WEB-INF/views/index.jsp ，重定向 redirect:/index.jsp 。

2. 通过ModelAndView对象返回①

在Controller中方法返回ModelAndView对象，并且设置视图名称。

@RequestMapping(value="/quick2")
public ModelAndView save2(){
    /*
    Model:模型，用来封装数据
    View：视图，用来展示数据
    */
    ModelAndView modelAndView = new ModelAndView();
    //设置模型数据，数据返回到request域中
    modelAndView.addObject("username","itcast");
    //设置视图名称
    modelAndView.setViewName("success");
    return modelAndView;
}

3. 通过ModelAndView对象返回②

在Controller中方法形参上直接声明ModelAndView，无需在方法中自己创建，由Spring自行提供并注入，在方法中直接使用该对象设置视图，同样可以跳转页面。

@RequestMapping(value="/quick3")
public ModelAndView save3(ModelAndView modelAndView){
    modelAndView.addObject("username","itheima");
    modelAndView.setViewName("success");
    return modelAndView;
}

@RequestMapping(value="/quick4")
public String save4(Model model){
    model.addAttribute("username","博学谷");
    return "success";
}

4. 通过ModelAndView对象返回③

在Controller方法的形参上可以直接使用原生的HttpServeltRequest对象，只需声明即可。

@RequestMapping(value="/quick5")
public String save5(HttpServletRequest request){
    request.setAttribute("username","酷丁鱼");
    return "success";
}

第二种：回写数据方式

1. 直接回写字符串

通过Spring MVC框架注入的response对象，使用 response.getWriter().print(“hello world”) 回写数据，此时不需要视图跳转，业务方法返回值为void。

将需要回写的字符串直接返回，但此时需要通过 @ResponseBody 注解告知Spring MVC框架，方法返回的字符串而不是跳转，且字符串是直接在http响应体中返回。

@RequestMapping(value="/quick7")
@ResponseBody  //该注解作用：告知SpringMVC框架，不进行视图跳转，直接进行数据响应
public String save7() throws IOException {
    return "hello itheima";
}

@RequestMapping(value="/quick6")
public void save6(HttpServletResponse response) throws IOException {
    response.getWriter().print("hello itcast");
}

2. 直接返回对象或集合（直接回写json格式字符串）

手动拼接json格式字符串的方式很麻烦，开发中往往要将复杂的java对象转换成json格式的字符串，我们可以使用json转换工具jackson，通过jackson转换成json格式字符串，回写字符串。

@RequestMapping(value="/quick9")
@ResponseBody
public String save9() throws IOException {
    User user = new User();
    user.setUsername("lisi");
    user.setAge(30);
    //使用json的转换工具将对象转换成json格式字符串在返回
    ObjectMapper objectMapper = new ObjectMapper();
    String json = objectMapper.writeValueAsString(user);
    return json;
}

3. 直接返回对象或集合（返回对象或集合）

通过Spring MVC帮助我们对对象或集合进行json字符串的转换并回写，为处理器适配器配置消息转换参数，指定使用jackson进行对象或集合的转换。

@RequestMapping(value="/quick10")
@ResponseBody
//期望SpringMVC自动将User转换成json格式的字符串
public User save10() throws IOException {
    User user = new User();
    user.setUsername("lisi2");
    user.setAge(32);
    return user;
}

需要在spring-mvc.xml中进行如下配置：

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
    <property name="messageConverters">
        <list>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
        </list>
    </property>
</bean>

上述配置也可用mvc注解驱动代替：

<mvc:annotation-driven/>

使用 <mvc:annotation-driven /> 自动加载 RequestMappingHandlerMapping（处理器映射器）和RequestMappingHandlerAdapter（ 处理器适配器），且默认底层会集成jackson进行对象或集合的json格式字符串的转换。

4.2 获得请求数据

1. 获得基本类型数据

Controller中的业务方法的参数名称要与请求参数的name一致，参数值会自动映射匹配。并且能自动做类型转换（自动的类型转换是指从String向其他类型的转换）。

如此地址：http://localhost:8080/itheima_springmvc1/quick9?username=zhangsan&age=12

@RequestMapping(value="/quick11")
@ResponseBody
public void save11(String username,int age) throws IOException {
    System.out.println(username);
    System.out.println(age);
}

2. 获得POJO类型数据

Controller中的业务方法的POJO参数的属性名与请求参数的name一致，参数值会自动映射匹配。

public class User {
    private String username;
    private int age;
	//getter()+setter()
	//toString()
}

@RequestMapping(value="/quick12")
@ResponseBody
public void save12(User user) throws IOException {
System.out.println(user);
}

3. 获得数组类型数据

Controller中的业务方法数组名称与请求参数的name一致，参数值会自动映射匹配。

@RequestMapping(value="/quick13")
@ResponseBody
public void save13(String[] strs) throws IOException {
    System.out.println(Arrays.asList(strs));
}

4. 获得集合类型数据①

获得集合参数时，要将集合参数包装到一个POJO中才可以。

<form action="${pageContext.request.contextPath}/user/quick14" method="post">
    <%--表明是第一个User对象的username age--%>
    <input type="text" name="userList[0].username"><br/>
    <input type="text" name="userList[0].age"><br/>
    <input type="text" name="userList[1].username"><br/>
    <input type="text" name="userList[1].age"><br/>
    <input type="submit" value="提交">
</form>

import java.util.List;

public class VO {
    private List<User> userList;
    //getter()+setter()
    //toString()
}

@RequestMapping(value="/quick14")
@ResponseBody
public void save14(VO vo) throws IOException {
    System.out.println(vo);
}

5. 获得集合类型数据②

当使用ajax提交时，可以指定contentType为json形式，那么在方法参数位置使用 @RequestBody 可以直接接收集合数据而无需使用POJO进行包装。

<script src="${pageContext.request.contextPath}/js/jquery-3.3.1.js"></script>
<script>
   <%--模拟数据--%>
   var userList = new Array();
   userList.push({username:"zhangsan",age:18});
   userList.push({username:"lisi",age:28});
   $.ajax({
       type:"POST",
       url:"${pageContext.request.contextPath}/user/quick15",
       data:JSON.stringify(userList),
       contentType:"application/json;charset=utf-8"
   });
</script>

@RequestMapping(value="/quick15")
@ResponseBody
public void save15(@RequestBody List<User> userList) throws IOException {
    System.out.println(userList);
}

4.3 获得请求数据细节

1. 静态资源访问的开启

当有静态资源需要加载时，比如jquery文件，通过谷歌开发者工具抓包发现，没有加载到jquery文件，原因是Spring MVC的前端控制器DispatcherServlet的url-pattern配置的是/,代表对所有的资源都进行过滤操作。

我们可以通过以下两种方式指定放行静态资源，

• 在spring-mvc.xml配置文件中指定放行的资源： <mvc:resources mapping="/js/**" location="/js/"/> 。
• 使用 <mvc:default-servlet-handler/> 标签。

2. 配置全局乱码过滤器

当post请求时，数据会出现乱码，我们可以设置一个过滤器来进行编码的过滤。

<!--配置全局过滤的filter-->
<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>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

3. 参数绑定注解@RequestParam

当请求的参数名称与Controller的业务方法参数名称不一致时，就需要通过 @RequestParam 注解显示的绑定。

<form action="${pageContext.request.contextPath}/quick16" method="post">
    <input type="text" name="name"><br>
    <input type="submit" value="提交"><br>
</form>

@RequestMapping(value="/quick16")
@ResponseBody
public void save16(@RequestParam(value="name",required = false,defaultValue = "itcast") String username) throws IOException {
    System.out.println(username);
}

4. Restful风格的参数的获取

Restful是一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。主要用于客户端和服务器交互类的软件，基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存机制等。

Restful风格的请求是使用“url+请求方式”表示一次请求目的的，HTTP 协议里面四个表示操作方式的动词如下：GET（用于获取资源）、POST（用于新建资源）、PUT（用于更新资源）、DELETE（用于删除资源）。

http://localhost:8080/itheima_springmvc1/quick17/zhangsan

@RequestMapping(value="/quick17/{name}")
@ResponseBody
 public void save17(@PathVariable(value="name") String username) throws IOException {
        System.out.println(username);
 }

5. 自定义类型转换器

Spring MVC 默认已经提供了一些常用的类型转换器，例如客户端提交的字符串转换成int型进行参数设置。

但不是所有的数据类型都提供了转换器，没有提供的就需要自定义转换器，例如：日期类型的数据就需要自定义转换器。

public class DateConverter implements Converter<String, Date> {
    public Date convert(String dateStr) {
        //将日期字符串转换成日期对象 返回
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
        Date date = null;
        try {
            date = format.parse(dateStr);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return date;
    }
}

@RequestMapping(value="/quick18")
@ResponseBody
public void save18(Date date) throws IOException {
    System.out.println(date);
}

6. 获得Servlet相关API

Spring MVC支持使用原始Servlet API对象（HttpServletRequest、HttpServletResponse、HttpSession）作为控制器方法的参数进行注入。

@RequestMapping(value="/quick19")
@ResponseBody
public void save19(HttpServletRequest request, HttpServletResponse response, HttpSession session) throws IOException {
    System.out.println(request);
    System.out.println(response);
    System.out.println(session);
}

7. 获得请求头信息

使用 @RequestHeader 可以获得请求头信息，相当于web阶段学习的 request.getHeader(name) 。该注解的属性有 value（请求头的名称）、required（是否必须携带此请求头）。

@RequestMapping(value="/quick20")
@ResponseBody
public void save20(@RequestHeader(value = "User-Agent",required = false) String user_agent) throws IOException {
    System.out.println(user_agent);
}

使用 @CookieValue 可以直接获得Cookie的值，比注解 @RequestHeader 更简单。该注解的属性有 value（指定cookie的名称）、required（是否必须携带此cookie）。

 @RequestMapping(value="/quick21")
@ResponseBody
public void save21(@CookieValue(value = "JSESSIONID") String jsessionId) throws IOException {
    System.out.println(jsessionId);
}

8. 文件上传

前提：表单项的类型必须有type="file"、提交方式method="post"、编码方式enctype="multipart/form-data" 。

<form action="${pageContext.request.contextPath}/……" method="post" enctype="multipart/form-data">
    名称<input type="text" name="username"><br/>
    文件1<input type="file" name="uploadFile"><br/>
    <input type="submit" value="提交">
</form>

Spring MVC实现文件上传：https://blog.csdn.net/weixin_60808029/article/details/124835656#Spring_MVC_810

五、Spring MVC拦截器

Spring MVC的拦截器 Interceptor 类似于Servlet 开发中的过滤器 Filter，用于对处理器进行预处理和后处理。将拦截器按一定的顺序联结成一条链，这条链称为拦截器链（InterceptorChain）。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

拦截器也是AOP思想的具体实现。

（使用范围）Interceptor 是Spring MVC框架自己的，只有使用了Spring MVC框架的工程才能用。Filter 是Servlet规范中的一部分，任何 JavaWeb 工程都可以使用。

（拦截范围）Interceptor 只会拦截访问的控制器方法，如果访问的是 .jsp、.html、.css、image、.js 是不会进行拦截的。在 url-pattern 中配置了 /* 之后，Filter 可以对所有要访问的资源进行拦截。

快速入门使用Spring MVC拦截器：https://blog.csdn.net/weixin_60808029/article/details/124835656#Spring_MVC_889

拦截器执行的相关问题

• 拦截器在预处理后什么情况下会执行目标资源，什么情况下不执行目标资源？

当拦截器的 preHandle() 方法返回true则会执行目标资源，如果返回false则不执行目标资源。

• 在有多个拦截器的情况下拦截器的执行顺序是什么?

多个拦截器情况下，配置在前的先执行，配置在后的后执行。

• 拦截器中的方法执行顺序什么？

preHandler()-------目标资源方法-------postHandle()-------afterCompletion()。

拦截器中的方法	说明
preHandler()	该方法在请求处理之前进行调用。返回值是布尔值boolean类型的，当它返回为false时，表示请求结束，后续的Interceptor和Controller都不会再执行；当返回值为true时就会继续调用下一个Interceptor的 preHandle() 方法。
postHandle()	该方法是在当前请求进行处理之后被调用，前提是 preHandle() 方法的返回值为true时才能被调用，且它会在DispatcherServlet进行视图返回渲染之前被调用，所有我们可以在这个方法中对Controller处理之后的ModelAndView对象进行操作。
afterCompletion()	该方法将在整个请求结束之后，也就是在DispatcherServlet渲染了对应的视图之后执行，前提是 preHandle() 方法的返回值为true时才能被调用。

Spring MVC拦截器的使用案例——用户登录权限控制：https://blog.csdn.net/weixin_60808029/article/details/124835656#Spring_MVC_952

六、Spring MVC异常处理机制

6.1 异常处理思路

系统中异常包括两类：预期异常和运行时异常RuntimeException，前者通过捕获异常从而获取异常信息，后者主要通过规范代码开发、测试等手段减少运行时异常的发生。

系统的Dao、Service、Controller出现都通过 throws Exception 向上抛出，最后由Spring MVC前端控制器交由异常处理器进行异常处理。

6.2 处理异常的两种方式

• 使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver。Spring MVC已经定义好了该类型转换器，在使用时可以根据项目情况进行相应异常与视图的映射配置。

<!--配置简单映射异常处理器-->
<bean class=“org.springframework.web.servlet.handler.SimpleMappingExceptionResolver”>    
    <!--默认错误视图，value="视图名称"-->
    <property name=“defaultErrorView” value=“error”/>
    <property name=“exceptionMappings”>
        <map>	<!--key="异常类型"-->
            <entry key="com.itheima.exception.MyException" value="error"/>
            <entry key="java.lang.ClassCastException" value="error"/>
        </map>
    </property>
</bean>

• 实现Spring的异常处理接口 HandlerExceptionResolver 自定义自己的异常处理器。

Spring MVC自定义异常处理器：https://blog.csdn.net/weixin_60808029/article/details/124835656#Spring_MVC_1029