整合SSM框架笔记

Spring5 + Spring MVC + MyBatis + Druid + MySQL + Thymeleaf

感谢尚硅谷课程：B站课程

前言

单Spring框架时，是Java工程。

Spring与Spring MVC可以共用一个配置文件，也可以不共用一个，推荐不共用一个。

Spring与Spring MVC何时加载Bean至IOC容器？

Spring ：获取Spring IOC容器时加载Bean至IOC容器。
Spring MVC ：DispatcherServlet初始化时创建IOC容器，并加载Bean至IOC容器。一般设置DispatcherServlet在Tomcat启动时便初始化：<load-on-startup>1</load-on-startup>。

Spring与Spring MVC Bean的依赖顺序

Spring MVC负责Controller层。Spring负责Service与DAO层。
由于Controller层需要依赖Service层，因此Spring的IOC容器应该在Spring MVC 的DispatcherServlet初始化之前创建。

注意：当Spring与Spring MVC 整合后，Spring的IOC容器便被设置为Spring MVC 的父容器，子容器可以访问父容器的所有Bean，但是父容器不可以访问子容器的Bean。

Java Web 三大组件

Java Web 三大组件 ：Servlet、Filter、Listener。

执行顺序：Listener>Filter>Servlet>拦截器

因此，应该把Spring 创建IOC的操作放在Listener或Filter中。这里放在Listener中，因为Listener的初始化方法只会执行一次。

监听器

参考博文 ：https://blog.csdn.net/GavinGroves/article/details/135875612

Java Web 中 Listener 按监听的域对象的类型分为三种：

监听Application域
- ServletContextListener
- ServletContextAttributeListener
监听Session域
- HttpSessionListener
- HttpSessionAttributeListener
- HttpSessionBindingListener
- HttpSessionActivationListener
监听Request域
- ServletRequestListener
- ServletRequestAttributeListener

ContextLoaderListener

Spring提供了监听器ContextLoaderListener，实现ServletContextListener接口，可监听ServletContext的状态，在web服务器的启动时，读取Spring的配置文件，创建Spring的IOC容器。

web.xml 简单示例

xml 复制代码

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    ···
    ···
    ···
    <!-- Spring 配置文件位置，如果不指定，则默认在WEB-INF下，名称固定为：applicationContext.xml -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:SpringConfig.xml</param-value>
    </context-param>
    <!--
        Spring提供了监听器ContextLoaderListener，实现ServletContextListener接口，
        可监听ServletContext的状态，在web服务器的启动时，读取Spring的配置文件，
        创建Spring的IOC容器。
    -->
    <!-- 用于在 Spring MVC IOC 容器 创建之前，创建 Spring IOC 容器 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    ···
    ···
    ···
</web-app>

整合步骤

Spring 相关部分

Druid

导入MySQL 驱动包依赖

xml 复制代码

		<!-- MYSQL Java 驱动 -->
        <!-- https://mvnrepository.com/artifact/com.mysql/mysql-connector-j -->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>8.3.0</version>
        </dependency>

导入Druid 包依赖

xml 复制代码

		<!-- 数据库连接池 -->
        <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.22</version>
        </dependency>

Mybatis

导入Mybatis-Spring 桥接包依赖

xml 复制代码

		<!--mybatis和spring的桥接包：仅起到桥接作用，还需要导入Mybatis核心包-->
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>2.1.2</version>
        </dependency>

导入Mybatis 核心包依赖

xml 复制代码

		<!-- Mybatis 核心 依赖 -->
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.16</version>
        </dependency>

Spring

导入Spring 核心包依赖

xml 复制代码

	<dependencies>
        <!-- 导入Spring核心包 Beans、Core、Context、Expression-->
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-core -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-expression</artifactId>
            <version>${spring.version}</version>
        </dependency>

导入Spring JDBC相关包依赖（内部依赖Spring-tx事务包）：为了操作数据库事务

xml 复制代码

		<!--
            Spring-JDBC：内含简单实现的JDBC操作（JDBCTemplate），及Spring事务管理器
            Spring-TX：Spring 事务
            Spring-JDBC 依赖了Spring-TX，因此无需再另外导入依赖
        -->
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>

