SSM框架整合：各种配置文件的整合和详解

SSM框架整合：各种配置文件的整合和详解

前言

学习了ssm框架的整合之后，对于数量众多的配置文件，和各种不同的配置方式感到甚是头疼，接下来教给大家一个清晰明白的配置，分门别类的配置不同的xml文件。

项目目录

名称	作用
mapper	mybatis映射文件
spring	spring家族配置文件=context为父(全局性)+mybatis整合+transaction事务+mvc
config	druid配置文件
log4j	log4j.properties文件
webapp	前端页面

项目依赖

<dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>
        <!-- spring依赖  -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>5.1.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.1.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.1.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.1.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>5.1.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>5.1.6.RELEASE</version>
        </dependency>
        <!-- 苞米豆的mybatis-plus依赖，一个依赖就搞定，不要再导入spring-mybatis依赖了-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>3.3.2</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.49</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
        </dependency>
        <!--  log4j打印日志文件 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <!--  分页插件，很好用 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.10</version>
        </dependency>
        <!--  druid连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.10</version>
        </dependency>
        <!--  jackson -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.8</version>
        </dependency>

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

• 这是整个ssm项目的所有依赖，其中有些依赖不是必须的，可以适量删减。

• NOTE: 在这里重点强调，如果导入了苞米豆的mybatis-plus依赖，就不要再导入mybatis依赖和mybatis-spring依赖，因为mp对mybatis-spring其中的Configuration类进行了继承和修改，如果重新配置会报错！！！这都是博主踩过的坑啊，o(╥﹏╥)o

配置文件

