[Java知识库]【Spring之轨迹】SpringMVC 笔记快速梳理

0. SpringMVC 简介

SpringMvc 是基于 Java 实现的轻量级 Web 框架，是 Spring 框架的一部分，因此可以和 Spring 无缝整合

1. 基本开发全流程

① 导入依赖： spring-webmvc（这个包会将其他 Spring 需要的基本都导入，一步解决），servlet-api

② 配置 web,xml

<!-- 注册 DispatcherServlet（SpringMVC 的核心：请求分发器/前端控制器） -->
<servlet>
    <servlet-name>SpringMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

    <!-- 关联一个 springmvc 配置文件 -->
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:SpringMVC-servlet.xml</param-value>
    </init-param>

    <!-- 设置启动级别 -->
    <load-on-startup>1</load-on-startup>
</servlet>

<!-- / 匹配所有的请求（不包括 .jsp） -->
<!-- /* 匹配所有的请求（包括 .jsp） -->
<servlet-mapping>
    <servlet-name>SpringMVC</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

③ 配置 SpringMVC-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- 处理器映射器 -->
    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>

    <!-- 处理器适配器 -->
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>

    <!-- 视图解析器 DispatcherServlet 给他的 ModelAndView -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/"/>
        <!-- 后缀 -->
        <property name="suffix" value=".html"/>
    </bean>

    <!-- Handler -->
    <bean id="/myHtml" class="com.iceclean.controller.MyController"/>

</beans>

④ 直接使用

public class MyController implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        // ModelAndView 模型和视图
        ModelAndView modelAndView = new ModelAndView();

        // 封装对象，放在 ModelAndView 中
        modelAndView.addObject("message", "IceClean");
        // 封装要跳转的视图，放在 ModelAndView 中
        modelAndView.setViewName("myHtml");

        return modelAndView;
    }
}

⑤ 过程中可能出现的问题
(1) 由于 SpringMVC 默认支持 jsp，而屏蔽 html，所以会出现 jsp 界面可以打开而 html 页面为 404 的情况，这时可以在后面加上：

<!-- SpringMVC 默认拦截了 html，访问 html 会出现 404，加上这一段就可以解决了 -->
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.html</url-pattern>
</servlet-mapping>

(2) 如果代码没有问题却出现了 404，考虑为 idea 没有帮我们自动导包，需要手动导包
在 Artifacts 中选择 WEF-INF，新建一个 lib 文件夹，点击加号将所有需要的包放入 lib 中

2. 执行流程

• 前端发出请求到 DispatcherServlet 请求转发器
• 请求转发器请求 HandlerMapping （处理器映射器）寻找 Handler（可以根据 xml 或者注解查找）
• 请求转发器调用 HandlerAdapter （处理器适配器）执行 Handler
• Handler 执行完成后给处理器适配器返回 ModelAndView
• 处理器适配器向请求转发器返回 ModelAndView
• 请求转发器请求视图解析器进行视图解析（根据逻辑视图名解析成真正的视图：html 或 jsp）
• 视图解析器向请求转发器返回 View
• 请求转发器对 View 进行渲染，填充到 request 中，最后向用户返回响应结果

3. 使用注解开发（推荐使用）

① 导入依赖和 web.xml 完全一样

② SpringMVC-servlet.xml 配置为

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 使用注解开发 SpringMVC 的流程如下 -->

    <!-- ① 自动扫描包，让指定包下的注解生效，由 IOC 容器统一管理 -->
    <context:component-scan base-package="com.iceclean.controller"/>

    <!-- ② 让 SpringMVC 不处理静态资源，如 .css .js .html 等 -->
    <mvc:default-servlet-handler/>

    <!-- ③ 支持 mvc 注解驱动 -->
    <!-- 相当于自动完成 HandlerMapping 和 HandlerAdapter 的注入
         使得要用到的注解 @RequestMapping 生效 -->
    <mvc:annotation-driven/>

    <!-- 视图解析器 DispatcherServlet 给他的 ModelAndView -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/"/>
        <!-- 后缀 -->
        <property name="suffix" value=".html"/>
    </bean>
</beans>

③ 直接使用

@Controller
public class BaseController {

    @RequestMapping("/hello2333")
    public String hello() {
        // return 的东西会被视图解析器处理
        return "hello";
    }
}

其中 @Controller 的作用和 @Component 的作用相同，代表该类是一个 bean
前提是 Spring 的配置中有扫描到该类（一般为扫描该类所在的包）

再而，被 @Controller 注解的类中的所有方法，如果返回值是 String 且有具体的页面可以跳转，就会被视图解析器解析
如果不想被视图解析器解析，可以在需要的方法前加上 @ResponseBody，变成普通的方法返回普通的字符串
如果对一个类使用 @RestController，则该类的所有方法都不会被视图解析器解析

@RequestMapping() 的作用相当于起别名，在进行访问时需要填写该别名

4. RestFul 风格

① 基础使用
使用 {xxx} 代表 url 中该位置的值将被赋值到 xxx 变量中，如
xxxx/add/1/2 那么 a=1, b=2

@GetMapping("/add/{a}/{b}")
public String hello(@PathVariable int a, @PathVariable int b){
	// ...
    return "hello";
}

② 衍生用法

可以指定访问方法，如下面的注解规定只有通过 GET 方法才能访问到
@RequestMapping(value = "/add/{a}/{b}", method = RequestMethod.GET)
可取的值有：GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE;

此外还有各种变体可以简化写法，如：
@GetMapping("/add/{a}/{b}") 等

5. 重定向和转发

在配置了视图解析器后，默认的返回值为转发，通过加上 redirect 可指定为转发（需要多写一个斜杆），如：

@RequestMapping("/add")
public String hello() {
    // return 的东西会被视图解析器处理
    return "hello";	// 为妆发
    return "redirect:/hello";	// 为重定向
}

在没有视图解析器的情况下，也可以实现转发和重定向，只不过需要将视图解析器的工作（添加前缀和后缀）做一遍，也就是写全名称，如

@RequestMapping("/add")
public String hello() {
    // return 的东西会被视图解析器处理
    return "/xxx/xxx/hello";	// 为妆发
    return "forward:/xxx/xxx/hello";	// 也为妆发
    return "redirect:/xxx/xxx/hello";	// 为重定向
}

6. 参数的接收

（1）接收单个值
写在方法的参数列表中的参数即为前端需要传进来的参数，且名字要相同
但有一些参数不需要前端传过来（如：HttpServletResponse），而有一些参数前端传过来的名称会对不上
这时候可以使用注解 @RequestParam 来表示哪些参数是前端需要传过来的，并且可以为参数起别名使得前端必须以该名字传值，否则会报错（如果没有的话，前端传了一个不对的值可能只后台接收到了 null 值，而没有报错）

public String hello(@RequestParam("add1") int a, @RequestParam("add2") int b, HttpServletResponse response)

如上规定了前端需要传 a 和 b 两个参数的值，并且 a 值需要以名字 add1 来传，而 b 值需要以 add2 来传，否则报错，最后一个参数由于可以自动获取到，不需要前端传值

（2）接收一个对象
当方法的参数列表存在对象时，前端传过来的值首先会和参数列表进行匹配，再而匹配对象中的属性，若前端传过来的值的名字与对象的属性名一致，则将该值赋给对应的属性值，如：

@GetMapping("/test")
public String ttt(User user, String userName, int age) {
    System.out.println(user);
    System.out.println(userName);
    System.out.println(age);

    return "hello";
}

输入：xxx/test?userName=IceClean&age=18

运行结果：
User{userName='IceClean', userAge=null, userSex=false}
IceClean
18

可以看到，user 中的 userName 和 参数列表中的 userName 同时有值了
而 userAge 和 age 匹配不上，故值为 null （Integer），而 age 能匹配到故有值 

7. 乱码问题

遇到乱码问题时，以前可以通过 require 和 response 来解决，但在 SpringMVC 中这两种已经不起作用了，而使用过滤器来解决会出现有些请求方法依旧出现乱码的问题
至此可以使用 SpringMVC 提供的乱码解决方案

配置 SpringMVC 的乱码过滤（在 web.xml 中配置）

<filter>
    <filter-name>encoding</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>encoding</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

json 乱码问题 （在 Spring 配置文件中配置）
有时候 json 也会出乱码，SpringMVC 也提供了一套解决方法
配置如下：

<!-- 解决 json 乱码问题的配置 -->
<mvc:annotation-driven>
    <mvc:message-converters register-defaults="true">
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <constructor-arg value="UTF-8"/>
        </bean>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="objectMapper">
                <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                    <property name="failOnEmptyBeans" value="false"/>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

划过天际的流星，与一座移动的墓碑（IceClean）