创建并配置Spring配置文件

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:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://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/tx http://www.springframework.org/schema/tx/spring-tx.xsd">
    <context:component-scan base-package="icu.lking.demo2">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>
    <!-- 引入外部properties配置文件 -->
    <context:property-placeholder location="classpath:jdbc.properties"/>

    <!-- 注入Druid连接池 -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="minIdle" value="3"/>
        <property name="initialSize" value="3"/>
        <property name="maxActive" value="10"/>
        <property name="filters" value="stat"/>
    </bean>
    <!--
    Spring中有两种类型的Bean：普通Bean（开发者自己创建）、工厂Bean（FactoryBean）。
        主要区别
            普通Bean：在配置文件中定义的Bean类型（class中指定）就是获取bean得到的类型。
            工厂Bean：在配置文件中定义的Bean类型（class中指定）可以和获取bean类型不一致。
    -->
    <!-- 工厂Bean：获取sqlSessionFactory ,Mybatis-Spring 桥街包 提供-->
    <bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!--==========【指定配置文件方式】==========-->
        <!-- 通过指定xml配置文件的方式创建SqlSessionFactory -->
        <!--<property name="configLocation" value="classpath:mybatis-config.xml"/>-->
        <!--====================================-->
        <!-- 将Druid数据源注入 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 别名：降低冗余的全限定类名书写 -->
        <property name="typeAliasesPackage" value="icu.lking.demo2.entity"/>
        <!-- Settings -->
        <property name="configurationProperties">
            <props>
                <!-- 设置自动转换 下划线风格的字段名 为 驼峰命名格式 -->
                <prop key="mapUnderscoreToCamelCase">true</prop>
            </props>
        </property>
        <!--
            设置映射文件的路径
            若映射文件所在路径和mapper接口所在路径一致，则不需要设置
        -->
        <property name="mapperLocations" value="classpath:mapper/*.xml"/>
    </bean>
    <!--
       配置mapper接口的扫描配置
       由mybatis-spring提供，可以将指定包下所有的mapper接口创建动态代理
       并将这些动态代理作为IOC容器的bean管理
   -->
    <bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="icu.lking.demo2.mapper"/>
    </bean>
    <!-- 注入Spring事务管理器 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <!-- 将 Druid连接池的数据源对象 交由 Spring事务管理器管理 -->
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!-- 配置事务注解，指定其事务管理器, 如果是默认名字，可以忽略，但是建议写出id -->
    <tx:annotation-driven transaction-manager="transactionManager"/>
</beans>

Spring MVC 相关部分

Thymeleaf

导入 Thymeleaf + Spring 整合包依赖

xml 复制代码

	 <!-- thymeleaf与Spring5的整合包 -->
     <!-- https://mvnrepository.com/artifact/org.thymeleaf/thymeleaf-spring5 -->
     <dependency>
         <groupId>org.thymeleaf</groupId>
         <artifactId>thymeleaf-spring5</artifactId>
         <version>3.1.0.RELEASE</version>
     </dependency>

Spring MVC

导入 Spring MVC 依赖

xml 复制代码

		<!-- Spring Web 模块依赖, 包含 在服务器启动时初始化Spring IOC容器的 监听器：ContextLoaderListener -->
		<!--        <dependency>-->
		<!--            <groupId>org.springframework</groupId>-->
		<!--            <artifactId>spring-web</artifactId>-->
		<!--            <version>${spring.version}</version>-->
		<!--        </dependency>-->
        <!--
        Spring Web: 提供了基于Spring的Web服务的基础架构，包括核心的HTTP集成、Servlet过滤器、Spring HTTP Invoker等。它还支持与其他Web框架和HTTP技术（如Hessian、Burlap）的集成。

        Spring Web MVC: 是Spring MVC的一个实现，它依赖于Spring Web，并在此基础上增加了对Spring MVC的支持，包括RESTful协议、国际化等模块。

        因此，导入Spring-webmvc依赖 便无需导入Spring-web依赖，因为其已经依赖了Spring-web
        -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>

spring-webmvc和spring-web有什么区别

Spring Web: 提供了基于Spring的Web服务的基础架构，包括核心的HTTP集成、Servlet过滤器、Spring HTTP Invoker等。它还支持与其他Web框架和HTTP技术（如Hessian、Burlap）的集成。

注：Spring Web模块中包含了在服务器启动时初始化Spring IOC容器的监听器：ContextLoaderListener

Spring Web MVC : 是Spring MVC的一个实现，它依赖于Spring Web，并在此基础上增加了对Spring MVC的支持，包括RESTful协议、国际化等模块。