web.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配置文件在哪 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/spring-context.xml</param-value>
    </context-param>
    <!-- 这个比较关键：通过Listener来加载IOC容器上下文，就是一个桥梁 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    
    <!-- 编码过滤器，此过滤器会进行：request.setCharacterEncoding("utf-8") -->
    <filter>
        <filter-name>encodingFilter</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>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <servlet>
        <servlet-name>dispatchServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--    servlet初始化的时候，加载IOC容器,如果不想配置，他会默认去WEB-INF下面去找
                （servlet-name）-servlet.xml  dispatcher-servlet.xml                                           -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring/spring-mvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>dispatchServlet</servlet-name>
        <!-- /不会匹配到.jsp, /*会匹配到.jsp -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    
</web-app>

解释一哈：

• Listener：这是创建父子容器最关键的一步，contextConfigLocation配置只是告诉让listener去哪里找这个配置文件，而listener会把这个扫描的文件做为父容器，在spring底层有一个方法，把spring-context容器设置为spring-mvc容器的父容器，具体哪个方法我忘了，有兴趣的可以问度娘。
• dispatcherServlet： 是所有请求的分配者，其中主要的方法为doDispatch主要把前端来的请求，或其他方法的结果调度给不同的方法。

druid 数据库连接池

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/openapi?useSSL=false&useUnicode=true&characterEncoding=utf8
jdbc.username=root

jdbc.password=147258

initialSize=10

maxActive=30

minIdle=5

maxWait=5000

log4j

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# MyBatis logging configuration...
log4j.logger.org.mybatis.example.BlogMapper=TRACE
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%nxxxxxxxxxx # Global logging configurationlog4j.rootLogger=DEBUG, stdout# MyBatis logging configuration...log4j.logger.org.mybatis.example.BlogMapper=TRACE# Console output...log4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%nstatus = errorname = PropertiesConfigfilters = thresholdfilter.threshold.type = ThresholdFilterfilter.threshold.level = debugappenders = consoleappender.console.type = Consoleappender.console.name = STDOUTappender.console.layout.type = PatternLayoutappender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%nrootLogger.level = debugrootLogger.appenderRefs = stdoutrootLogger.appenderRef.stdout.ref = STDOUT123456789101112131415161718p

• log4j.properties文件必须要放在resources文件夹下，不要放子文件下，因为日志默认会去.class文件的根目录下去寻找，这也是博主踩过的坑啊！！！

重点！spring配置文件整合

老大哥：全局spring-context文件

<?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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 扫描注解实例化bean，排除@Controller -->
    <context:component-scan base-package="com.xxx.master">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

    <import resource="classpath:spring/spring-context-mybatis.xml"/>
    <import resource="classpath:spring/spring-context-transaction.xml"/>

</beans>

• 除了子容器中的@controller注解，其他注解全部扫描到父容器中，在这里导入了spring-context-mybatis.xml文件和spring-context-transaction.xml文件，使条例更清晰，维护更方便。

---

二哥：spring-context-mybatis整合

<?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:mybatis-spring="http://mybatis.org/schema/mybatis-spring"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd 
       http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">

    <!-- 扫描数据库连接配置文件 -->
    <context:property-placeholder location="classpath:conf/jdbc.properties"/>

    <!-- 配置一个dataSource -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="${jdbc.driverClassName}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <!-- 配置初始化大小、最小、最大 -->
        <property name="initialSize" value="${initialSize}"/>
        <property name="minIdle" value="${minIdle}"/>
        <property name="maxActive" value="${maxActive}"/>
        <!-- 配置获取连接等待超时的时间 -->
        <property name="maxWait" value="${maxWait}"/>
        <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
        <property name="timeBetweenEvictionRunsMillis" value="60000"/>
        <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
        <property name="minEvictableIdleTimeMillis" value="300000"/>
    </bean>

    <!-- 工厂bean：生成SqlSessionFactory -->
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
        <!-- 注入连接池 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 注入dao-mapper文件信息 ,如果映射文件和dao接口同包且同名，则此配置可省略-->
        <property name="mapperLocations">
            <list>
                <value>com/xxx/master/mapper/*.xml</value>
            </list>
        </property>
        <property name="plugins">
            <array>
                <bean class="com.github.pagehelper.PageInterceptor"/>
            </array>
        </property>
        <property name="configuration">
            <bean class="com.baomidou.mybatisplus.core.MybatisConfiguration">
                <!--解决整合后log4j不自动加载的问题-->
                <property name="logImpl" value="org.apache.ibatis.logging.log4j.Log4jImpl"/>
            </bean>
        </property>
        <!-- 为 dao-mapper文件中的实体 定义缺省包路径, 如：<select id="queryAll" resultType="User"> 中 User类可以不定义包 -->
        <property name="typeAliasesPackage" value="com.xxx.master.pojo"/>
    </bean>

    <!-- 开启将接口实例化成bean的方式放入IOC，用这个扫描有前提，前提就是接口名和xml名必须保持一致，并且在同一个包下面 -->
    <mybatis-spring:scan base-package="com.xxx.master.mapper"/>
</beans>

• 这个文件把之前的mybatis文件和spring进行了整合，之前的配置全部放到了MybatisSqlSessionFactoryBean工厂配置中，在这里用的SqlSessionFactoryBean为mybatis-plus的bean工厂，如果使用了mybatis-plus的工厂bean，那么它的configuration必须为MybatisConfiguration。

• 日志在MybatisConfiguration的bean下进行配置，也可以使用mybatis的标准输出日志StdOutImpl。

---

三哥：事务处理

<?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: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/tx
        http://www.springframework.org/schema/tx/spring-tx.xsd">

    <!-- 在spring中所有的事务都是交给事务管理器来进行管理 -->
    <bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager" id="dataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>

    <!-- 开启事务注解的开关, proxy-target-class是否使用CGlib动态代理，default为false -->
    <tx:annotation-driven transaction-manager="dataSourceTransactionManager" proxy-target-class="true"/>

</beans>

• 事务推荐使用注解开发，如果service比较多可以使用配置的方式，在这里使用了注解开发。建议使用CGlib的动态代理，jdk的动态代理如果根据类对象来获得bean会出错，这也是踩过的坑啊o(╥﹏╥)o

---

儿子：mvc

<?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
       http://www.springframework.org/schema/mvc/spring-mvc.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">


    <!-- 开启mvc注解驱动 -->
    <mvc:annotation-driven/>
    <!-- 只扫描有@controller注解的类, use-default-filters是否全部注解扫描, 默认true -->
    <context:component-scan base-package="com.xxx.master.controller" use-default-filters="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>
    <!-- 解决静态资源无法访问的问题 -->
    <mvc:default-servlet-handler/>

</beans>

• 子容器只扫描@controller注解，使用default-servlet解决静态资源无法访问的问题，个人感觉这样配置是最简单方便的。

为什么要这么配？->父子容器问题

理论

• 有没有发现一个巨大的问题：为什么要把controller单独拉出来，单独进行扫描呢？一次性扫描完了，不就完事了？还这么费劲？这里一个比较重要的概念：父子容器，父亲(Spring) 儿子(mvc)。
• 在spring和spring-mvc中，分别是父容器和子容器，父容器不能访问子容器的bean，子容器可以访问父容器的bean，为什么要这样配呢，配置一个容器不是更方便呢？如果配置一个容器，很难达到分门别类的效果，而且会很冗余，而且从逻辑上来说service不应该调用controller，因此采用了父子容器的方式。

操作

• 第一种就是我们固定包扫描不全局扫描
• 第二种，我已经启用了全局扫描，这个时候可以通过include-filter和exclude-filter进行包含和剔除，就像儿子mvc中写的那样也能完成～

几点建议：

• 自动注入建议采用@resource注解，不采用@Autowired注解，因为@resource为基于name来注入，如果找不到再基于type注入，而且最重要的原因是idea不会在编写的时候出现报错。

• 分页插件建议使用pagehelper，不用mybatis-plus的分页。

• 建议将mybatis的原始配置文件放到spring中，整合成spring-context-mybatis.xml文件，减少了配置文件的数量，而且清晰明了，不会有配置文件的冗余。

• 建议使用log4j的日志，而不是StdOut的日志，因为log4j通过文件配置的方式，打印的信息更全面，更整齐。

总结

• 最重要的是各种配置文件的配置方式，以及什么配置应该放在哪个文件夹下。

• 一定要深刻理解父子容器的概念。

• 让我耿耿于怀的是log4j.properties文件不能放到conf文件夹下，让有强迫症的我很是难受啊o(╥﹏╥)o，如果有大神知道如何修改日志的默认查找路径，还请告知，不胜感激