创建并配置Spring MVC配置文件

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:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <context:component-scan base-package="icu.lking.demo2.controller"/>
    <!-- 注入Thymeleaf视图解析器，并配置 -->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <!-- 设置该视图解析器优先级 -->
        <property name="order" value="1"/>
        <!-- 视图解析编码 -->
        <property name="characterEncoding" value="UTF-8"/>
        <!-- 模板引擎 -->
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!-- 视图前缀：请求响应的资源的路径的配置 -->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!-- 视图后缀 -->
                        <!-- 视图逻辑位置：视图前缀+视图名称+视图后缀，所以开发者使用时只需提供视图名  -->
                        <property name="suffix" value=".html"/>
                        <!-- 模板类型 -->
                        <!--
                            Thymeleaf + Spring 官方文档：https://www.thymeleaf.org/doc/tutorials/3.1/thymeleafspring.html
                        -->
                        <property name="templateMode" value="HTML"/>
                        <!-- 编码 -->
                        <property name="characterEncoding" value="UTF-8" />
                    </bean>
                </property>
            </bean>
        </property>
    </bean>
    <!-- 设置默认页视图解析器 -->
    <!--
        注意：当SpringMVC中设置任何一个view-controller时，其他控制器中的请求映射将全部失效（404），
        此时需要在SpringMVC的核心配置文件中设置开启mvc注解驱动的标签：<mvc:annotation-driven />
    -->
    <mvc:view-controller path="/" view-name="index"/>
    <!--
    Tomcat 的默认web.xml中默认配置了 DefaultServlet与JSPServlet（匹配：*.jsp与*.jspx的请求），其中DefaultServlet为默认Servlet，
    一般用来处理对静态文件的请求，匹配路径为：/，由于在本项目中配置SpringMVC的DispatcherServlet前端控制器的匹配路径也为：/
    （Spring MVC将捕获Web容器所有的请求，包括静态资源的请求），所以DefaultServlet会失效，
    所以SpringMVC需要：如果发现是静态资源的请求，就将该请求转由Web应用服务器默认的Servlet处理，如果不是静态资源的请求，才由DispatcherServlet继续处理。
    -->
    <mvc:default-servlet-handler/>
    <!--
        注意：
        1. 开启视图控制器<mvc:view-controller>后，如果不开启注解驱动，则SpringMVC的控制器匹配路径都会失效。
        2. 开启默认Servlet处理器<mvc:default-servlet-handler>后，如果不开启注解驱动，则SpringMVC的控制器匹配路径都会失效。
        3. 开启annotation-driven后，其也会自动装配消息转换器
     -->
    <mvc:annotation-driven/>
</beans>

Tomcat

配置web.xml

xml 复制代码

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <!--
    ================================【Spring MVC】=====================================
    -->
    <!-- 编码过滤器 -->
    <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>
    <!-- POST请求下 根据_method隐藏值 来转换对应请求方法的过滤器 -->
    <filter>
        <filter-name>HiddenMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- SpringMVC的配置文件位置，如果不指定，则默认位于WEB-INF下，默认名称为<servlet-name>-servlet.xml -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:SpringMVC.xml</param-value>
        </init-param>
        <!-- 当值为0或者大于0时，表示 容器在 应用启动时 就加载这个servlet；当是一个负数时或者没有指定时，则指示容器在该servlet被选择时才加载。 -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <!--
           servlet的url-pattern设置为/时， 它仅替换servlet容器的默认内置servlet，用于处理所有与其他注册的servlet不匹配的请求。直白点说就是，所有静态资源（js，css，image,html等）的访问都将交给该servlet处理，而jsp页面则交给servlet容器内置的JSP servlet处理。
           servlet的url-pattern设置为/*时，它会覆盖其他所有的servlet，包括servlet容器提供的所有servlet，如缺省servlet和JSP servlet。 无论你发出什么请求，都会在该servlet拦截处理。通常我们不会这么做。如果你只是想使用/*，那么你可以在Filter中使用，它处理完后会将url交给servlet处理。
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    <!--
        Spring提供了监听器ContextLoaderListener，实现ServletContextListener接口，
        可监听ServletContext的状态，在web服务器的启动时，读取Spring的配置文件，
        创建Spring的IOC容器。
    -->
    <!--
    ==================================【Spring】=============================================
    -->
    <!-- 用于在 Spring MVC IOC 容器 创建之前，创建 Spring IOC 容器 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <!-- Spring 配置文件位置，如果不指定，则默认在WEB-INF下，名称固定为：applicationContext.xml -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:Spring.xml</param-value>
    </context-param>
</web-app>

整合SSM框架笔记